Interface P2PService

All Superinterfaces:

org.hyperledger.besu.plugin.services.BesuService

public interface P2PService
extends org.hyperledger.besu.plugin.services.BesuService

Service giving plugins access to the peer-to-peer network, letting them query peers and connections, subscribe to connect, disconnect and message events, send messages to specific peers and control the P2P network lifecycle.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	P2PService.ConnectionListener	Consumer of network connection events.
static interface	P2PService.DisconnectionListener	Consumer of network disconnection events.
static interface	P2PService.MessageListener	Consumer of network message events.

Method Summary

Modifier and Type	Method	Description
void	disableDiscovery()	Disables P2P discovery.
void	disconnect(org.apache.tuweni.bytes.Bytes peerId)	Disconnect from a specific peer.
void	enableDiscovery()	Enables P2P discovery.
Collection<? extends Peer>	getMaintainedConnectionPeers()	Get all maintained connection peers.
Collection<? extends PeerConnection>	getPeerConnections()	Get all connected peer connections.
int	getPeerCount()	Get the number of connected peers.
boolean	isP2pEnabled()	Returns whether the P2P network is enabled.
void	send(String protocol, org.apache.tuweni.bytes.Bytes peerId, org.hyperledger.besu.datatypes.p2p.MessageData messageData)	Send a message to a specific peer.
void	subscribeConnect(P2PService.ConnectionListener networkSubscriber)	Subscribe to connection events.
void	subscribeDisconnect(P2PService.DisconnectionListener networkSubscriber)	Subscribe to disconnection events.
void	subscribeMessage(Capability capability, P2PService.MessageListener networkSubscriber)	Subscribe to messages on a specific capability.

Method Details

enableDiscovery

void enableDiscovery()

Enables P2P discovery.

disableDiscovery

void disableDiscovery()

Disables P2P discovery.

isP2pEnabled

boolean isP2pEnabled()

Returns whether the P2P network is enabled. When disabled (e.g. started with --p2p-enabled=false), peer-count checks should be skipped because no peers will ever connect.

Returns:

true if the P2P network is enabled, false otherwise

getPeerCount

int getPeerCount()

Get the number of connected peers.

Returns:

the number of connected peers

getPeerConnections

Collection<? extends PeerConnection> getPeerConnections()

Get all connected peer connections.

Returns:

list of connected peer connections

getMaintainedConnectionPeers

Collection<? extends Peer> getMaintainedConnectionPeers()

Get all maintained connection peers.

Returns:

list of maintained connection peers

subscribeConnect

void subscribeConnect(P2PService.ConnectionListener networkSubscriber)

Subscribe to connection events.

Parameters:

networkSubscriber - the subscriber to receive connection events

subscribeDisconnect

void subscribeDisconnect(P2PService.DisconnectionListener networkSubscriber)

Subscribe to disconnection events.

Parameters:

networkSubscriber - the subscriber to receive disconnection events

subscribeMessage

void subscribeMessage(Capability capability,
 P2PService.MessageListener networkSubscriber)

Subscribe to messages on a specific capability.

Parameters:

capability - the capability to subscribe to

networkSubscriber - the subscriber to receive messages for the specified capability

send

void send(String protocol,
 org.apache.tuweni.bytes.Bytes peerId,
 org.hyperledger.besu.datatypes.p2p.MessageData messageData)
   throws PeerConnection.PeerNotConnected

Send a message to a specific peer.

Parameters:

protocol - the protocol to use

peerId - the peer id to send the message to

messageData - the message data to send

Throws:

PeerConnection.PeerNotConnected - if the peer is not connected

disconnect

void disconnect(org.apache.tuweni.bytes.Bytes peerId)

Disconnect from a specific peer.

Parameters:

peerId - the peer id to disconnect from