Documentation
¶
Overview ¶
Package p2p is a generated GoMock package.
Index ¶
- type Backoff
- type Dialer
- type MessageQueue
- type MockMessageQueue
- type MockMessageQueueMockRecorder
- type MockP2PNetwork
- func (m *MockP2PNetwork) AddRemoteNode(node model.NodeInfo) bool
- func (m *MockP2PNetwork) Broadcast(message *network.NetworkMessage)
- func (m *MockP2PNetwork) Configure(config P2PNetworkConfig) error
- func (m *MockP2PNetwork) Configured() bool
- func (m *MockP2PNetwork) EXPECT() *MockP2PNetworkMockRecorder
- func (m *MockP2PNetwork) Peers() []Peer
- func (m *MockP2PNetwork) ReceivedMessages() MessageQueue
- func (m *MockP2PNetwork) Send(peer model.PeerID, message *network.NetworkMessage) error
- func (m *MockP2PNetwork) Start() error
- func (m *MockP2PNetwork) Statistics() []stats.Statistic
- func (m *MockP2PNetwork) Stop() error
- type MockP2PNetworkMockRecorder
- func (mr *MockP2PNetworkMockRecorder) AddRemoteNode(node interface{}) *gomock.Call
- func (mr *MockP2PNetworkMockRecorder) Broadcast(message interface{}) *gomock.Call
- func (mr *MockP2PNetworkMockRecorder) Configure(config interface{}) *gomock.Call
- func (mr *MockP2PNetworkMockRecorder) Configured() *gomock.Call
- func (mr *MockP2PNetworkMockRecorder) Peers() *gomock.Call
- func (mr *MockP2PNetworkMockRecorder) ReceivedMessages() *gomock.Call
- func (mr *MockP2PNetworkMockRecorder) Send(peer, message interface{}) *gomock.Call
- func (mr *MockP2PNetworkMockRecorder) Start() *gomock.Call
- func (mr *MockP2PNetworkMockRecorder) Statistics() *gomock.Call
- func (mr *MockP2PNetworkMockRecorder) Stop() *gomock.Call
- type NumberOfPeersStatistic
- type P2PNetwork
- type P2PNetworkConfig
- type Peer
- type PeerMessage
- type PeersStatistic
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Dialer ¶
type Dialer func(ctx context.Context, target string, opts ...grpc.DialOption) (conn *grpc.ClientConn, err error)
type MessageQueue ¶
type MessageQueue interface {
Get() PeerMessage
}
type MockMessageQueue ¶
type MockMessageQueue struct {
// contains filtered or unexported fields
}
MockMessageQueue is a mock of MessageQueue interface
func NewMockMessageQueue ¶
func NewMockMessageQueue(ctrl *gomock.Controller) *MockMessageQueue
NewMockMessageQueue creates a new mock instance
func (*MockMessageQueue) EXPECT ¶
func (m *MockMessageQueue) EXPECT() *MockMessageQueueMockRecorder
EXPECT returns an object that allows the caller to indicate expected use
type MockMessageQueueMockRecorder ¶
type MockMessageQueueMockRecorder struct {
// contains filtered or unexported fields
}
MockMessageQueueMockRecorder is the mock recorder for MockMessageQueue
func (*MockMessageQueueMockRecorder) Get ¶
func (mr *MockMessageQueueMockRecorder) Get() *gomock.Call
Get indicates an expected call of Get
type MockP2PNetwork ¶
type MockP2PNetwork struct {
// contains filtered or unexported fields
}
MockP2PNetwork is a mock of P2PNetwork interface
func NewMockP2PNetwork ¶
func NewMockP2PNetwork(ctrl *gomock.Controller) *MockP2PNetwork
NewMockP2PNetwork creates a new mock instance
func (*MockP2PNetwork) AddRemoteNode ¶
func (m *MockP2PNetwork) AddRemoteNode(node model.NodeInfo) bool
AddRemoteNode mocks base method
func (*MockP2PNetwork) Broadcast ¶
func (m *MockP2PNetwork) Broadcast(message *network.NetworkMessage)
Broadcast mocks base method
func (*MockP2PNetwork) Configure ¶
func (m *MockP2PNetwork) Configure(config P2PNetworkConfig) error
Configure mocks base method
func (*MockP2PNetwork) Configured ¶
func (m *MockP2PNetwork) Configured() bool
Configured mocks base method
func (*MockP2PNetwork) EXPECT ¶
func (m *MockP2PNetwork) EXPECT() *MockP2PNetworkMockRecorder
EXPECT returns an object that allows the caller to indicate expected use
func (*MockP2PNetwork) ReceivedMessages ¶
func (m *MockP2PNetwork) ReceivedMessages() MessageQueue
ReceivedMessages mocks base method
func (*MockP2PNetwork) Send ¶
func (m *MockP2PNetwork) Send(peer model.PeerID, message *network.NetworkMessage) error
Send mocks base method
func (*MockP2PNetwork) Statistics ¶
func (m *MockP2PNetwork) Statistics() []stats.Statistic
Statistics mocks base method
type MockP2PNetworkMockRecorder ¶
type MockP2PNetworkMockRecorder struct {
// contains filtered or unexported fields
}
MockP2PNetworkMockRecorder is the mock recorder for MockP2PNetwork
func (*MockP2PNetworkMockRecorder) AddRemoteNode ¶
func (mr *MockP2PNetworkMockRecorder) AddRemoteNode(node interface{}) *gomock.Call
AddRemoteNode indicates an expected call of AddRemoteNode
func (*MockP2PNetworkMockRecorder) Broadcast ¶
func (mr *MockP2PNetworkMockRecorder) Broadcast(message interface{}) *gomock.Call
Broadcast indicates an expected call of Broadcast
func (*MockP2PNetworkMockRecorder) Configure ¶
func (mr *MockP2PNetworkMockRecorder) Configure(config interface{}) *gomock.Call
Configure indicates an expected call of Configure
func (*MockP2PNetworkMockRecorder) Configured ¶
func (mr *MockP2PNetworkMockRecorder) Configured() *gomock.Call
Configured indicates an expected call of Configured
func (*MockP2PNetworkMockRecorder) Peers ¶
func (mr *MockP2PNetworkMockRecorder) Peers() *gomock.Call
Peers indicates an expected call of Peers
func (*MockP2PNetworkMockRecorder) ReceivedMessages ¶
func (mr *MockP2PNetworkMockRecorder) ReceivedMessages() *gomock.Call
ReceivedMessages indicates an expected call of ReceivedMessages
func (*MockP2PNetworkMockRecorder) Send ¶
func (mr *MockP2PNetworkMockRecorder) Send(peer, message interface{}) *gomock.Call
Send indicates an expected call of Send
func (*MockP2PNetworkMockRecorder) Start ¶
func (mr *MockP2PNetworkMockRecorder) Start() *gomock.Call
Start indicates an expected call of Start
func (*MockP2PNetworkMockRecorder) Statistics ¶
func (mr *MockP2PNetworkMockRecorder) Statistics() *gomock.Call
Statistics indicates an expected call of Statistics
func (*MockP2PNetworkMockRecorder) Stop ¶
func (mr *MockP2PNetworkMockRecorder) Stop() *gomock.Call
Stop indicates an expected call of Stop
type NumberOfPeersStatistic ¶
type NumberOfPeersStatistic struct {
NumberOfPeers int
}
func (NumberOfPeersStatistic) Name ¶
func (n NumberOfPeersStatistic) Name() string
func (NumberOfPeersStatistic) String ¶
func (n NumberOfPeersStatistic) String() string
type P2PNetwork ¶
type P2PNetwork interface {
stats.StatsProvider
// Configure configures the P2PNetwork. Must be called before Start().
Configure(config P2PNetworkConfig) error
// Configured returns whether the system is configured or not
Configured() bool
// Start starts the P2P network on the local node.
Start() error
// Stop stops the P2P network on the local node.
Stop() error
// AddRemoteNode adds a remote node to the local node's view of the network, so it can become one of our peers.
// If we'll try to connect to the remote node, true is returned, otherwise false.
AddRemoteNode(node model.NodeInfo) bool
// ReceivedMessages returns a queue containing all messages received from our peers. It must be drained, because when its buffer is full the producer (P2PNetwork) is blocked.
ReceivedMessages() MessageQueue
// Send sends a message to a specific peer.
Send(peer model.PeerID, message *network.NetworkMessage) error
// Broadcast sends a message to all peers.
Broadcast(message *network.NetworkMessage)
// Peers returns our peers (remote nodes we're currently connected to).
Peers() []Peer
}
P2PNetwork defines the API for the P2P layer, used to connect to peers and exchange messages.
func NewP2PNetwork ¶
func NewP2PNetwork() P2PNetwork
func NewP2PNetworkWithOptions ¶
func NewP2PNetworkWithOptions(listener net.Listener, dialer Dialer) P2PNetwork
type P2PNetworkConfig ¶
type P2PNetworkConfig struct {
NodeID model.NodeID
PublicAddress string
// ListenAddress specifies the socket address the gRPC server should listen on.
// If not set, the node will not accept incoming connections (but outbound connections can still be made).
ListenAddress string
BootstrapNodes []string
ClientCert tls.Certificate
// ServerCert specifies the TLS server certificate. If set the server should open a TLS socket, otherwise plain TCP.
ServerCert tls.Certificate
TrustStore cert.TrustStore
}
type PeerMessage ¶
type PeerMessage struct {
Peer model.PeerID
Message *network.NetworkMessage
}
type PeersStatistic ¶
type PeersStatistic struct {
Peers []Peer
}
func (PeersStatistic) Name ¶
func (p PeersStatistic) Name() string
func (PeersStatistic) String ¶
func (p PeersStatistic) String() string