fabric: github.com/hyperledger/fabric/gossip/comm Index | Files | Directories

package comm

import "github.com/hyperledger/fabric/gossip/comm"

Index

Package Files

ack.go comm.go comm_impl.go conn.go crypto.go demux.go msg.go

Constants

const (
    DefDialTimeout  = time.Second * 3
    DefConnTimeout  = time.Second * 2
    DefRecvBuffSize = 20
    DefSendBuffSize = 20
)

func GenerateCertificatesOrPanic Uses

func GenerateCertificatesOrPanic() tls.Certificate

GenerateCertificatesOrPanic generates a a random pair of public and private keys and return TLS certificate

type AggregatedSendResult Uses

type AggregatedSendResult []SendResult

AggregatedSendResult represents a slice of SendResults

func (AggregatedSendResult) AckCount Uses

func (ar AggregatedSendResult) AckCount() int

AckCount returns the number of successful acknowledgements

func (AggregatedSendResult) NackCount Uses

func (ar AggregatedSendResult) NackCount() int

NackCount returns the number of unsuccessful acknowledgements

func (AggregatedSendResult) String Uses

func (ar AggregatedSendResult) String() string

String returns a JSONed string representation of the AggregatedSendResult

type ChannelDeMultiplexer Uses

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

ChannelDeMultiplexer is a struct that can receive channel registrations (AddChannel) and publications (DeMultiplex) and it broadcasts the publications to registrations according to their predicate

func NewChannelDemultiplexer Uses

func NewChannelDemultiplexer() *ChannelDeMultiplexer

NewChannelDemultiplexer creates a new ChannelDeMultiplexer

func (*ChannelDeMultiplexer) AddChannel Uses

func (m *ChannelDeMultiplexer) AddChannel(predicate common.MessageAcceptor) chan interface{}

AddChannel registers a channel with a certain predicate

func (*ChannelDeMultiplexer) Close Uses

func (m *ChannelDeMultiplexer) Close()

Close closes this channel, which makes all channels registered before to close as well.

func (*ChannelDeMultiplexer) DeMultiplex Uses

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.

type Comm Uses

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

    // CloseConn closes a connection to a certain endpoint
    CloseConn(peer *RemotePeer)

    // Stop stops the module
    Stop()
}

Comm is an object that enables to communicate with other peers that also embed a CommModule.

func NewCommInstance Uses

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

type CommConfig Uses

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
}

CommConfig is the configuration required to initialize a new comm

type ConnConfig Uses

type ConnConfig struct {
    RecvBuffSize int
    SendBuffSize int
}

ConnConfig is the configuration required to initialize a new conn

type ReceivedMessageImpl Uses

type ReceivedMessageImpl struct {
    *proto.SignedGossipMessage
    // contains filtered or unexported fields
}

ReceivedMessageImpl is an implementation of ReceivedMessage

func (*ReceivedMessageImpl) Ack Uses

func (m *ReceivedMessageImpl) Ack(err error)

Ack returns to the sender an acknowledgement for the message

func (*ReceivedMessageImpl) GetConnectionInfo Uses

func (m *ReceivedMessageImpl) GetConnectionInfo() *proto.ConnectionInfo

GetConnectionInfo returns information about the remote peer that send the message

func (*ReceivedMessageImpl) GetGossipMessage Uses

func (m *ReceivedMessageImpl) GetGossipMessage() *proto.SignedGossipMessage

GetGossipMessage returns the inner GossipMessage

func (*ReceivedMessageImpl) GetSourceEnvelope Uses

func (m *ReceivedMessageImpl) GetSourceEnvelope() *proto.Envelope

GetSourceEnvelope Returns the Envelope the ReceivedMessage was constructed with

func (*ReceivedMessageImpl) Respond Uses

func (m *ReceivedMessageImpl) Respond(msg *proto.GossipMessage)

Respond sends a msg to the source that sent the ReceivedMessageImpl

type RemotePeer Uses

type RemotePeer struct {
    Endpoint string
    PKIID    common.PKIidType
}

RemotePeer defines a peer's endpoint and its PKIid

func (*RemotePeer) String Uses

func (p *RemotePeer) String() string

String converts a RemotePeer to a string

type SecurityAdvisor Uses

type SecurityAdvisor interface {
    // OrgByPeerIdentity returns the organization identity of the given PeerIdentityType
    OrgByPeerIdentity(api.PeerIdentityType) api.OrgIdentityType
}

SecurityAdvisor defines an external auxiliary object that provides security and identity related capabilities

type SendResult Uses

type SendResult struct {
    RemotePeer
    // contains filtered or unexported fields
}

SendResult defines a result of a send to a remote peer

func (SendResult) Error Uses

func (sr SendResult) Error() string

Error returns the error of the SendResult, or an empty string if an error hasn't occurred

Directories

PathSynopsis
mock

Package comm imports 27 packages (graph) and is imported by 10 packages. Updated 2019-06-18. Refresh now. Tools for package owners.