libp2p/go-libp2p-peerstore
1
0
Fork 0
mirror of https://github.com/libp2p/go-libp2p-peerstore.git synced 2025-03-31 14:00:06 +08:00
Code Issues Projects Releases Wiki Activity

make addrsRecord.Clean() private.

Browse Source
This commit is contained in:
Raúl Kripalani 2019-02-06 14:40:51 +00:00
parent 3966498df4
commit e16cac9f5e
2 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
pstoreds/addr_book.go
View File

@ -63,23 +63,23 @@ func (r *addrsRecord) flush(write ds.Write) (err error) {
return nil return nil
} }
// Clean is called on records to perform housekeeping. The return value indicates if the record was changed // clean is called on records to perform housekeeping. The return value indicates if the record was changed
// as a result of this call. // as a result of this call.
// //
// Clean does the following: // clean does the following:
// * sorts addresses by expiration (soonest expiring first). // * sorts addresses by expiration (soonest expiring first).
// * removes expired addresses. // * removes expired addresses.
// //
// It short-circuits optimistically when there's nothing to do. // It short-circuits optimistically when there's nothing to do.
// //
// Clean is called from several points: // clean is called from several points:
// * when accessing an entry. // * when accessing an entry.
// * when performing periodic GC. // * when performing periodic GC.
// * after an entry has been modified (e.g. addresses have been added or removed, TTLs updated, etc.) // * after an entry has been modified (e.g. addresses have been added or removed, TTLs updated, etc.)
// //
// If the return value is true, the caller can perform a flush immediately, or can schedule an async // If the return value is true, the caller can perform a flush immediately, or can schedule an async
// flush, depending on the context. // flush, depending on the context.
func (r *addrsRecord) Clean() (chgd bool) { func (r *addrsRecord) clean() (chgd bool) {
now := time.Now().Unix() now := time.Now().Unix()
if !r.dirty && len(r.Addrs) > 0 && r.Addrs[0].Expiry > now { if !r.dirty && len(r.Addrs) > 0 && r.Addrs[0].Expiry > now {
// record is not dirty, and we have no expired entries to purge. // record is not dirty, and we have no expired entries to purge.
@ -195,14 +195,14 @@ func (ab *dsAddrBook) asyncFlush(pr *addrsRecord) {
// loadRecord is a read-through fetch. It fetches a record from cache, falling back to the // loadRecord is a read-through fetch. It fetches a record from cache, falling back to the
// datastore upon a miss, and returning a newly initialized record if the peer doesn't exist. // datastore upon a miss, and returning a newly initialized record if the peer doesn't exist.
// //
// loadRecord calls Clean() on existing recordsrecord before returning it. If the record changes // loadRecord calls clean() on existing recordsrecord before returning it. If the record changes
// as a result and the update argument is true, an async flush is queued. // as a result and the update argument is true, an async flush is queued.
// //
// If the cache argument is true, the record is inserted in the cache when loaded from the datastore. // If the cache argument is true, the record is inserted in the cache when loaded from the datastore.
func (ab *dsAddrBook) loadRecord(id peer.ID, cache bool, update bool) (pr *addrsRecord, err error) { func (ab *dsAddrBook) loadRecord(id peer.ID, cache bool, update bool) (pr *addrsRecord, err error) {
if e, ok := ab.cache.Get(id); ok { if e, ok := ab.cache.Get(id); ok {
pr = e.(*addrsRecord) pr = e.(*addrsRecord)
if pr.Clean() && update { if pr.clean() && update {
ab.asyncFlush(pr) ab.asyncFlush(pr)
} }
return pr, nil return pr, nil
@ -219,7 +219,7 @@ func (ab *dsAddrBook) loadRecord(id peer.ID, cache bool, update bool) (pr *addrs
if err = pr.Unmarshal(data); err != nil { if err = pr.Unmarshal(data); err != nil {
return nil, err return nil, err
} }
if pr.Clean() && update { if pr.clean() && update {
ab.asyncFlush(pr) ab.asyncFlush(pr)
} }
default: default:
@ -307,7 +307,7 @@ func (ab *dsAddrBook) UpdateAddrs(p peer.ID, oldTTL time.Duration, newTTL time.D
pr.dirty = true pr.dirty = true
} }
if pr.Clean() { if pr.clean() {
pr.flush(ab.ds) pr.flush(ab.ds)
} }
} }
@ -407,7 +407,7 @@ Outer:
pr.Addrs = append(pr.Addrs, added...) pr.Addrs = append(pr.Addrs, added...)
pr.dirty = true pr.dirty = true
pr.Clean() pr.clean()
return pr.flush(ab.ds) return pr.flush(ab.ds)
} }
@ -440,7 +440,7 @@ func (ab *dsAddrBook) deleteAddrs(p peer.ID, addrs []ma.Multiaddr) (err error) {
pr.Addrs = pr.Addrs[:survived] pr.Addrs = pr.Addrs[:survived]
pr.dirty = true pr.dirty = true
pr.Clean() pr.clean()
return pr.flush(ab.ds) return pr.flush(ab.ds)
} }

6
pstoreds/addr_book_gc.go
View File

@ -212,7 +212,7 @@ func (gc *dsAddrBookGc) purgeLookahead() {
if e, ok := gc.ab.cache.Peek(id); ok { if e, ok := gc.ab.cache.Peek(id); ok {
cached := e.(*addrsRecord) cached := e.(*addrsRecord)
cached.Lock() cached.Lock()
if cached.Clean() { if cached.clean() {
if err = cached.flush(batch); err != nil { if err = cached.flush(batch); err != nil {
log.Warningf("failed to flush entry modified by GC for peer: &v, err: %v", id.Pretty(), err) log.Warningf("failed to flush entry modified by GC for peer: &v, err: %v", id.Pretty(), err)
} }
@ -237,7 +237,7 @@ func (gc *dsAddrBookGc) purgeLookahead() {
dropInError(gcKey, err, "unmarshalling entry") dropInError(gcKey, err, "unmarshalling entry")
continue continue
} }
if record.Clean() { if record.clean() {
err = record.flush(batch) err = record.flush(batch)
if err != nil { if err != nil {
log.Warningf("failed to flush entry modified by GC for peer: &v, err: %v", id.Pretty(), err) log.Warningf("failed to flush entry modified by GC for peer: &v, err: %v", id.Pretty(), err)
@ -282,7 +282,7 @@ func (gc *dsAddrBookGc) purgeStore() {
} }
id := record.Id.ID id := record.Id.ID
if !record.Clean() { if !record.clean() {
continue continue
} }