uvco::UnixStream Class Reference

#include <uds_stream.h>

Inheritance diagram for uvco::UnixStream:

Collaboration diagram for uvco::UnixStream:

Public Member Functions
	UnixStream (const UnixStream &)=delete
	UnixStream (UnixStream &&)=default
UnixStream &	operator= (const UnixStream &)=delete
UnixStream &	operator= (UnixStream &&)=default
	~UnixStream () override=default
std::string	getSockName ()
std::string	getPeerName ()
template<typename Stream >
	StreamBase (std::unique_ptr< Stream > stream)
	StreamBase (const StreamBase &)=delete
	StreamBase (StreamBase &&)=default
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 served by a Unix domain socket. In addition to the StreamBase functionality, it provides getSockname() and getPeerName() methods.

A UnixStream cannot be created directly; use a UnixStreamClient or a UnixStreamServer to create streams.

Constructor & Destructor Documentation

UnixStream() [1/2]

uvco::UnixStream::UnixStream ( const UnixStream &  )

delete

UnixStream() [2/2]

uvco::UnixStream::UnixStream ( UnixStream &&  )

default

~UnixStream()

uvco::UnixStream::~UnixStream ( )

overridedefault

Member Function Documentation

getPeerName()

std::string uvco::UnixStream::getPeerName

(

)

                                  {
  return getXname((uv_pipe_t *)&stream(), uv_pipe_getpeername);
}

getSockName()

std::string uvco::UnixStream::getSockName

(

)

                                  {
  return getXname((uv_pipe_t *)&stream(), uv_pipe_getsockname);
}

operator=() [1/2]

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

delete

operator=() [2/2]

UnixStream & uvco::UnixStream::operator= ( UnixStream &&  )

default

StreamBase() [1/3]

uvco::StreamBase::StreamBase ( const StreamBase &  )

delete

StreamBase() [2/3]

template<typename Stream >

uvco::StreamBase::StreamBase ( std::unique_ptr< Stream >  stream )

inlineexplicit

      : stream_{(uv_stream_t *)stream.release()} {}

StreamBase() [3/3]

uvco::StreamBase::StreamBase ( StreamBase &&  )

default

---

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

• uvco/uds_stream.h
• uvco/uds_stream.cc