Struct sn_comms::Comm

pub struct Comm { /* private fields */ }

Communication component of the node to interact with other nodes.

Any failed sends are tracked via CommEvent::Error, which will track issues for any nodes in the section (otherwise ignoring failed send to out of section nodes or clients).

Implementations

impl Comm

pub fn new( local_addr: SocketAddr, public_addr: Option<SocketAddr> ) -> Result<(Self, Receiver<CommEvent>)>

Creates a new instance of Comm with an endpoint and starts listening to the incoming messages from other nodes.

pub fn socket_addr(&self) -> SocketAddr

The socket address of our endpoint.

pub fn close_endpoint(&self)

Closes the endpoint.

pub fn set_comm_targets(&self, targets: BTreeSet<NodeId>)

Sets the available targets to be only those in the passed in set.

pub fn send_out_bytes(&self, node_id: NodeId, msg_id: MsgId, bytes: UsrMsgBytes)

Sends the payload on a new or existing connection.

pub fn send_and_return_response( &self, node_id: NodeId, msg_id: MsgId, bytes: UsrMsgBytes )

Sends the payload on a new bidi-stream and pushes the response onto the comm event channel.

pub fn send_and_respond_on_stream( &self, msg_id: MsgId, node_bytes: BTreeMap<NodeId, UsrMsgBytes>, expected_targets: usize, dst_stream: (Dst, SendStream) )

Sends the payload on new bidi-stream to noe and sends the response on the dst stream.

Trait Implementations

impl Clone for Comm

fn clone(&self) -> Comm

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Comm

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.