Struct tokio_core::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 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
[src]
fn connect(addr: &SocketAddr, handle: &Handle) -> TcpStreamNew
[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. 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>
[src]
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> + Send>
[src]
stream: TcpStream,
addr: &SocketAddr,
handle: &Handle
) -> Box<Future<Item = TcpStream, Error = Error> + 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 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.
fn poll_read(&self) -> Async<()>
[src]
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<()>
[src]
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>
[src]
Returns the local address that this stream is bound to.
fn peer_addr(&self) -> Result<SocketAddr>
[src]
Returns the remote address that this stream is connected to.
fn shutdown(&self, how: Shutdown) -> Result<()>
[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
).
fn set_nodelay(&self, nodelay: bool) -> Result<()>
[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.
fn nodelay(&self) -> Result<bool>
[src]
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<()>
[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.
fn recv_buffer_size(&self) -> Result<usize>
[src]
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<()>
[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.
fn send_buffer_size(&self) -> Result<usize>
[src]
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<()>
[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.
fn keepalive(&self) -> Result<Option<Duration>>
[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
.
fn set_ttl(&self, ttl: u32) -> Result<()>
[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.
fn ttl(&self) -> Result<u32>
[src]
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<()>
[src]
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>
[src]
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<()>
[src]
Sets the linger duration of this socket by setting the SO_LINGER option
fn linger(&self) -> Result<Option<Duration>>
[src]
reads the linger duration for this socket by getting the SO_LINGER option
Trait Implementations
impl AsRawFd for TcpStream
[src]
impl Read for TcpStream
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[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, placing them into 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
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Read
. Read more
fn bytes(self) -> Bytes<Self>
1.0.0[src]
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
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
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
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 Write for TcpStream
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>
[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
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Write
. 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: BufMut>(&mut self, buf: &mut B) -> Poll<usize, Error>
[src]
Pull some bytes from this source into the specified Buf
, returning how many bytes were read. Read more
fn framed<T>(self, codec: T) -> Framed<Self, T> where
Self: AsyncWrite,
T: Decoder + Encoder,
[src]
Self: AsyncWrite,
T: Decoder + Encoder,
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 AsyncWrite for TcpStream
[src]
fn shutdown(&mut self) -> Poll<(), 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: Buf>(&mut self, buf: &mut B) -> Poll<usize, Error>
[src]
Write a Buf
into this value, returning how many bytes were written. Read more
impl<'a> Read for &'a TcpStream
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[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, placing them into 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
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Read
. Read more
fn bytes(self) -> Bytes<Self>
1.0.0[src]
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
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
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
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> Write for &'a TcpStream
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>
[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
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Write
. 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: BufMut>(&mut self, buf: &mut B) -> Poll<usize, Error>
[src]
Pull some bytes from this source into the specified Buf
, returning how many bytes were read. Read more
fn framed<T>(self, codec: T) -> Framed<Self, T> where
Self: AsyncWrite,
T: Decoder + Encoder,
[src]
Self: AsyncWrite,
T: Decoder + Encoder,
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> AsyncWrite for &'a TcpStream
[src]
fn shutdown(&mut self) -> Poll<(), 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: Buf>(&mut self, buf: &mut B) -> Poll<usize, Error>
[src]
Write a Buf
into this value, returning how many bytes were written. Read more