Struct sv::peer::Peer

pub struct Peer {
    pub id: ProcessUniqueId,
    pub ip: IpAddr,
    pub port: u16,
    pub network: Network,
    // some fields omitted
}

Node on the network to send and receive messages

It will setup a connection, respond to pings, and store basic properties about the connection, but any real logic to process messages will be handled outside. Network messages received will be published to an observable on the peer's receiver thread. Messages may be sent via send() from any thread. Once shutdown, the Peer may no longer be used.

Fields

id: ProcessUniqueId

Unique id for this connection

ip: IpAddr

IP address

port: u16

Port

network: Network

Network

Implementations

impl Peer

pub fn connect(
    ip: IpAddr,
    port: u16,
    network: Network,
    version: Version,
    filter: Arc<dyn PeerFilter>
) -> Arc<Peer>

Creates a new peer and begins connecting

pub fn send(&self, message: &Message) -> Result<()>

Sends a message to the peer

pub fn disconnect(&self)

Disconects and disables the peer

pub fn connected_event(&self) -> &impl Observable<PeerConnected>

Returns a Single that emits a message when connected

pub fn disconnected_event(&self) -> &impl Observable<PeerDisconnected>

Returns a Single that emits a message when connected

pub fn messages(&self) -> &impl Observable<PeerMessage>

Returns an Observable that emits network messages

pub fn connected(&self) -> bool

Returns whether the peer is connected

pub fn time_delta(&self) -> i64

Returns the time difference in seconds between our time and theirs, which is valid after connecting

pub fn minfee(&self) -> u64

Returns the minimum fee this peer accepts in sats/1000bytes

pub fn sendheaders(&self) -> bool

Returns whether this peer may announce new blocks with headers instead of inv

pub fn sendcmpct(&self) -> bool

Returns whether compact blocks are supported

pub fn version(&self) -> Result<Version>

Gets the version message received during the handshake

Trait Implementations

impl Debug for Peer

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

Formats the value using the given formatter.

impl Drop for Peer

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for Peer

impl Hash for Peer

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Peer> for Peer

fn eq(&self, other: &Peer) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.