Struct tokio::net::TcpStream
[−]
[src]
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, via the
connect
method, or by accepting a connection from a listener.
Methods
impl TcpStream
[src]
pub fn connect(addr: &SocketAddr) -> ConnectFuture
[src]
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, or it wil return an error if one
occurs.
pub fn from_std(stream: TcpStream, handle: &Handle) -> Result<TcpStream, Error>
[src]
Create a new TcpStream
from a net::TcpStream
.
This function will convert a TCP stream created by the standard library
to a TCP stream ready to be used with the provided event loop handle.
Use Handle::default()
to lazily bind to an event loop, just like connect
does.
pub fn connect_std(
stream: TcpStream,
addr: &SocketAddr,
handle: &Handle
) -> ConnectFuture
[src]
stream: TcpStream,
addr: &SocketAddr,
handle: &Handle
) -> ConnectFuture
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 mustbind
a socket before it can be connected, so if a customTcpBuilder
is used it should be bound (perhaps toINADDR_ANY
) before this method is called.
pub fn poll_read_ready(&self, mask: Ready) -> Result<Async<Ready>, Error>
[src]
Check the TCP stream's read readiness state.
The mask argument allows specifying what readiness to notify on. This
can be any value, including platform specific readiness, except
writable
. HUP is always implicitly included on platforms that support
it.
If the resource is not ready for a read then Async::NotReady
is
returned and the current task is notified once a new event is received.
The stream will remain in a read-ready state until calls to poll_read
return NotReady
.
Panics
This function panics if:
ready
includes writable.- called from outside of a task context.
pub fn poll_write_ready(&self) -> Result<Async<Ready>, Error>
[src]
Check the TCP stream's write readiness state.
This always checks for writable readiness and also checks for HUP readiness on platforms that support it.
If the resource is not ready for a write then Async::NotReady
is
returned and the current task is notified once a new event is received.
The I/O resource will remain in a write-ready state until calls to
poll_write
return NotReady
.
Panics
This function panics if:
ready
contains bits besideswritable
andhup
.- called from outside of a task context.
pub fn local_addr(&self) -> Result<SocketAddr, Error>
[src]
Returns the local address that this stream is bound to.
pub fn peer_addr(&self) -> Result<SocketAddr, Error>
[src]
Returns the remote address that this stream is connected to.
pub fn poll_peek(&mut self, buf: &mut [u8]) -> Result<Async<usize>, Error>
[src]
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.
Return
On success, returns Ok(Async::Ready(num_bytes_read))
.
If no data is available for reading, the method returns
Ok(Async::NotReady)
and arranges for the current task to receive a
notification when the socket becomes readable or is closed.
Panics
This function will panic if called from outside of a task context.
pub fn shutdown(&self, how: Shutdown) -> Result<(), Error>
[src]
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 nodelay(&self) -> Result<bool, Error>
[src]
Gets the value of the TCP_NODELAY
option on this socket.
For more information about this option, see set_nodelay
.
pub fn set_nodelay(&self, nodelay: bool) -> Result<(), Error>
[src]
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.
pub fn recv_buffer_size(&self) -> Result<usize, Error>
[src]
Gets the value of the SO_RCVBUF
option on this socket.
For more information about this option, see set_recv_buffer_size
.
pub fn set_recv_buffer_size(&self, size: usize) -> Result<(), Error>
[src]
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.
pub fn send_buffer_size(&self) -> Result<usize, Error>
[src]
Gets the value of the SO_SNDBUF
option on this socket.
For more information about this option, see set_send_buffer
.
pub fn set_send_buffer_size(&self, size: usize) -> Result<(), Error>
[src]
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.
pub fn keepalive(&self) -> Result<Option<Duration>, Error>
[src]
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
.
pub fn set_keepalive(&self, keepalive: Option<Duration>) -> Result<(), Error>
[src]
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.
pub fn ttl(&self) -> Result<u32, Error>
[src]
Gets the value of the IP_TTL
option for this socket.
For more information about this option, see set_ttl
.
pub fn set_ttl(&self, ttl: u32) -> Result<(), Error>
[src]
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.
pub fn linger(&self) -> Result<Option<Duration>, Error>
[src]
Reads the linger duration for this socket by getting the SO_LINGER
option.
For more information about this option, see set_linger
.
pub fn set_linger(&self, dur: Option<Duration>) -> Result<(), Error>
[src]
Sets the linger duration of this socket by setting the SO_LINGER
option.
This option controls the action taken when a stream has unsent messages
and the stream is closed. If SO_LINGER
is set, the system
shall block the process until it can transmit the data or until the
time expires.
If SO_LINGER
is not specified, and the stream is closed, the system
handles the call in a way that allows the process to continue as quickly
as possible.
pub fn try_clone(&self) -> Result<TcpStream, Error>
[src]
Creates a new independently owned handle to the underlying socket.
The returned TcpStream
is a reference to the same stream that this
object references. Both handles will read and write the same stream of
data, and options set on one stream will be propagated to the other
stream.
Trait Implementations
impl AsRawFd for TcpStream
[src]
impl Debug for TcpStream
[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
Formats the value using the given formatter. Read more
impl AsyncWrite for TcpStream
[src]
fn shutdown(&mut self) -> Result<Async<()>, Error>
[src]
Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down. Read more
fn write_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where
B: Buf,
[src]
B: Buf,
Write a Buf
into this value, returning how many bytes were written. Read more
fn poll_write(&mut self, buf: &[u8]) -> Result<Async<usize>, Error>
[src]
Attempt to write bytes from buf
into the object. Read more
fn poll_flush(&mut self) -> Result<Async<()>, Error>
[src]
Attempt to flush the object, ensuring that any buffered data reach their destination. Read more
impl<'a> AsyncWrite for &'a TcpStream
[src]
fn shutdown(&mut self) -> Result<Async<()>, Error>
[src]
Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down. Read more
fn write_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where
B: Buf,
[src]
B: Buf,
Write a Buf
into this value, returning how many bytes were written. Read more
fn poll_write(&mut self, buf: &[u8]) -> Result<Async<usize>, Error>
[src]
Attempt to write bytes from buf
into the object. Read more
fn poll_flush(&mut self) -> Result<Async<()>, Error>
[src]
Attempt to flush the object, ensuring that any buffered data reach their destination. Read more
impl<'a> AsyncRead for &'a TcpStream
[src]
unsafe fn prepare_uninitialized_buffer(&self, &mut [u8]) -> bool
[src]
Prepares an uninitialized buffer to be safe to pass to read
. Returns true
if the supplied buffer was zeroed out. Read more
fn read_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where
B: BufMut,
[src]
B: BufMut,
Pull some bytes from this source into the specified Buf
, returning how many bytes were read. Read more
fn poll_read(&mut self, buf: &mut [u8]) -> Result<Async<usize>, Error>
[src]
Attempt to read from the AsyncRead
into buf
. Read more
fn framed<T>(self, codec: T) -> Framed<Self, T> where
Self: AsyncWrite,
T: Decoder + Encoder,
[src]
Self: AsyncWrite,
T: Decoder + Encoder,
: Use tokio_codec::Decoder::framed instead
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. Read more
fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
Self: AsyncWrite,
[src]
Self: AsyncWrite,
Helper method for splitting this read/write object into two halves. Read more
impl AsyncRead for TcpStream
[src]
unsafe fn prepare_uninitialized_buffer(&self, &mut [u8]) -> bool
[src]
Prepares an uninitialized buffer to be safe to pass to read
. Returns true
if the supplied buffer was zeroed out. Read more
fn read_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where
B: BufMut,
[src]
B: BufMut,
Pull some bytes from this source into the specified Buf
, returning how many bytes were read. Read more
fn poll_read(&mut self, buf: &mut [u8]) -> Result<Async<usize>, Error>
[src]
Attempt to read from the AsyncRead
into buf
. Read more
fn framed<T>(self, codec: T) -> Framed<Self, T> where
Self: AsyncWrite,
T: Decoder + Encoder,
[src]
Self: AsyncWrite,
T: Decoder + Encoder,
: Use tokio_codec::Decoder::framed instead
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. Read more
fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
Self: AsyncWrite,
[src]
Self: AsyncWrite,
Helper method for splitting this read/write object into two halves. Read more
impl<'a> Write for &'a TcpStream
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize, Error>
[src]
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<(), Error>
[src]
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0[src]
Writes a formatted string into this writer, returning any error encountered. Read more
ⓘImportant traits for &'a mut Rfn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Write
. Read more
impl Write for TcpStream
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize, Error>
[src]
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<(), Error>
[src]
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0[src]
Writes a formatted string into this writer, returning any error encountered. Read more
ⓘImportant traits for &'a mut Rfn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Write
. Read more
impl Read for TcpStream
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
[src]
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
unsafe fn initializer(&self) -> Initializer
[src]
read_initializer
)Determines if this Read
er can work with buffers of uninitialized memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0[src]
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
Read all bytes until EOF in this source, appending them to buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
Read the exact number of bytes required to fill buf
. Read more
ⓘImportant traits for &'a mut Rfn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Read
. Read more
ⓘImportant traits for Bytes<R>fn bytes(self) -> Bytes<Self>
1.0.0[src]
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
ⓘImportant traits for Chars<R>fn chars(self) -> Chars<Self>
[src]
🔬 This is a nightly-only experimental API. (io
)
the semantics of a partial read/write of where errors happen is currently unclear and may change
Transforms this Read
instance to an [Iterator
] over [char
]s. Read more
ⓘImportant traits for Chain<T, U>fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
Creates an adaptor which will chain this stream with another. Read more
ⓘImportant traits for Take<T>fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
Creates an adaptor which will read at most limit
bytes from it. Read more
impl<'a> Read for &'a TcpStream
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
[src]
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
unsafe fn initializer(&self) -> Initializer
[src]
read_initializer
)Determines if this Read
er can work with buffers of uninitialized memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0[src]
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
Read all bytes until EOF in this source, appending them to buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
Read the exact number of bytes required to fill buf
. Read more
ⓘImportant traits for &'a mut Rfn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Read
. Read more
ⓘImportant traits for Bytes<R>fn bytes(self) -> Bytes<Self>
1.0.0[src]
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
ⓘImportant traits for Chars<R>fn chars(self) -> Chars<Self>
[src]
🔬 This is a nightly-only experimental API. (io
)
the semantics of a partial read/write of where errors happen is currently unclear and may change
Transforms this Read
instance to an [Iterator
] over [char
]s. Read more
ⓘImportant traits for Chain<T, U>fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
Creates an adaptor which will chain this stream with another. Read more
ⓘImportant traits for Take<T>fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
Creates an adaptor which will read at most limit
bytes from it. Read more