Struct tonic::transport::server::TcpIncoming

pub struct TcpIncoming { /* private fields */ }

Binds a socket address for a Router

An incoming stream, usable with Router::serve_with_incoming, of AsyncRead + AsyncWrite that communicate with clients that connect to a socket address.

Implementations

impl TcpIncoming

pub fn new( addr: SocketAddr, nodelay: bool, keepalive: Option<Duration>, ) -> Result<Self, Box<dyn Error + Send + Sync>>

Creates an instance by binding (opening) the specified socket address to which the specified TCP ‘nodelay’ and ‘keepalive’ parameters are applied. Returns a TcpIncoming if the socket address was successfully bound.

Examples

// Find a free port
let mut port = 1322;
let tinc = loop {
   let addr = format!("127.0.0.1:{}", port).parse().unwrap();
   match TcpIncoming::new(addr, true, None) {
      Ok(t) => break t,
      Err(_) => port += 1
   }
};
Server::builder()
   .add_service(some_service)
   .serve_with_incoming(tinc);

pub fn from_listener( listener: TcpListener, nodelay: bool, keepalive: Option<Duration>, ) -> Result<Self, Box<dyn Error + Send + Sync>>

Creates a new TcpIncoming from an existing tokio::net::TcpListener.

Trait Implementations

impl Debug for TcpIncoming

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

Formats the value using the given formatter.

impl Stream for TcpIncoming

type Item = Result<AddrStream, Error>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.