Struct amq_protocol_tcp::TcpStreamWrapper

pub struct TcpStreamWrapper(_);

Unsafe wrapper “Cloning” the TcpStream but not closing it on drop.

Implementations

impl TcpStreamWrapper

pub unsafe fn new(socket: &TcpStream) -> Self

Clone the TcpStream. Original one needs to last at least for the same lifetime.

Safety

The inner TcpStream won’t be closed on drop and the original one needs to live longer

Methods from Deref<Target = TcpStream>

pub fn is_connected(&self) -> bool

Check whether the stream is connected or not

pub fn try_connect(&mut self) -> Result<bool, Error>

Retry the connection. Returns:

• Ok(true) if connected
• Ok(false) if connecting
• Err(_) if an error is encountered

pub fn is_readable(&self) -> Result<(), Error>

Attempt reading from underlying stream, returning Ok(()) if the stream is readable

pub fn is_writable(&self) -> Result<(), Error>

Attempt writing to underlying stream, returning Ok(()) if the stream is writable

Methods from Deref<Target = TcpStream>

pub fn peer_addr(&self) -> Result<SocketAddr, Error>

Returns the socket address of the remote peer of this TCP connection.

pub fn local_addr(&self) -> Result<SocketAddr, Error>

Returns the socket address of the local half of this TCP connection.

pub fn shutdown(&self, how: Shutdown) -> Result<(), Error>

Shuts down the read, write, or both halves of this connection.

This function will cause all pending and future I/O on the specified portions to return immediately with an appropriate value (see the documentation of Shutdown).

pub fn set_nodelay(&self, nodelay: bool) -> Result<(), Error>

Sets the value of the TCP_NODELAY option on this socket.

If set, this option disables the Nagle algorithm. This means that segments are always sent as soon as possible, even if there is only a small amount of data. When not set, data is buffered until there is a sufficient amount to send out, thereby avoiding the frequent sending of small packets.

Notes

On Windows make sure the stream is connected before calling this method, by receiving an (writable) event. Trying to set nodelay on an unconnected TcpStream is undefined behavior.

pub fn nodelay(&self) -> Result<bool, Error>

Gets the value of the TCP_NODELAY option on this socket.

For more information about this option, see set_nodelay.

Notes

On Windows make sure the stream is connected before calling this method, by receiving an (writable) event. Trying to get nodelay on an unconnected TcpStream is undefined behavior.

pub fn set_ttl(&self, ttl: u32) -> Result<(), Error>

Sets the value for the IP_TTL option on this socket.

This value sets the time-to-live field that is used in every packet sent from this socket.

Notes

On Windows make sure the stream is connected before calling this method, by receiving an (writable) event. Trying to set ttl on an unconnected TcpStream is undefined behavior.

pub fn ttl(&self) -> Result<u32, Error>

Gets the value of the IP_TTL option for this socket.

For more information about this option, see set_ttl.

Notes

On Windows make sure the stream is connected before calling this method, by receiving an (writable) event. Trying to get ttl on an unconnected TcpStream is undefined behavior.

pub fn take_error(&self) -> Result<Option<Error>, Error>

Get the value of the SO_ERROR option on this socket.

This will retrieve the stored error in the underlying socket, clearing the field in the process. This can be useful for checking errors between calls.

pub fn peek(&self, buf: &mut [u8]) -> Result<usize, Error>

Receives data on the socket from the remote address to which it is connected, without removing that data from the queue. On success, returns the number of bytes peeked.

Successive calls return the same data. This is accomplished by passing MSG_PEEK as a flag to the underlying recv system call.

Trait Implementations

impl AsRawFd for TcpStreamWrapper

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Deref for TcpStreamWrapper

type Target = TcpStream

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for TcpStreamWrapper

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

Mutably dereferences the value.