Enum internet2::transport::socket_addr::RemoteSocketAddr

#[non_exhaustive]pub enum RemoteSocketAddr {
    Ftcp(InetSocketAddr),
    Zmq(SocketAddr),
    Http(InetSocketAddr),
    Smtp(InetSocketAddr),
}

Represents a connection to a generic remote peer operating with LNP protocol

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Ftcp(InetSocketAddr)

Framed TCP socket connection, that may be served either over plain IP, IPSec or Tor v2 and v3

Zmq(SocketAddr)

Microservices connected using ZeroMQ protocol remotely. Can be used only with TCP-based ZMQ; for other types use [LocalAddr::Zmq]

Http(InetSocketAddr)

End-to-end encryption over web connection: think of this as LN protocol streamed over HTTP

Smtp(InetSocketAddr)

SMTP connection: asynchronous end-to-end-over SMTP information transfer which is useful for ultra-low bandwidth non-real-time connections like satellite networks

Implementations

impl RemoteSocketAddr

pub fn with_ip_addr(proto: FramingProtocol, ip: IpAddr, port: u16) -> Self

pub fn with_socket_addr(proto: FramingProtocol, addr: SocketAddr) -> Self

pub fn with_inet_addr(
    proto: FramingProtocol,
    addr: InetSocketAddr
) -> Result<Self, NoOnionSupportError>

pub fn framing_protocol(&self) -> FramingProtocol

Trait Implementations

impl Clone for RemoteSocketAddr

pub fn clone(&self) -> RemoteSocketAddr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for RemoteSocketAddr

impl Debug for RemoteSocketAddr

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

Formats the value using the given formatter.

impl Display for RemoteSocketAddr

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

Formats the value using the given formatter.

impl Eq for RemoteSocketAddr

impl From<RemoteNodeAddr> for RemoteSocketAddr

pub fn from(addr: RemoteNodeAddr) -> RemoteSocketAddr

Performs the conversion.

impl From<RemoteSocketAddr> for InetSocketAddr

pub fn from(rsa: RemoteSocketAddr) -> Self

Performs the conversion.

impl FromStr for RemoteSocketAddr

type Err = AddrError

The associated error which can be returned from parsing.

pub fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for RemoteSocketAddr

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for RemoteSocketAddr

pub fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<RemoteSocketAddr> for RemoteSocketAddr

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

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

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

This method tests for !=.

impl PartialOrd<RemoteSocketAddr> for RemoteSocketAddr

pub fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StrictDecode for RemoteSocketAddr

pub fn strict_decode<D: Read>(mut d: D) -> Result<Self, Error>

Decode with the given [std::io::Reader] instance; must either construct an instance or return implementation-specific error type.

pub fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using [strict_decode()]

impl StrictEncode for RemoteSocketAddr

pub fn strict_encode<E: Write>(&self, mut e: E) -> Result<usize, Error>

Encode with the given [std::io::Writer] instance; must return result with either amount of bytes encoded – or implementation-specific error type.

pub fn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using [strict_encode()] function

impl StructuralEq for RemoteSocketAddr

impl StructuralPartialEq for RemoteSocketAddr

impl TryFrom<Url> for RemoteSocketAddr

type Error = AddrError

The type returned in the event of a conversion error.

pub fn try_from(url: Url) -> Result<Self, Self::Error>

Performs the conversion.

impl UrlString for RemoteSocketAddr

pub fn url_scheme(&self) -> &'static str

Returns full URL scheme string (i.e. including : or :// parts) corresponding to the provided address

pub fn to_url_string(&self) -> String

Returns URL string representation for a given node or socket address. If you need full URL address, please use [Url::from()] instead (this will require url feature for LNP/BP Core Library).