Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config struct {
	BindPort            int      // Port we bind to, used only for tests
	ID                  string   // ID of this instance
	BootstrapPeers      []string // Peers we connect to at startup
	PropagateIterations int      // Number of times a message is pushed to remote peers
	PropagatePeerNum    int      // Number of peers selected to push messages to

	MaxBlockCountToStore int // Maximum count of blocks we store in memory

	MaxPropagationBurstSize    int           // Max number of messages stored until it triggers a push to remote peers
	MaxPropagationBurstLatency time.Duration // Max time between consecutive message pushes

	PullInterval time.Duration // Determines frequency of pull phases
	PullPeerNum  int           // Number of peers to pull from

	SkipBlockVerification bool // Should we skip verifying block messages or not

	PublishCertPeriod        time.Duration // Time from startup certificates are included in Alive messages
	PublishStateInfoInterval time.Duration // Determines frequency of pushing state info messages to peers
	RequestStateInfoInterval time.Duration // Determines frequency of pulling state info messages from peers

	TLSCerts *common.TLSCertificates // TLS certificates of the peer

	InternalEndpoint         string        // Endpoint we publish to peers in our organization
	ExternalEndpoint         string        // Peer publishes this endpoint instead of SelfEndpoint to foreign organizations
	TimeForMembershipTracker time.Duration // Determines time for polling with membershipTracker

	DigestWaitTime   time.Duration // Time to wait before pull engine processes incoming digests
	RequestWaitTime  time.Duration // Time to wait before pull engine removes incoming nonce
	ResponseWaitTime time.Duration // Time to wait before pull engine ends pull

	DialTimeout  time.Duration // Dial timeout
	ConnTimeout  time.Duration // Connection timeout
	RecvBuffSize int           // Buffer size of received messages
	SendBuffSize int           // Buffer size of sending messages

	MsgExpirationTimeout time.Duration // Leadership message expiration timeout

	AliveTimeInterval            time.Duration // Alive check interval
	AliveExpirationTimeout       time.Duration // Alive expiration timeout
	AliveExpirationCheckInterval time.Duration // Alive expiration check interval
	ReconnectInterval            time.Duration // Reconnect interval

}

    Config is the configuration of the gossip component

    type Gossip

    type Gossip interface {
    
    	// SelfMembershipInfo returns the peer's membership information
    	SelfMembershipInfo() discovery.NetworkMember
    
    	// SelfChannelInfo returns the peer's latest StateInfo message of a given channel
    	SelfChannelInfo(common.ChainID) *proto.SignedGossipMessage
    
    	// Send sends a message to remote peers
    	Send(msg *proto.GossipMessage, peers ...*comm.RemotePeer)
    
    	// SendByCriteria sends a given message to all peers that match the given SendCriteria
    	SendByCriteria(*proto.SignedGossipMessage, SendCriteria) error
    
    	// GetPeers returns the NetworkMembers considered alive
    	Peers() []discovery.NetworkMember
    
    	// PeersOfChannel returns the NetworkMembers considered alive
    	// and also subscribed to the channel given
    	PeersOfChannel(common.ChainID) []discovery.NetworkMember
    
    	// UpdateMetadata updates the self metadata of the discovery layer
    	// the peer publishes to other peers
    	UpdateMetadata(metadata []byte)
    
    	// UpdateLedgerHeight updates the ledger height the peer
    	// publishes to other peers in the channel
    	UpdateLedgerHeight(height uint64, chainID common.ChainID)
    
    	// UpdateChaincodes updates the chaincodes the peer publishes
    	// to other peers in the channel
    	UpdateChaincodes(chaincode []*proto.Chaincode, chainID common.ChainID)
    
    	// Gossip sends a message to other peers to the network
    	Gossip(msg *proto.GossipMessage)
    
    	// PeerFilter receives a SubChannelSelectionCriteria and returns a RoutingFilter that selects
    	// only peer identities that match the given criteria, and that they published their channel participation
    	PeerFilter(channel common.ChainID, messagePredicate api.SubChannelSelectionCriteria) (filter.RoutingFilter, error)
    
    	// Accept returns a dedicated read-only channel for messages sent by other nodes that match a certain predicate.
    	// If passThrough is false, the messages are processed by the gossip layer beforehand.
    	// If passThrough is true, the gossip layer doesn't intervene and the messages
    	// can be used to send a reply back to the sender
    	Accept(acceptor common.MessageAcceptor, passThrough bool) (<-chan *proto.GossipMessage, <-chan proto.ReceivedMessage)
    
    	// JoinChan makes the Gossip instance join a channel
    	JoinChan(joinMsg api.JoinChannelMessage, chainID common.ChainID)
    
    	// LeaveChan makes the Gossip instance leave a channel.
    	// It still disseminates stateInfo message, but doesn't participate
    	// in block pulling anymore, and can't return anymore a list of peers
    	// in the channel.
    	LeaveChan(chainID common.ChainID)
    
    	// SuspectPeers makes the gossip instance validate identities of suspected peers, and close
    	// any connections to peers with identities that are found invalid
    	SuspectPeers(s api.PeerSuspector)
    
    	// IdentityInfo returns information known peer identities
    	IdentityInfo() api.PeerIdentitySet
    
    	// IsInMyOrg checks whether a network member is in this peer's org
    	IsInMyOrg(member discovery.NetworkMember) bool
    
    	// Stop stops the gossip component
    	Stop()
    }

      Gossip is the interface of the gossip component

      func NewGossipService

      func NewGossipService(conf *Config, s *grpc.Server, sa api.SecurityAdvisor,
      	mcs api.MessageCryptoService, selfIdentity api.PeerIdentityType,
      	secureDialOpts api.PeerSecureDialOpts, gossipMetrics *metrics.GossipMetrics) Gossip

        NewGossipService creates a gossip instance attached to a gRPC server

        type SendCriteria

        type SendCriteria struct {
        	Timeout    time.Duration        // Timeout defines the time to wait for acknowledgements
        	MinAck     int                  // MinAck defines the amount of peers to collect acknowledgements from
        	MaxPeers   int                  // MaxPeers defines the maximum number of peers to send the message to
        	IsEligible filter.RoutingFilter // IsEligible defines whether a specific peer is eligible of receiving the message
        	Channel    common.ChainID       // Channel specifies a channel to send this message on. \
        
        }

          SendCriteria defines how to send a specific message

          func (SendCriteria) String

          func (sc SendCriteria) String() string

            String returns a string representation of this SendCriteria

            Directories

            Path Synopsis