Struct libp2p_pubsub_core::Behaviour
source · pub struct Behaviour<P: Protocol> { /* private fields */ }
Implementations§
source§impl<P: Protocol> Behaviour<P>
impl<P: Protocol> Behaviour<P>
Public API.
sourcepub fn new(config: Config, protocol: P) -> Self
pub fn new(config: Config, protocol: P) -> Self
Creates a new Behaviour
from the given configuration and protocol.
sourcepub fn connections(&self) -> &ConnectionsService
pub fn connections(&self) -> &ConnectionsService
Get a reference to the connections service.
sourcepub fn subscriptions(&self) -> &BTreeSet<TopicHash>
pub fn subscriptions(&self) -> &BTreeSet<TopicHash>
Get local node topic subscriptions.
sourcepub fn peer_subscriptions(
&self,
peer_id: &PeerId
) -> Option<&BTreeSet<TopicHash>>
pub fn peer_subscriptions( &self, peer_id: &PeerId ) -> Option<&BTreeSet<TopicHash>>
Get peer topic subscriptions.
sourcepub fn subscribe(&mut self, sub: impl Into<Subscription>) -> Result<bool>
pub fn subscribe(&mut self, sub: impl Into<Subscription>) -> Result<bool>
Subscribe to topic.
Returns Ok(true)
if the subscription was successful, Ok(false)
if we were already
subscribed to the topic.
Trait Implementations§
source§impl<P> NetworkBehaviour for Behaviour<P>where
P: Protocol + 'static,
impl<P> NetworkBehaviour for Behaviour<P>where P: Protocol + 'static,
§type ConnectionHandler = Handler<<P as Protocol>::Upgrade>
type ConnectionHandler = Handler<<P as Protocol>::Upgrade>
Handler for all the protocols the network behaviour supports.
source§fn handle_established_inbound_connection(
&mut self,
connection_id: ConnectionId,
peer_id: PeerId,
local_addr: &Multiaddr,
remote_addr: &Multiaddr
) -> Result<THandler<Self>, ConnectionDenied>
fn handle_established_inbound_connection( &mut self, connection_id: ConnectionId, peer_id: PeerId, local_addr: &Multiaddr, remote_addr: &Multiaddr ) -> Result<THandler<Self>, ConnectionDenied>
Callback that is invoked for every established inbound connection. Read more
source§fn handle_established_outbound_connection(
&mut self,
connection_id: ConnectionId,
peer_id: PeerId,
remote_addr: &Multiaddr,
_role_override: Endpoint
) -> Result<THandler<Self>, ConnectionDenied>
fn handle_established_outbound_connection( &mut self, connection_id: ConnectionId, peer_id: PeerId, remote_addr: &Multiaddr, _role_override: Endpoint ) -> Result<THandler<Self>, ConnectionDenied>
Callback that is invoked for every established outbound connection. Read more
source§fn on_swarm_event(&mut self, event: FromSwarm<'_, Self::ConnectionHandler>)
fn on_swarm_event(&mut self, event: FromSwarm<'_, Self::ConnectionHandler>)
Informs the behaviour about an event from the
Swarm
.source§fn on_connection_handler_event(
&mut self,
peer_id: PeerId,
_connection_id: ConnectionId,
event: THandlerOutEvent<Self>
)
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. Read moresource§fn poll(
&mut self,
cx: &mut Context<'_>,
_params: &mut impl PollParameters
) -> Poll<ToSwarm<Self::ToSwarm, THandlerInEvent<Self>>>
fn poll( &mut self, cx: &mut Context<'_>, _params: &mut impl PollParameters ) -> Poll<ToSwarm<Self::ToSwarm, THandlerInEvent<Self>>>
Polls for things that swarm should do. Read more
§fn handle_pending_inbound_connection(
&mut self,
_connection_id: ConnectionId,
_local_addr: &Multiaddr,
_remote_addr: &Multiaddr
) -> Result<(), ConnectionDenied>
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. Read more
Auto Trait Implementations§
impl<P> !RefUnwindSafe for Behaviour<P>
impl<P> !Send for Behaviour<P>
impl<P> !Sync for Behaviour<P>
impl<P> Unpin for Behaviour<P>where <P as Protocol>::RouterService: Unpin,
impl<P> !UnwindSafe for Behaviour<P>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more