Struct socket_collection::TcpSock

pub struct TcpSock { /* fields omitted */ }

TCP socket which by default is uninitialized. Asynchronous TCP socket wrapper with some specific behavior to our use cases:

• TcpSock takes care of message serialization and it's boundaries - no need to mess with the byte stream.
• The maximum message length is DEFAULT_MAX_PAYLOAD_SIZE.
• Incoming/outgoing messages are buffered.
• All messages are encrypted with EncryptContext and decrypted with DecryptContext that can be changed at any time.

The socket is uninitialized by default and will result with SocketError, if used.

Methods

impl TcpSock

pub fn connect(addr: &SocketAddr) -> Res<Self>

Starts TCP connection. Returns immediately, so make sure to wait until the socket becomes writable.

pub fn connect_with_conf(addr: &SocketAddr, conf: SocketConfig) -> Res<Self>

Starts TCP connection and uses given socket configuration. Returns immediately, so make sure to wait until the socket becomes writable.

pub fn wrap(stream: TcpStream) -> Self

Wraps TcpStream and uses default socket configuration.

pub fn wrap_with_conf(stream: TcpStream, conf: SocketConfig) -> Self

Wraps TcpStream and uses given socket configuration.

pub fn set_encrypt_ctx(&mut self, enc_ctx: EncryptContext) -> Res<()>

Specify data encryption context which will determine how outgoing data is encrypted.

pub fn set_decrypt_ctx(&mut self, dec_ctx: DecryptContext) -> Res<()>

Specify data decryption context which will determine how incoming data is decrypted.

pub fn set_linger(&self, dur: Option<Duration>) -> Res<()>

Sets TCP SO_LINGER value for the underlying socket.

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

Set Time To Live value for the underlying TCP socket.

pub fn ttl(&self) -> Res<u32>

Retrieve Time To Live value.

pub fn local_addr(&self) -> Res<SocketAddr>

Returns local socket address.

pub fn peer_addr(&self) -> Res<SocketAddr>

Returns the address of the remote peer socket is connected to.

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

Retrieve last socket error, if one exists.

pub fn read<T: Serialize + DeserializeOwned>(&mut self) -> Res<Option<T>>

Read message from the socket. Call this from inside the ready handler.

Returns:

• Ok(Some(data)): data has been successfully read from the socket
• Ok(None): there is not enough data in the socket. Call read() again in the next invocation of the ready handler.
• Err(error): there was an error reading from the socket.

pub fn write<T: Serialize>(&mut self, msg: Option<(T, Priority)>) -> Res<bool>

Write a message to the socket.

Returns:

• Ok(true): the message has been successfully written.
• Ok(false): the message has been queued, but not yet fully written. will be attempted in the next write schedule.
• Err(error): there was an error while writing to the socket.

Trait Implementations

impl From<TcpSock> for Socket

fn from(sock: TcpSock) -> Socket

Performs the conversion.

impl Default for TcpSock

fn default() -> Self

Returns the "default value" for a type.

impl Debug for TcpSock

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

Formats the value using the given formatter.

impl Evented for TcpSock

fn register(     &self,     poll: &Poll,     token: Token,     interest: Ready,     opts: PollOpt ) -> Result<()>

Register self with the given Poll instance.

fn reregister(     &self,     poll: &Poll,     token: Token,     interest: Ready,     opts: PollOpt ) -> Result<()>

Re-register self with the given Poll instance.

fn deregister(&self, poll: &Poll) -> Result<()>

Deregister self from the given Poll instance