uvco::TcpStream Class Reference

#include <tcp_stream.h>

Inheritance diagram for uvco::TcpStream:

Collaboration diagram for uvco::TcpStream:

Public Member Functions
	TcpStream (std::unique_ptr< uv_tcp_t > tcp)
	TcpStream (const TcpStream &)=delete
	TcpStream (TcpStream &&)=default
TcpStream &	operator= (const TcpStream &)=delete
TcpStream &	operator= (TcpStream &&)=default
	~TcpStream () override=default
AddressHandle	getPeerName () const
	Return address of peer.
AddressHandle	getSockName () const
	Return bound address of socket.
Promise< void >	closeReset ()
void	keepAlive (bool enable, unsigned int delay=10)
	Set keep-alive delay in seconds.
void	noDelay (bool enable)
	Enable Nagle's algorithm.
Public Member Functions inherited from uvco::StreamBase
template<typename Stream >
	StreamBase (std::unique_ptr< Stream > stream)
	StreamBase (const StreamBase &)=delete
	StreamBase (StreamBase &&)=default
StreamBase &	operator= (const StreamBase &)=delete
StreamBase &	operator= (StreamBase &&)=default
virtual	~StreamBase ()
Promise< std::optional< std::string > >	read (size_t maxSize=defaultMaxReadSize)
Promise< size_t >	read (std::span< char > buffer)
Promise< size_t >	write (std::string buf)
Promise< void >	shutdown ()
Promise< void >	close ()
const uv_stream_t *	underlying () const
	Return the underlying UV stream object.

Additional Inherited Members
Static Public Attributes inherited from uvco::StreamBase
static constexpr size_t	defaultMaxReadSize = 4096
Protected Member Functions inherited from uvco::StreamBase
uv_stream_t &	stream ()
void	destroyStream ()

Detailed Description

A stream referring to a TCP connection.

Constructor & Destructor Documentation

TcpStream() [1/3]

uvco::TcpStream::TcpStream ( std::unique_ptr< uv_tcp_t >  tcp )

inlineexplicit

      : StreamBase{std::move(tcp)} {}

TcpStream() [2/3]

uvco::TcpStream::TcpStream ( const TcpStream &  )

delete

TcpStream() [3/3]

uvco::TcpStream::TcpStream ( TcpStream &&  )

default

~TcpStream()

uvco::TcpStream::~TcpStream ( )

overridedefault

Member Function Documentation

closeReset()

Promise< void > uvco::TcpStream::closeReset

(

)

Sends RST to TCP peer and closes stream, frees associated memory. Must be awaited to avoid resource leaks.

                                    {
  co_await closeHandle((uv_tcp_t *)&stream(), uv_tcp_close_reset);
  destroyStream();
}

getPeerName()

AddressHandle uvco::TcpStream::getPeerName

(

)

const

Return address of peer.

                                           {
  struct sockaddr_storage addr {};
  int namelen = sizeof(addr);
  uv_tcp_getpeername((const uv_tcp_t *)underlying(), (struct sockaddr *)&addr,
                     &namelen);
  const AddressHandle address{(struct sockaddr *)&addr};
  return address;
};

getSockName()

AddressHandle uvco::TcpStream::getSockName

(

)

const

Return bound address of socket.

                                           {
  struct sockaddr_storage addr {};
  int namelen = sizeof(addr);
  uv_tcp_getsockname((const uv_tcp_t *)underlying(), (struct sockaddr *)&addr,
                     &namelen);
  const AddressHandle address{(struct sockaddr *)&addr};
  return address;
}

keepAlive()

void uvco::TcpStream::keepAlive	(	bool	enable,
		unsigned int	delay = 10
	)

Set keep-alive delay in seconds.

                                                         {
  uv_tcp_keepalive((uv_tcp_t *)&stream(), static_cast<int>(enable), delay);
}

noDelay()

void uvco::TcpStream::noDelay

(

bool

enable

)

Enable Nagle's algorithm.

                                   {
  uv_tcp_nodelay((uv_tcp_t *)&stream(), static_cast<int>(enable));
}

operator=() [1/2]

TcpStream & uvco::TcpStream::operator= ( const TcpStream &  )

delete

operator=() [2/2]

TcpStream & uvco::TcpStream::operator= ( TcpStream &&  )

default

---

The documentation for this class was generated from the following files:

• uvco/tcp_stream.h
• uvco/tcp_stream.cc