Struct BlueprintProtocolBehaviour

pub struct BlueprintProtocolBehaviour<K: KeyType> { /* private fields */ }

Behaviour that handles the blueprint protocol request/response and gossip

Implementations

impl<K: KeyType> BlueprintProtocolBehaviour<K>

pub fn new( local_key: &Keypair, instance_key_pair: &K::Secret, peer_manager: Arc<PeerManager<K>>, blueprint_protocol_name: &str, protocol_message_sender: Sender<ProtocolMessage>, use_address_for_handshake_verification: bool, ) -> Self

Create a new blueprint protocol behaviour

pub fn send_request( &mut self, peer: &PeerId, request: InstanceMessageRequest<K>, ) -> OutboundRequestId

Send a request to a peer

pub fn send_response( &mut self, channel: ResponseChannel<InstanceMessageResponse<K>>, response: InstanceMessageResponse<K>, ) -> Result<(), InstanceMessageResponse<K>>

Send a response through a response channel

Errors

See libp2p::request_response::Behaviour::send_response

pub fn subscribe(&mut self, topic: &str) -> Result<bool, SubscriptionError>

Subscribe to a gossip topic

Errors

See libp2p::gossipsub::SubscriptionError

pub fn unsubscribe(&mut self, topic: &str) -> bool

Unsubscribe from a gossip topic

pub fn publish( &mut self, topic: &str, data: impl Into<Vec<u8>>, ) -> Result<MessageId, PublishError>

Publish a message to a gossip topic

Errors

See libp2p::gossipsub::PublishError

pub fn send_handshake( &mut self, peer: &PeerId, ) -> Result<(), InstanceMessageResponse<K>>

Send a handshake to a peer

Errors

See Self::send_request()

pub fn verify_handshake( &self, msg: &HandshakeMessage, verification_id_key: &VerificationIdentifierKey<K>, signature: &K::Signature, ) -> Result<(), InstanceMessageResponse<K>>

Verify and handle a handshake with a peer

Errors

The handshake expired or has an invalid signature

pub fn handle_handshake( &self, msg: &HandshakeMessage, verification_id_key: &VerificationIdentifierKey<K>, signature: &K::Signature, ) -> Result<(), InstanceMessageResponse<K>>

Handle a handshake message, verifying the peer on success

Errors

See Self::verify_handshake()

pub fn handle_handshake_failure(&self, peer: &PeerId, reason: &str)

Handle a failed handshake with a peer

pub fn handle_gossipsub_event(&mut self, event: Event)

impl<K: KeyType> BlueprintProtocolBehaviour<K>

pub fn handle_request_response_event( &mut self, event: Event<InstanceMessageRequest<K>, InstanceMessageResponse<K>>, )

Trait Implementations

impl<K: KeyType> NetworkBehaviour for BlueprintProtocolBehaviour<K>

type ConnectionHandler = <DerivedBlueprintProtocolBehaviour<K> as NetworkBehaviour>::ConnectionHandler

Handler for all the protocols the network behaviour supports.

type ToSwarm = BlueprintProtocolEvent<K>

Event generated by the NetworkBehaviour and that the swarm will report back.

fn handle_established_inbound_connection( &mut self, connection_id: ConnectionId, peer: PeerId, local_addr: &Multiaddr, remote_addr: &Multiaddr, ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established inbound connection.

fn handle_established_outbound_connection( &mut self, connection_id: ConnectionId, peer: PeerId, addr: &Multiaddr, role_override: Endpoint, port_use: PortUse, ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established outbound connection.

fn handle_pending_inbound_connection( &mut self, connection_id: ConnectionId, local_addr: &Multiaddr, remote_addr: &Multiaddr, ) -> Result<(), ConnectionDenied>

Callback that is invoked for every new inbound connection.

fn handle_pending_outbound_connection( &mut self, connection_id: ConnectionId, maybe_peer: Option<PeerId>, addresses: &[Multiaddr], effective_role: Endpoint, ) -> Result<Vec<Multiaddr>, ConnectionDenied>

Callback that is invoked for every outbound connection attempt.

fn on_connection_handler_event( &mut self, peer_id: PeerId, connection_id: ConnectionId, event: THandlerOutEvent<Self>, )

Informs the behaviour about an event generated by the ConnectionHandler dedicated to the peer identified by peer_id. for the behaviour.

fn on_swarm_event(&mut self, event: FromSwarm<'_>)

Informs the behaviour about an event from the Swarm.

fn poll( &mut self, cx: &mut Context<'_>, ) -> Poll<ToSwarm<Self::ToSwarm, THandlerInEvent<Self>>>

Polls for things that swarm should do.