Struct jsonrpc_http_server::tokio_core::net::TcpStream

pub struct TcpStream { /* fields omitted */ }

An I/O object representing a TCP stream connected to a remote endpoint.

A TCP stream can either be created by connecting to an endpoint or by accepting a connection from a listener. Inside the stream is access to the raw underlying I/O object as well as streams for the read/write notifications on the stream itself.

Methods

impl TcpStream

fn connect(addr: &SocketAddr, handle: &Handle) -> TcpStreamNew

Create a new TCP stream connected to the specified address.

This function will create a new TCP socket and attempt to connect it to the addr provided. The returned future will be resolved once the stream has successfully connected. If an error happens during the connection or during the socket creation, that error will be returned to the future instead.

fn from_stream(stream: TcpStream, handle: &Handle) -> Result<TcpStream, Error>

Create a new TcpStream from a net::TcpStream.

This function will convert a TCP stream in the standard library to a TCP stream ready to be used with the provided event loop handle. The object returned is associated with the event loop and ready to perform I/O.

fn connect_stream(
    stream: TcpStream,
    addr: &SocketAddr,
    handle: &Handle
) -> Box<Future<Item = TcpStream, Error = Error> + 'static + Send>

Creates a new TcpStream from the pending socket inside the given std::net::TcpStream, connecting it to the address specified.

This constructor allows configuring the socket before it's actually connected, and this function will transfer ownership to the returned TcpStream if successful. An unconnected TcpStream can be created with the net2::TcpBuilder type (and also configured via that route).

The platform specific behavior of this function looks like:

• On Unix, the socket is placed into nonblocking mode and then a connect call is issued.

• On Windows, the address is stored internally and the connect operation is issued when the returned TcpStream is registered with an event loop. Note that on Windows you must bind a socket before it can be connected, so if a custom TcpBuilder is used it should be bound (perhaps to INADDR_ANY) before this method is called.

fn poll_read(&self) -> Async<()>

Test whether this socket is ready to be read or not.

If the socket is not readable then the current task is scheduled to get a notification when the socket does become readable. That is, this is only suitable for calling in a Future::poll method and will automatically handle ensuring a retry once the socket is readable again.

fn poll_write(&self) -> Async<()>

Test whether this socket is ready to be written to or not.

If the socket is not writable then the current task is scheduled to get a notification when the socket does become writable. That is, this is only suitable for calling in a Future::poll method and will automatically handle ensuring a retry once the socket is writable again.

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

Returns the local address that this stream is bound to.

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

Returns the remote address that this stream is connected to.

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).

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.

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.

fn set_recv_buffer_size(&self, size: usize) -> Result<(), Error>

Sets the value of the SO_RCVBUF option on this socket.

Changes the size of the operating system's receive buffer associated with the socket.

fn recv_buffer_size(&self) -> Result<usize, Error>

Gets the value of the SO_RCVBUF option on this socket.

For more information about this option, see set_recv_buffer_size.

fn set_send_buffer_size(&self, size: usize) -> Result<(), Error>

Sets the value of the SO_SNDBUF option on this socket.

Changes the size of the operating system's send buffer associated with the socket.

fn send_buffer_size(&self) -> Result<usize, Error>

Gets the value of the SO_SNDBUF option on this socket.

For more information about this option, see set_send_buffer.

fn set_keepalive(&self, keepalive: Option<Duration>) -> Result<(), Error>

Sets whether keepalive messages are enabled to be sent on this socket.

On Unix, this option will set the SO_KEEPALIVE as well as the TCP_KEEPALIVE or TCP_KEEPIDLE option (depending on your platform). On Windows, this will set the SIO_KEEPALIVE_VALS option.

If None is specified then keepalive messages are disabled, otherwise the duration specified will be the time to remain idle before sending a TCP keepalive probe.

Some platforms specify this value in seconds, so sub-second specifications may be omitted.

fn keepalive(&self) -> Result<Option<Duration>, Error>

Returns whether keepalive messages are enabled on this socket, and if so the duration of time between them.

For more information about this option, see set_keepalive.

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.

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.

fn set_only_v6(&self, only_v6: bool) -> Result<(), Error>

Sets the value for the IPV6_V6ONLY option on this socket.

If this is set to true then the socket is restricted to sending and receiving IPv6 packets only. In this case two IPv4 and IPv6 applications can bind the same port at the same time.

If this is set to false then the socket can be used to send and receive packets from an IPv4-mapped IPv6 address.

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

Gets the value of the IPV6_V6ONLY option for this socket.

For more information about this option, see set_only_v6.

fn set_linger(&self, dur: Option<Duration>) -> Result<(), Error>

Sets the linger duration of this socket by setting the SO_LINGER option

fn linger(&self) -> Result<Option<Duration>, Error>

reads the linger duration for this socket by getting the SO_LINGER option

Trait Implementations

impl Io for TcpStream

fn poll_read(&mut self) -> Async<()>

Deprecated

: moved to the tokio-io crate

Tests to see if this I/O object may be readable.

fn poll_write(&mut self) -> Async<()>

Deprecated

: moved to the tokio-io crate

Tests to see if this I/O object may be writable.

fn read_vec(&mut self, bufs: &mut [&mut IoVec]) -> Result<usize, Error>

Deprecated

: moved to the tokio-io crate

Read in a list of buffers all at once.

fn write_vec(&mut self, bufs: &[&IoVec]) -> Result<usize, Error>

Deprecated

: moved to the tokio-io crate

Write a list of buffers all at once.

fn framed<C>(self, codec: C) -> Framed<Self, C> where
    C: Codec, 

Deprecated

: moved to the tokio-io crate

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>)

Deprecated

: moved to the tokio-io crate

Helper method for splitting this read/write object into two halves.

impl<'a> Io for &'a TcpStream

fn poll_read(&mut self) -> Async<()>

Deprecated

: moved to the tokio-io crate

Tests to see if this I/O object may be readable.

fn poll_write(&mut self) -> Async<()>

Deprecated

: moved to the tokio-io crate

Tests to see if this I/O object may be writable.

fn read_vec(&mut self, bufs: &mut [&mut IoVec]) -> Result<usize, Error>

Deprecated

: moved to the tokio-io crate

Read in a list of buffers all at once.

fn write_vec(&mut self, bufs: &[&IoVec]) -> Result<usize, Error>

Deprecated

: moved to the tokio-io crate

Write a list of buffers all at once.

fn framed<C>(self, codec: C) -> Framed<Self, C> where
    C: Codec, 

Deprecated

: moved to the tokio-io crate

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>)

Deprecated

: moved to the tokio-io crate

Helper method for splitting this read/write object into two halves.

impl<'a> Read for &'a TcpStream

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

impl Read for TcpStream

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

impl<'a> AsyncRead for &'a TcpStream

unsafe fn prepare_uninitialized_buffer(&self, &mut [u8]) -> bool

fn read_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where
    B: BufMut, 

impl AsyncRead for TcpStream

unsafe fn prepare_uninitialized_buffer(&self, &mut [u8]) -> bool

fn read_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where
    B: BufMut, 

impl AsRawFd for TcpStream

fn as_raw_fd(&self) -> i32

impl Debug for TcpStream

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

Formats the value using the given formatter.

impl<'a> AsyncWrite for &'a TcpStream

fn shutdown(&mut self) -> Result<Async<()>, Error>

fn write_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where
    B: Buf, 

impl AsyncWrite for TcpStream

fn shutdown(&mut self) -> Result<Async<()>, Error>

fn write_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where
    B: Buf, 

impl<'a> Write for &'a TcpStream

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

fn flush(&mut self) -> Result<(), Error>

impl Write for TcpStream

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

fn flush(&mut self) -> Result<(), Error>