Overview

Wraps POSIX-style TCP sockets with the pw::stream::Reader and pw::stream::Writer interfaces. It can be used to connect to a TCP server, or to communicate with a client via the pw::stream::ServerSocket class.

Inheritance diagram for pw::stream::SocketStream:

Public Member Functions
	SocketStream (int connection_fd)

SocketStream &	operator= (SocketStream &&other)

	SocketStream (SocketStream &&other) noexcept

	SocketStream (const SocketStream &)=delete

SocketStream &	operator= (const SocketStream &)=delete

Status	Connect (const char *host, uint16_t port)

int	SetSockOpt (int level, int optname, const void *optval, unsigned int optlen)

bool	IsReady ()

void	Close ()

Public Member Functions inherited from pw::stream::NonSeekableReaderWriter
	operator NonSeekableReader & ()

	operator const NonSeekableReader & () const

	operator NonSeekableWriter & ()

	operator const NonSeekableWriter & () const

Public Member Functions inherited from pw::stream::ReaderWriter
Reader &	as_reader ()

const Reader &	as_reader () const

	operator Reader & ()

	operator const Reader & () const

Writer &	as_writer ()

const Writer &	as_writer () const

	operator Writer & ()

	operator const Writer & () const

Public Member Functions inherited from pw::stream::Stream
constexpr bool	readable () const

constexpr bool	writable () const

constexpr bool	seekable () const

constexpr bool	seekable (Whence origin) const
	True if the stream supports seeking from the specified origin.

Result< ByteSpan >	Read (ByteSpan dest)

Result< ByteSpan >	Read (void *dest, size_t size_bytes)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Result< ByteSpan >	ReadExact (ByteSpan const buffer)

Status	Write (ConstByteSpan data)

Status	Write (const void *data, size_t size_bytes)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Status	Write (const std::byte b)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Status	Seek (ptrdiff_t offset, Whence origin=kBeginning)

size_t	Tell ()

size_t	ConservativeReadLimit () const

size_t	ConservativeWriteLimit () const

Private Member Functions
StatusWithSize	DoRead (ByteSpan dest) override
	Virtual Read() function implemented by derived classes.

Additional Inherited Members
Public Types inherited from pw::stream::Stream
enum	Whence : uint8_t { kBeginning = 0b001 , kCurrent = 0b010 , kEnd = 0b100 }
	Positions from which to seek. More...

Static Public Attributes inherited from pw::stream::Stream
static constexpr size_t	kUnlimited = std::numeric_limits<size_t>::max()
	Value returned from read/write limit if unlimited.

static constexpr size_t	kUnknownPosition = std::numeric_limits<size_t>::max()
	Returned by Tell() if getting the position is not supported.

Protected Types inherited from pw::stream::Stream
enum class	LimitType : bool { kRead , kWrite }

Member Function Documentation

◆ DoRead()

StatusWithSize pw::stream::SocketStream::DoRead ( ByteSpan destination )

overrideprivatevirtual

Virtual Read() function implemented by derived classes.

Implements pw::stream::Stream.

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

pw_stream/public/pw_stream/socket_stream.h

Overview

Public Member Functions

Private Member Functions

Additional Inherited Members

Member Function Documentation

◆ DoRead()