Struct everscale_network::OverlayShard

pub struct OverlayShard { /* private fields */ }

P2P messages distribution layer

Implementations

impl OverlayShard

pub fn options(&self) -> &OverlayShardOptions

Configuration

pub fn metrics(&self) -> OverlayShardMetrics

Instant metrics

pub fn id(&self) -> &OverlayIdShort

Short overlay id

pub fn overlay_key(&self) -> &Arc<StoredAdnlNodeKey>

Returns local ADNL key for public overlay

pub fn add_public_peer(
    &self,
    adnl: &AdnlNode,
    ip_address: PackedSocketAddr,
    node: Node<'_>
) -> Result<Option<AdnlNodeIdShort>>

Verifies and adds new peer to the overlay. Returns Some short peer id if new peer was successfully added and None if peer already existed.

See OverlayShard::add_public_peers for multiple peers.

pub fn add_public_peers<'a, I>(
    &self,
    adnl: &AdnlNode,
    nodes: I
) -> Result<Vec<AdnlNodeIdShort>> where
    I: IntoIterator<Item = (PackedSocketAddr, Node<'a>)>, 

Verifies and adds new peers to the overlay. Returns a list of successfully added peers.

See OverlayShard::add_public_peer for single peer.

pub fn delete_public_peer(&self, peer_id: &AdnlNodeIdShort) -> bool

Removes peer from random peers and adds it to ignored peers

pub fn write_cached_peers(&self, amount: usize, dst: &PeersCache)

Fill dst with amount peers from known peers

pub fn query_prefix(&self) -> &[u8]

Serialized proto::rpc::OverlayQuery with own overlay id

pub fn message_prefix(&self) -> &[u8]

Serialized proto::overlay::Message with own overlay id

pub fn send_message(
    &self,
    adnl: &AdnlNode,
    peer_id: &AdnlNodeIdShort,
    data: &[u8]
) -> Result<()>

Sends direct ADNL message (proto::adnl::Message::Custom) to the given peer.

NOTE: Local id (OverlayShard::overlay_key) will be used as sender

pub async fn adnl_query<Q>(
    &self,
    adnl: &AdnlNode,
    peer_id: &AdnlNodeIdShort,
    query: Q,
    timeout: Option<u64>
) -> Result<Option<Vec<u8>>> where
    Q: TlWrite, 

Sends ADNL query directly to the given peer. In case of timeout returns Ok(None)

NOTE: Local id (OverlayShard::overlay_key) will be used as sender

pub async fn rldp_query(
    &self,
    rldp: &RldpNode,
    peer_id: &AdnlNodeIdShort,
    data: Vec<u8>,
    roundtrip: Option<u64>
) -> Result<(Option<Vec<u8>>, u64)>

Sends RLDP query directly to the given peer. In case of timeout returns Ok((None, max_timeout))

NOTE: Local id (OverlayShard::overlay_key) will be used as sender

pub fn broadcast(
    self: &Arc<Self>,
    adnl: &Arc<AdnlNode>,
    data: Vec<u8>,
    source: Option<&Arc<StoredAdnlNodeKey>>
) -> OutgoingBroadcastInfo

Distributes provided message to the neighbours subset.

See broadcast_target_count in OverlayShardOptions

NOTE: If data len is greater than

pub async fn wait_for_broadcast(&self) -> IncomingBroadcastInfo

Waits until the next received broadcast.

NOTE: It is important to keep polling this method because otherwise received broadcasts queue will consume all the memory.

pub fn take_new_peers(&self) -> ReceivedPeersMap

Take received peers map

pub fn sign_local_node(&self) -> NodeOwned

Returns raw signed overlay node

pub async fn get_random_peers(
    &self,
    adnl: &AdnlNode,
    peer_id: &AdnlNodeIdShort,
    existing_peers: &FxDashSet<AdnlNodeIdShort>,
    timeout: Option<u64>
) -> Result<Option<Vec<AdnlNodeIdShort>>>

Get random peers from the specified peer. Returns Ok(None) in case of timeout