Struct Socket

pub struct Socket(/* private fields */);

Generic socket type

Implementations

impl Socket

pub fn pair0() -> Result<Self, ErrorCode>

Creates new version 0 pair socket

pub fn pair1() -> Result<Self, ErrorCode>

Creates new version 1 pair socket

pub fn pub0() -> Result<Self, ErrorCode>

Creates new version 0 publisher socket

pub fn sub0() -> Result<Self, ErrorCode>

Creates new version 0 subscriber socket

pub fn req0() -> Result<Self, ErrorCode>

Creates new version 0 request socket

pub fn rep0() -> Result<Self, ErrorCode>

Creates new version 0 reply socket

pub fn close(&self) -> bool

Closes socket.

Returns true if operation had effect Otherwise, if socket is already closed, returns false

pub fn listen(&self, url: String<'_>) -> Result<(), ErrorCode>

Binds socket to the specified url, starting to listen for incoming messages.

pub fn listen_with<T: Options<Listener>>( &self, url: String<'_>, options: &T, ) -> Result<(), ErrorCode>

Binds socket to the specified url, starting to listen for incoming messages.

Allows to provide custom options to initialize listener with. Mostly useful to set optional TLS config

pub fn connect(&self, url: String<'_>) -> Result<(), ErrorCode>

Connects to the remote peer via url.

pub fn connect_with<T: Options<Dialer>>( &self, url: String<'_>, options: ConnectOptions<T>, ) -> Result<(), ErrorCode>

Connects to the remote peer via url, with custom options settings

pub fn set_opt<T: Options<Self>>(&self, opts: T) -> Result<(), ErrorCode>

Sets options on the socket

It is user responsibility to use options that are valid for the protocol of use

pub fn get_prop<T: Property<Self>>(&self) -> Result<T, ErrorCode>

Get property of the socket

pub fn try_recv<'a>( &self, out: impl Into<BufMut<'a>>, ) -> Result<&'a [u8], ErrorCode>

Attempts to receive message, writing it in out buffer if it is of sufficient size, returning immediately if no message is available

If underlying protocol doesn’t support receiving messages, this shall return error always

Returns written bytes on success

Returns would block error if no message is available.

pub fn recv<'a>( &self, out: impl Into<BufMut<'a>>, ) -> Result<&'a [u8], ErrorCode>

Receives message, writing it in out buffer if it is of sufficient size, waiting forever if none is available.

If underlying protocol doesn’t support receiving messages, this shall return error always

Returns written bytes on success

pub fn recv_msg(&self) -> Result<Message, ErrorCode>

Receives pending message, waiting forever if none is available.

If underlying protocol doesn’t support receiving messages, this shall return error always

pub fn try_recv_msg(&self) -> Result<Option<Message>, ErrorCode>

Receives pending message, waiting forever if none is available.

If underlying protocol doesn’t support receiving messages, this shall return error always

Returns None if no message is available.

pub fn recv_msg_async(&self) -> Result<FutureResp, ErrorCode>

Creates new future that attempts to receive message from the socket.

pub fn send(&self, msg: Buf<'_>) -> Result<(), ErrorCode>

Encodes bytes into message and send it over the socket.

Internally message shall be encoded and sent over

pub fn send_msg(&self, msg: Message) -> Result<(), (Message, ErrorCode)>

Sends message over the socket.

If successful takes ownership of message. Otherwise returns message with error code.

pub fn send_msg_async(&self, msg: Message) -> Result<FutureReq, ErrorCode>

Sends message over the socket asynchronously.

If successful takes ownership of message. Otherwise returns message with error code.

Trait Implementations

impl Debug for Socket

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

Formats the value using the given formatter.

impl Deref for Socket

type Target = nng_socket_s

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Socket

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Drop for Socket

fn drop(&mut self)

Executes the destructor for this type.

impl Options<Socket> for MaxTtl

fn apply(&self, target: &Socket) -> Result<(), ErrorCode>

Applies options to the target, returning error if any happens

impl Options<Socket> for Reconnect

fn apply(&self, target: &Socket) -> Result<(), ErrorCode>

Applies options to the target, returning error if any happens

impl Options<Socket> for RecvBuf

fn apply(&self, target: &Socket) -> Result<(), ErrorCode>

Applies options to the target, returning error if any happens

impl Options<Socket> for RecvMaxSize

fn apply(&self, target: &Socket) -> Result<(), ErrorCode>

Applies options to the target, returning error if any happens

impl Options<Socket> for RecvTimeout

fn apply(&self, target: &Socket) -> Result<(), ErrorCode>

Applies options to the target, returning error if any happens

impl Options<Socket> for Req

fn apply(&self, target: &Socket) -> Result<(), ErrorCode>

Applies options to the target, returning error if any happens

impl Options<Socket> for SendBuf

fn apply(&self, target: &Socket) -> Result<(), ErrorCode>

Applies options to the target, returning error if any happens

impl Options<Socket> for SendTimeout

fn apply(&self, target: &Socket) -> Result<(), ErrorCode>

Applies options to the target, returning error if any happens

impl Options<Socket> for SocketName

fn apply(&self, target: &Socket) -> Result<(), ErrorCode>

Applies options to the target, returning error if any happens

impl Options<Socket> for Subscribe<'_>

fn apply(&self, target: &Socket) -> Result<(), ErrorCode>

Applies options to the target, returning error if any happens

impl Options<Socket> for Unsubscribe<'_>

fn apply(&self, target: &Socket) -> Result<(), ErrorCode>

Applies options to the target, returning error if any happens

impl Property<Socket> for PeerName

fn get(target: &Socket) -> Result<Self, ErrorCode>

Gets instance of self from the `target

impl Property<Socket> for SocketName

fn get(target: &Socket) -> Result<Self, ErrorCode>

Gets instance of self from the `target