protocoldiscovery

Documentation

Index

• Constants
• Variables
• func WithQuerySize(size int) discovery.Option
• func WithTimeout(timeout time.Duration) discovery.Option
• type Option
  • func WithDefaultQueryTimeout(timeout time.Duration) Option
  • func WithFindingTickerInterval(interval time.Duration) Option
  • func WithLogger(logger api.Logger) Option
  • func WithMaxQuerySize(max int) Option
• type ProtocolBasedDiscovery
  • func NewProtocolBasedDiscovery(host host.Host, opts ...Option) (*ProtocolBasedDiscovery, error)
  • func (d *ProtocolBasedDiscovery) Announce(_ context.Context, serviceName string, _ ...discovery.Option) error
  • func (d *ProtocolBasedDiscovery) FindPeers(ctx context.Context, serviceName string, opts ...discovery.Option) (<-chan ma.Multiaddr, error)

Constants

const (

	// DefaultFindingHeartbeat is the default heartbeat interval.
	DefaultFindingHeartbeat = time.Minute
	// DefaultMaxQuerySize is the default max query size when finding peers.
	DefaultMaxQuerySize = 10
	// DefaultQuerySize is the default size for finding from each others.
	DefaultQuerySize = 3
)

Variables

var (
	// ErrFinding will be returned if there is already a finding task running when calling FindPeers method.
	ErrFinding = errors.New("there is already a finding task running, try it again later")
)

Functions

func WithQuerySize

func WithQuerySize(size int) discovery.Option

WithQuerySize .

@Description:  set an int value as default query size for finding peers.
@param size:
@return discovery.Option:

func WithTimeout

func WithTimeout(timeout time.Duration) discovery.Option

WithTimeout .

@Description: set a time.Duration as timeout for finding peers.
@param timeout:
@return discovery.Option:

Types

type Option

type Option func(*ProtocolBasedDiscovery) error

Option is a function to apply properties for discovery service.

func WithDefaultQueryTimeout

func WithDefaultQueryTimeout(timeout time.Duration) Option

WithDefaultQueryTimeout set a time.Duration as default timeout for finding peers.

func WithFindingTickerInterval

func WithFindingTickerInterval(interval time.Duration) Option

WithFindingTickerInterval .

@Description: set a time.Duration as interval for finding task heartbeat.
@param interval:
@return Option:

func WithLogger

func WithLogger(logger api.Logger) Option

WithLogger set a logger.

func WithMaxQuerySize

func WithMaxQuerySize(max int) Option

WithMaxQuerySize .

@Description: set an int value as default max query size for finding peers.
@param max:
@return Option:

type ProtocolBasedDiscovery

type ProtocolBasedDiscovery struct {
	// contains filtered or unexported fields
}

ProtocolBasedDiscovery provides a discovery service based on protocols supported.

func NewProtocolBasedDiscovery

func NewProtocolBasedDiscovery(host host.Host, opts ...Option) (*ProtocolBasedDiscovery, error)

NewProtocolBasedDiscovery .

@Description:  create a new ProtocolBasedDiscovery instance.
@param host:
@param opts:
@return *ProtocolBasedDiscovery:
@return error:

func (*ProtocolBasedDiscovery) Announce

func (d *ProtocolBasedDiscovery) Announce(_ context.Context, serviceName string, _ ...discovery.Option) error

Announce .

@Description: tell other peers that I have supported a new service with name given.
@receiver d
@param _:
@param serviceName:
@param _:
@return error:

func (*ProtocolBasedDiscovery) FindPeers

func (d *ProtocolBasedDiscovery) FindPeers(ctx context.Context,
	serviceName string, opts ...discovery.Option) (<-chan ma.Multiaddr, error)

FindPeers .

@Description:

FindPeers run a loop task to find peers, and addresses of peers found will be push to result chan. If you want to quit finding task, the ctx should be canceled.

@receiver d
@param ctx:
@param serviceName:
@param opts:
@return <-chan:
@return error: