Struct grin_p2p::Peer

pub struct Peer {
    pub info: PeerInfo,
    // some fields omitted
}

Fields

info: PeerInfo

Implementations

impl Peer

pub fn accept(
    conn: TcpStream,
    capab: Capabilities,
    total_difficulty: Difficulty,
    hs: &Handshake,
    adapter: Arc<dyn NetAdapter>
) -> Result<Peer, Error>

pub fn connect(
    conn: TcpStream,
    capab: Capabilities,
    total_difficulty: Difficulty,
    self_addr: PeerAddr,
    hs: &Handshake,
    adapter: Arc<dyn NetAdapter>
) -> Result<Peer, Error>

pub fn is_denied(config: &P2PConfig, peer_addr: PeerAddr) -> bool

pub fn is_connected(&self) -> bool

Whether this peer is currently connected.

pub fn is_banned(&self) -> bool

Whether this peer has been banned.

pub fn is_stuck(&self) -> (bool, Difficulty)

Whether this peer is stuck on sync.

pub fn is_abusive(&self) -> bool

Whether the peer is considered abusive, mostly for spammy nodes

pub fn last_min_sent_bytes(&self) -> Option<u64>

Number of bytes sent to the peer

pub fn last_min_received_bytes(&self) -> Option<u64>

Number of bytes received from the peer

pub fn last_min_message_counts(&self) -> Option<(u64, u64)>

pub fn set_banned(&self)

Set this peer status to banned

pub fn send_ping(
    &self,
    total_difficulty: Difficulty,
    height: u64
) -> Result<(), Error>

Send a ping to the remote peer, providing our local difficulty and height

pub fn send_ban_reason(&self, ban_reason: ReasonForBan) -> Result<(), Error>

Send the ban reason before banning

pub fn send_compact_block(&self, b: &CompactBlock) -> Result<bool, Error>

pub fn send_header(&self, bh: &BlockHeader) -> Result<bool, Error>

pub fn send_tx_kernel_hash(&self, h: Hash) -> Result<bool, Error>

pub fn send_transaction(&self, tx: &Transaction) -> Result<bool, Error>

Sends the provided transaction to the remote peer. The request may be dropped if the remote peer is known to already have the transaction. We support broadcast of lightweight tx kernel hash so track known txs by kernel hash.

pub fn send_stem_transaction(&self, tx: &Transaction) -> Result<(), Error>

Sends the provided stem transaction to the remote peer. Note: tracking adapter is ignored for stem transactions (while under embargo).

pub fn send_header_request(&self, locator: Vec<Hash>) -> Result<(), Error>

Sends a request for block headers from the provided block locator

pub fn send_tx_request(&self, h: Hash) -> Result<(), Error>

pub fn send_block_request(&self, h: Hash, opts: Options) -> Result<(), Error>

Sends a request for a specific block by hash. Takes opts so we can track if this request was due to our node syncing or otherwise.

pub fn send_compact_block_request(&self, h: Hash) -> Result<(), Error>

Sends a request for a specific compact block by hash

pub fn send_peer_request(&self, capab: Capabilities) -> Result<(), Error>

pub fn send_txhashset_request(
    &self,
    height: u64,
    hash: Hash
) -> Result<(), Error>

pub fn stop(&self)

Stops the peer

pub fn wait(&self)

Waits until the peer's thread exit

Trait Implementations

impl Debug for Peer

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

Formats the value using the given formatter.