p2p

Documentation

Index

• Variables
• type DBDriver
• type DiscovererDatabase
  • func NewAnnounceDBWrapper(dbSvc db.JobDBService) DiscovererDatabase
• type NetworkingConfig
  • func (n *NetworkingConfig) Validate() error
• type Peer
• type Service
  • func NewService(key p2pkey.Key, cfg NetworkingConfig, peerDB DiscovererDatabase) (Service, error)

Variables

var ErrConfigNoValue = errors.New("field value is not specified")

Types

type DBDriver

type DBDriver interface {
	String() string
}

type DiscovererDatabase

type DiscovererDatabase interface {
	// StoreAnnouncement has key-value-store semantics and stores a peerID (key) and an associated serialized
	// announcement (value).
	StoreAnnouncement(ctx context.Context, peerID string, ann []byte) error

	// ReadAnnouncements returns one serialized announcement (if available) for each of the peerIDs in the form of a map
	// keyed by each announcement's corresponding peer ID.
	ReadAnnouncements(ctx context.Context, peerIDs []string) (map[string][]byte, error)
}

func NewAnnounceDBWrapper

func NewAnnounceDBWrapper(dbSvc db.JobDBService) DiscovererDatabase

type NetworkingConfig

type NetworkingConfig struct {
	DHTLookupInterval         int
	IncomingMessageBufferSize int
	OutgoingMessageBufferSize int
	NewStreamTimeout          time.Duration
	BootstrapCheckInterval    time.Duration

	TraceLogging bool

	P2PV2AnnounceAddresses []string
	P2PV2Bootstrappers     []ocrcommontypes.BootstrapperLocator
	P2PV2DeltaDial         time.Duration
	P2PV2DeltaReconcile    time.Duration
	P2PV2ListenAddresses   []string
}

func (*NetworkingConfig) Validate

func (n *NetworkingConfig) Validate() error

type Peer

type Peer interface {
	ocrtypes.BootstrapperFactory
	ocrtypes.BinaryNetworkEndpointFactory
	Close() error
}

type Service

type Service interface {
	Peer() Peer
	IsStarted() bool
	Start() error
	Close() error
}

func NewService

func NewService(
	key p2pkey.Key,
	cfg NetworkingConfig,
	peerDB DiscovererDatabase,
) (Service, error)