const (
DefDialTimeout = time.Second * 3
DefConnTimeout = time.Second * 2
DefRecvBuffSize = 20
DefSendBuffSize = 20
)
func GenerateCertificatesOrPanic() tls.Certificate
GenerateCertificatesOrPanic generates a a random pair of public and private keys and return TLS certificate
AggregatedSendResult represents a slice of SendResults
type AggregatedSendResult []SendResult
func (ar AggregatedSendResult) AckCount() int
AckCount returns the number of successful acknowledgements
func (ar AggregatedSendResult) NackCount() int
NackCount returns the number of unsuccessful acknowledgements
func (ar AggregatedSendResult) String() string
String returns a JSONed string representation of the AggregatedSendResult
ChannelDeMultiplexer is a struct that can receive channel registrations (AddChannel) and publications (DeMultiplex) and it broadcasts the publications to registrations according to their predicate
type ChannelDeMultiplexer struct {
// contains filtered or unexported fields
}
func NewChannelDemultiplexer() *ChannelDeMultiplexer
NewChannelDemultiplexer creates a new ChannelDeMultiplexer
func (m *ChannelDeMultiplexer) AddChannel(predicate common.MessageAcceptor) chan interface{}
AddChannel registers a channel with a certain predicate
func (m *ChannelDeMultiplexer) Close()
Close closes this channel, which makes all channels registered before to close as well.
func (m *ChannelDeMultiplexer) DeMultiplex(msg interface{})
DeMultiplex broadcasts the message to all channels that were returned by AddChannel calls and that hold the respected predicates.
Comm is an object that enables to communicate with other peers that also embed a CommModule.
type Comm interface {
// GetPKIid returns this instance's PKI id
GetPKIid() common.PKIidType
// Send sends a message to remote peers
Send(msg *proto.SignedGossipMessage, peers ...*RemotePeer)
// SendWithAck sends a message to remote peers, waiting for acknowledgement from minAck of them, or until a certain timeout expires
SendWithAck(msg *proto.SignedGossipMessage, timeout time.Duration, minAck int, peers ...*RemotePeer) AggregatedSendResult
// Probe probes a remote node and returns nil if its responsive,
// and an error if it's not.
Probe(peer *RemotePeer) error
// Handshake authenticates a remote peer and returns
// (its identity, nil) on success and (nil, error)
Handshake(peer *RemotePeer) (api.PeerIdentityType, error)
// Accept returns a dedicated read-only channel for messages sent by other nodes that match a certain predicate.
// Each message from the channel can be used to send a reply back to the sender
Accept(common.MessageAcceptor) <-chan proto.ReceivedMessage
// PresumedDead returns a read-only channel for node endpoints that are suspected to be offline
PresumedDead() <-chan common.PKIidType
// IdentitySwitch returns a read-only channel about identity change events
IdentitySwitch() <-chan common.PKIidType
// CloseConn closes a connection to a certain endpoint
CloseConn(peer *RemotePeer)
// Stop stops the module
Stop()
}
func NewCommInstance(s *grpc.Server, certs *common.TLSCertificates, idStore identity.Mapper, peerIdentity api.PeerIdentityType, secureDialOpts api.PeerSecureDialOpts, sa api.SecurityAdvisor, commMetrics *metrics.CommMetrics, config CommConfig, dialOpts ...grpc.DialOption) (Comm, error)
NewCommInstance creates a new comm instance that binds itself to the given gRPC server
CommConfig is the configuration required to initialize a new comm
type CommConfig struct {
DialTimeout time.Duration // Dial timeout
ConnTimeout time.Duration // Connection timeout
RecvBuffSize int // Buffer size of received messages
SendBuffSize int // Buffer size of sending messages
}
ConnConfig is the configuration required to initialize a new conn
type ConnConfig struct {
RecvBuffSize int
SendBuffSize int
}
ReceivedMessageImpl is an implementation of ReceivedMessage
type ReceivedMessageImpl struct {
*proto.SignedGossipMessage
// contains filtered or unexported fields
}
func (m *ReceivedMessageImpl) Ack(err error)
Ack returns to the sender an acknowledgement for the message
func (m *ReceivedMessageImpl) GetConnectionInfo() *proto.ConnectionInfo
GetConnectionInfo returns information about the remote peer that send the message
func (m *ReceivedMessageImpl) GetGossipMessage() *proto.SignedGossipMessage
GetGossipMessage returns the inner GossipMessage
func (m *ReceivedMessageImpl) GetSourceEnvelope() *proto.Envelope
GetSourceEnvelope Returns the Envelope the ReceivedMessage was constructed with
func (m *ReceivedMessageImpl) Respond(msg *proto.GossipMessage)
Respond sends a msg to the source that sent the ReceivedMessageImpl
RemotePeer defines a peer's endpoint and its PKIid
type RemotePeer struct {
Endpoint string
PKIID common.PKIidType
}
func (p *RemotePeer) String() string
String converts a RemotePeer to a string
SecurityAdvisor defines an external auxiliary object that provides security and identity related capabilities
type SecurityAdvisor interface {
// OrgByPeerIdentity returns the organization identity of the given PeerIdentityType
OrgByPeerIdentity(api.PeerIdentityType) api.OrgIdentityType
}
SendResult defines a result of a send to a remote peer
type SendResult struct {
RemotePeer
// contains filtered or unexported fields
}
func (sr SendResult) Error() string
Error returns the error of the SendResult, or an empty string if an error hasn't occurred