package timecache

Import Path
	github.com/libp2p/go-libp2p-pubsub/timecache (on go.dev)

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files

	    first_seen_cache.go
	    last_seen_cache.go
	    time_cache.go
	    util.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type FirstSeenCache (struct)
		FirstSeenCache is a time cache that only marks the expiry of a message when first added.

		Methods (total 3)
			(*FirstSeenCache) Add(s string) bool
			(*FirstSeenCache) Done()
			(*FirstSeenCache) Has(s string) bool
		Implements (at least one exported)
			*FirstSeenCache : TimeCache

	 type LastSeenCache (struct)
		LastSeenCache is a time cache that extends the expiry of a seen message when added
		or checked for presence with Has..

		Methods (total 3)
			(*LastSeenCache) Add(s string) bool
			(*LastSeenCache) Done()
			(*LastSeenCache) Has(s string) bool
		Implements (at least one exported)
			*LastSeenCache : TimeCache

	 type Strategy uint8 (basic type)
		Stategy is the TimeCache expiration strategy to use.

		As Inputs Of (at least 2)
			func NewTimeCacheWithStrategy(strategy Strategy, ttl time.Duration) TimeCache
			func github.com/libp2p/go-libp2p-pubsub.WithSeenMessagesStrategy(strategy Strategy) pubsub.Option
		As Types Of (total 3)
			const Strategy_FirstSeen
			const Strategy_LastSeen
			  var github.com/libp2p/go-libp2p-pubsub.TimeCacheStrategy

	 type TimeCache (interface)
		TimeCache is a cahe of recently seen messages (by id).

		Methods (total 3)
			( TimeCache) Add(string) bool
				Add adds an id into the cache, if it is not already there.
				Returns true if the id was newly added to the cache.
				Depending on the implementation strategy, it may or may not update the expiry of
				an existing entry.

			( TimeCache) Done()
				Done signals that the user is done with this cache, which it may stop background threads
				and relinquish resources.

			( TimeCache) Has(string) bool
				Has checks the cache for the presence of an id.
				Depending on the implementation strategy, it may or may not update the expiry of
				an existing entry.

		Implemented By (at least 2)
			*FirstSeenCache
			*LastSeenCache
		As Outputs Of (at least 2)
			func NewTimeCache(ttl time.Duration) TimeCache
			func NewTimeCacheWithStrategy(strategy Strategy, ttl time.Duration) TimeCache


Package-Level Functions (total 2)

	 func NewTimeCache(ttl time.Duration) TimeCache
		NewTimeCache defaults to the original ("first seen") cache implementation

	 func NewTimeCacheWithStrategy(strategy Strategy, ttl time.Duration) TimeCache
Package-Level Constants (total 2)

	const Strategy_FirstSeen Strategy = 0
		Strategy_FirstSeen expires an entry from the time it was added.

	const Strategy_LastSeen Strategy = 1
		Stategy_LastSeen expires an entry from the last time it was touched by an Add or Has.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.