discovery

Documentation

Index

• Constants
• func HasExternalEndpoint(member NetworkMember) bool
• func SetMaxConnAttempts(attempts int)
• type CommService
• type CryptoService
• type DisclosurePolicy
• type Discovery
  • func NewDiscoveryService(self NetworkMember, comm CommService, crypt CryptoService, ...) Discovery
• type DiscoveryConfig
• type EnvelopeFilter
• type Members
  • func (members Members) ByID() map[string]NetworkMember
  • func (members Members) Filter(filter func(member NetworkMember) bool) Members
  • func (members Members) Intersect(otherMembers Members) Members
  • func (members Members) Map(f func(member NetworkMember) NetworkMember) Members
• type NetworkMember
  • func (n NetworkMember) PreferredEndpoint() string
  • func (n NetworkMember) String() string
• type PeerIdentification
• type Sieve

Constants

const DefAliveExpirationCheckInterval = DefAliveExpirationTimeout / 10

const DefAliveExpirationTimeout = 5 * DefAliveTimeInterval

const DefAliveTimeInterval = 5 * time.Second

const DefReconnectInterval = DefAliveExpirationTimeout

Functions

func HasExternalEndpoint

func HasExternalEndpoint(member NetworkMember) bool

func SetMaxConnAttempts

func SetMaxConnAttempts(attempts int)

Types

type CommService

type CommService interface {
	Gossip(msg *protoext.SignedGossipMessage)

	SendToPeer(peer *NetworkMember, msg *protoext.SignedGossipMessage)

	Ping(peer *NetworkMember) bool

	Accept() <-chan protoext.ReceivedMessage

	PresumedDead() <-chan common.PKIidType

	CloseConn(peer *NetworkMember)

	Forward(msg protoext.ReceivedMessage)
}

type CryptoService

type CryptoService interface {
	ValidateAliveMsg(message *protoext.SignedGossipMessage) bool

	SignMessage(m *proto.GossipMessage, internalEndpoint string) *proto.Envelope
}

type DisclosurePolicy

type DisclosurePolicy func(remotePeer *NetworkMember) (Sieve, EnvelopeFilter)

type Discovery

type Discovery interface {
	Lookup(PKIID common.PKIidType) *NetworkMember

	Self() NetworkMember

	UpdateMetadata([]byte)

	UpdateEndpoint(string)

	Stop()

	GetMembership() []NetworkMember

	InitiateSync(peerNum int)

	Connect(member NetworkMember, id identifier)
}

func NewDiscoveryService

func NewDiscoveryService(self NetworkMember, comm CommService, crypt CryptoService, disPol DisclosurePolicy,
	config DiscoveryConfig) Discovery

type DiscoveryConfig

type DiscoveryConfig struct {
	AliveTimeInterval            time.Duration
	AliveExpirationTimeout       time.Duration
	AliveExpirationCheckInterval time.Duration
	ReconnectInterval            time.Duration
	BootstrapPeers               []string
}

type EnvelopeFilter

type EnvelopeFilter func(message *protoext.SignedGossipMessage) *proto.Envelope

type Members

type Members []NetworkMember

func (Members) ByID

func (members Members) ByID() map[string]NetworkMember

func (Members) Filter

func (members Members) Filter(filter func(member NetworkMember) bool) Members

func (Members) Intersect

func (members Members) Intersect(otherMembers Members) Members

func (Members) Map

func (members Members) Map(f func(member NetworkMember) NetworkMember) Members

type NetworkMember

type NetworkMember struct {
	Endpoint         string
	Metadata         []byte
	PKIid            common.PKIidType
	InternalEndpoint string
	Properties       *proto.Properties
	*proto.Envelope
}

func (NetworkMember) PreferredEndpoint

func (n NetworkMember) PreferredEndpoint() string

func (NetworkMember) String

func (n NetworkMember) String() string

type PeerIdentification

type PeerIdentification struct {
	ID      common.PKIidType
	SelfOrg bool
}

type Sieve

type Sieve func(message *protoext.SignedGossipMessage) bool