Struct nng::Dialer

pub struct Dialer { /* fields omitted */ }

An active outgoing connection.

A Dialer is responsible for establishing and maintaining outgoing connections. If a connection is ever broken, or fails, the Dialer object automatically attempts to reconnect.

Directly creating a Dialer is only necessary when one wishes to configure the connection before opening it or if one wants to close the outgoing connection without closing the socket. Otherwise, Socket::dial can be used.

Note that the client/server relationship described by a dialer/listener is completely orthogonal to any similar relationship in the protocols. For example, a rep socket may use a dialer to connect to a listener on a req socket. This orthogonality can lead to innovative solutions to otherwise challenging communications problems.

See the NNG documentation for more information.

Implementations

impl Dialer

pub fn new(socket: &Socket, url: &str, nonblocking: bool) -> Result<Self>

Creates a new dialer object associated with the given socket.

Note that this will immediately start the dialer so no configuration will be possible. Use DialerBuilder to change the dialer options before starting it.

Errors

• AddressInvalid: An invalid url was specified.
• Closed: The socket is not open.
• ConnectionRefused: The remote peer refused the connection.
• ConnectionReset: The remote peer reset the connection.
• DestUnreachable: The remote address is not reachable.
• OutOfMemory: Insufficient memory is available.
• PeerAuth: Authentication or authorization failure.
• Protocol: A protocol error occurred.

pub fn close(self)

Closes the dialer.

This also closes any Pipe objects that have been created by the dialer. Once this function returns, the dialer has been closed and all of its resources have been deallocated. Therefore, any attempt to utilize the dialer (with this or any other handle) will result in an error.

Dialers are implicitly closed when the socket they are associated with is closed. Dialers are not closed when all handles are dropped.

Trait Implementations

impl Clone for Dialer

fn clone(&self) -> Dialer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Dialer

impl Debug for Dialer

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

Formats the value using the given formatter.

impl Eq for Dialer

impl GetOpt<KeepAlive> for Dialer

impl GetOpt<LocalAddr> for Dialer

impl GetOpt<MaxTtl> for Dialer

impl GetOpt<NoDelay> for Dialer

impl GetOpt<Protocol> for Dialer

impl GetOpt<Raw> for Dialer

impl GetOpt<ReconnectMaxTime> for Dialer

impl GetOpt<ReconnectMinTime> for Dialer

impl GetOpt<RecvBufferSize> for Dialer

impl GetOpt<RecvMaxSize> for Dialer

impl GetOpt<RecvTimeout> for Dialer

impl GetOpt<ResendTime> for Dialer

impl GetOpt<SendBufferSize> for Dialer

impl GetOpt<SendTimeout> for Dialer

impl GetOpt<SocketName> for Dialer

impl GetOpt<SurveyTime> for Dialer

impl GetOpt<Url> for Dialer

impl Hash for Dialer

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 Dialer

fn cmp(&self, other: &Dialer) -> 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<Dialer> for Dialer

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

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

#[must_use]

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

This method tests for !=.

impl PartialOrd<Dialer> for Dialer

fn partial_cmp(&self, other: &Dialer) -> 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.