Enum libp2p_core::connection::ConnectedPoint

pub enum ConnectedPoint {
    Dialer {
        address: Multiaddr,
        role_override: Endpoint,
        port_use: PortUse,
    },
    Listener {
        local_addr: Multiaddr,
        send_back_addr: Multiaddr,
    },
}

The endpoint roles associated with an established peer-to-peer connection.

Variants

Dialer

We dialed the node.

Fields

address: Multiaddr

Multiaddress that was successfully dialed.

role_override: Endpoint

Whether the role of the local node on the connection should be overridden. I.e. whether the local node should act as a listener on the outgoing connection.

This option is needed for NAT and firewall hole punching.

• Endpoint::Dialer represents the default non-overriding option.

• Endpoint::Listener represents the overriding option. Realization depends on the transport protocol. E.g. in the case of TCP, both endpoints dial each other, resulting in a simultaneous open TCP connection. On this new connection both endpoints assume to be the dialer of the connection. This is problematic during the connection upgrade process where an upgrade assumes one side to be the listener. With the help of this option, both peers can negotiate the roles (dialer and listener) for the new connection ahead of time, through some external channel, e.g. the DCUtR protocol, and thus have one peer dial the other and upgrade the connection as a dialer and one peer dial the other and upgrade the connection as a listener overriding its role.

port_use: PortUse

Whether the port for the outgoing connection was reused from a listener or a new port was allocated. This is useful for address translation.

The port use is implemented on a best-effort basis. It is not guaranteed that PortUse::Reuse actually reused a port. A good example is the case where there is no listener available to reuse a port from.

Listener

We received the node.

Fields

local_addr: Multiaddr

Local connection address.

send_back_addr: Multiaddr

Address used to send back data to the remote.

Implementations

impl ConnectedPoint

pub fn to_endpoint(&self) -> Endpoint

Turns the ConnectedPoint into the corresponding Endpoint.

pub fn is_dialer(&self) -> bool

Returns true if we are Dialer.

pub fn is_listener(&self) -> bool

Returns true if we are Listener.

pub fn is_relayed(&self) -> bool

Returns true if the connection is relayed.

pub fn get_remote_address(&self) -> &Multiaddr

Returns the address of the remote stored in this struct.

For Dialer, this returns address. For Listener, this returns send_back_addr.

Note that the remote node might not be listening on this address and hence the address might not be usable to establish new connections.

pub fn set_remote_address(&mut self, new_address: Multiaddr)

Modifies the address of the remote stored in this struct.

For Dialer, this modifies address. For Listener, this modifies send_back_addr.

Trait Implementations

impl Clone for ConnectedPoint

fn clone(&self) -> ConnectedPoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectedPoint

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

Formats the value using the given formatter.

impl From<&ConnectedPoint> for Endpoint

fn from(endpoint: &ConnectedPoint) -> Endpoint

Converts to this type from the input type.

impl From<ConnectedPoint> for Endpoint

fn from(endpoint: ConnectedPoint) -> Endpoint

Converts to this type from the input type.

impl Hash for ConnectedPoint

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ConnectedPoint

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ConnectedPoint

impl StructuralPartialEq for ConnectedPoint