Collaboration diagram for UnixSocketConnection::Stream:

Classes
struct	Control

class	ControlGuard

struct	Packet

Public Member Functions
	Stream (bool packets)

size_t	write (const uint8_t buffer, size_t count, bool block, const SharedPointer< SocketRights > &rights=SharedPointer< SocketRights >(), bool interrupted=nullptr)

size_t	writeVectors (const struct iovec vectors, size_t vectorCount, bool block, const SharedPointer< SocketRights > &rights, bool interrupted=nullptr)

size_t	read (uint8_t buffer, size_t count, bool block, SharedPointer< SocketRights > rights=nullptr, bool *interrupted=nullptr)

size_t	readVectors (struct iovec vectors, size_t vectorCount, bool block, SharedPointer< SocketRights > rights, bool *interrupted=nullptr)

bool	writePacket (const uint8_t buffer, size_t count, bool block, const SharedPointer< SocketRights > &rights, bool interrupted)

bool	readPacket (uint8_t buffer, size_t count, bool block, SharedPointer< SocketRights > &rights, uint64_t &bytesRead, uint64_t &packetLength, bool interrupted)

Buffer< uint8_t, true > &	records ()

bool	canWrite (bool block)

bool	canRead (bool block)

uint64_t	readableGeneration () const

uint64_t	writableGeneration () const

void	disableWrites ()

void	disableReads ()

void	monitor (Semaphore *waiter)

void	monitor (Thread thread, Event event)

void	cullMonitorTargets (Semaphore *waiter)

void	cullMonitorTargets (Event *event)

Buffer< uint8_t, true > &	buffer ()

Private Member Functions
void	discardControls ()

void	discardControlsIfRequested ()

Private Attributes
const bool	m_Packets

Buffer< uint8_t, true >	m_Records

List< Packet * >	m_PendingPackets

Buffer< uint8_t, true >	m_Bytes

UnixStreamSerializationGate	m_SendLock

UnixStreamSerializationGate	m_ReceiveLock

Mutex	m_ControlLock

Atomic< bool >	m_DiscardControlsRequested

List< Control * >	m_Controls

uint64_t	m_BytesWritten

uint64_t	m_BytesRead

Detailed Description

One ordered byte/control direction in a connected stream socket pair.

Definition at line 100 of file UnixFilesystem.h.

Constructor & Destructor Documentation

◆ Stream()

UnixSocketConnection::Stream::Stream ( bool packets )

explicit

Definition at line 199 of file UnixFilesystem.cc.

◆ ~Stream()

UnixSocketConnection::Stream::~Stream ( )

Definition at line 218 of file UnixFilesystem.cc.

Member Function Documentation

◆ buffer()

Buffer< uint8_t, true > & UnixSocketConnection::Stream::buffer ( )

inline

Definition at line 135 of file UnixFilesystem.h.

◆ canRead()

bool UnixSocketConnection::Stream::canRead ( bool block )

Definition at line 468 of file UnixFilesystem.cc.

◆ canWrite()

bool UnixSocketConnection::Stream::canWrite ( bool block )

Definition at line 464 of file UnixFilesystem.cc.

◆ cullMonitorTargets() [1/2]

void UnixSocketConnection::Stream::cullMonitorTargets ( Event * event )

Definition at line 530 of file UnixFilesystem.cc.

◆ cullMonitorTargets() [2/2]

void UnixSocketConnection::Stream::cullMonitorTargets ( Semaphore * waiter )

Definition at line 522 of file UnixFilesystem.cc.

◆ disableReads()

void UnixSocketConnection::Stream::disableReads ( )

Definition at line 485 of file UnixFilesystem.cc.

◆ disableWrites()

void UnixSocketConnection::Stream::disableWrites ( )

Definition at line 480 of file UnixFilesystem.cc.

◆ discardControls()

void UnixSocketConnection::Stream::discardControls ( )

private

Definition at line 538 of file UnixFilesystem.cc.

◆ discardControlsIfRequested()

void UnixSocketConnection::Stream::discardControlsIfRequested ( )

private

Definition at line 547 of file UnixFilesystem.cc.

◆ monitor() [1/2]

void UnixSocketConnection::Stream::monitor ( Semaphore * waiter )

Definition at line 506 of file UnixFilesystem.cc.

◆ monitor() [2/2]

void UnixSocketConnection::Stream::monitor	(	Thread *	thread,
		Event *	event
	)

Definition at line 514 of file UnixFilesystem.cc.

◆ read()

size_t UnixSocketConnection::Stream::read	(	uint8_t *	buffer,
		size_t	count,
		bool	block,
		SharedPointer< SocketRights > *	rights = `nullptr`,
		bool *	interrupted = `nullptr`
	)

Definition at line 303 of file UnixFilesystem.cc.

◆ readableGeneration()

uint64_t UnixSocketConnection::Stream::readableGeneration ( ) const

Definition at line 472 of file UnixFilesystem.cc.

◆ readPacket()

bool UnixSocketConnection::Stream::readPacket	(	uint8_t *	buffer,
		size_t	count,
		bool	block,
		SharedPointer< SocketRights > &	rights,
		uint64_t &	bytesRead,
		uint64_t &	packetLength,
		bool *	interrupted
	)

Definition at line 427 of file UnixFilesystem.cc.

◆ readVectors()

size_t UnixSocketConnection::Stream::readVectors	(	struct iovec *	vectors,
		size_t	vectorCount,
		bool	block,
		SharedPointer< SocketRights > *	rights,
		bool *	interrupted = `nullptr`
	)

Definition at line 309 of file UnixFilesystem.cc.

◆ records()

Buffer< uint8_t, true > & UnixSocketConnection::Stream::records ( )

inline

Definition at line 120 of file UnixFilesystem.h.

◆ writableGeneration()

uint64_t UnixSocketConnection::Stream::writableGeneration ( ) const

Definition at line 476 of file UnixFilesystem.cc.

◆ write()

size_t UnixSocketConnection::Stream::write	(	const uint8_t *	buffer,
		size_t	count,
		bool	block,
		const SharedPointer< SocketRights > &	rights = `SharedPointer<SocketRights>()`,
		bool *	interrupted = `nullptr`
	)

Definition at line 224 of file UnixFilesystem.cc.

◆ writePacket()

bool UnixSocketConnection::Stream::writePacket	(	const uint8_t *	buffer,
		size_t	count,
		bool	block,
		const SharedPointer< SocketRights > &	rights,
		bool *	interrupted
	)

Definition at line 390 of file UnixFilesystem.cc.

◆ writeVectors()

size_t UnixSocketConnection::Stream::writeVectors	(	const struct iovec *	vectors,
		size_t	vectorCount,
		bool	block,
		const SharedPointer< SocketRights > &	rights,
		bool *	interrupted = `nullptr`
	)

Definition at line 231 of file UnixFilesystem.cc.

Member Data Documentation

◆ m_Bytes

Buffer<uint8_t, true> UnixSocketConnection::Stream::m_Bytes

private

Definition at line 174 of file UnixFilesystem.h.

◆ m_BytesRead

uint64_t UnixSocketConnection::Stream::m_BytesRead

private

Definition at line 181 of file UnixFilesystem.h.

◆ m_BytesWritten

uint64_t UnixSocketConnection::Stream::m_BytesWritten

private

Definition at line 180 of file UnixFilesystem.h.

◆ m_ControlLock

Mutex UnixSocketConnection::Stream::m_ControlLock

private

Definition at line 177 of file UnixFilesystem.h.

◆ m_Controls

List<Control*> UnixSocketConnection::Stream::m_Controls

private

Definition at line 179 of file UnixFilesystem.h.

◆ m_DiscardControlsRequested

Atomic<bool> UnixSocketConnection::Stream::m_DiscardControlsRequested

private

Definition at line 178 of file UnixFilesystem.h.

◆ m_Packets

const bool UnixSocketConnection::Stream::m_Packets

private

Definition at line 171 of file UnixFilesystem.h.

◆ m_PendingPackets

List<Packet*> UnixSocketConnection::Stream::m_PendingPackets

private

Definition at line 173 of file UnixFilesystem.h.

◆ m_ReceiveLock

UnixStreamSerializationGate UnixSocketConnection::Stream::m_ReceiveLock

private

Definition at line 176 of file UnixFilesystem.h.

◆ m_Records

Buffer<uint8_t, true> UnixSocketConnection::Stream::m_Records

private

Definition at line 172 of file UnixFilesystem.h.

◆ m_SendLock

UnixStreamSerializationGate UnixSocketConnection::Stream::m_SendLock

private

Definition at line 175 of file UnixFilesystem.h.

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Stream()

◆ ~Stream()

Member Function Documentation

◆ buffer()

◆ canRead()

◆ canWrite()

◆ cullMonitorTargets() [1/2]

◆ cullMonitorTargets() [2/2]

◆ disableReads()

◆ disableWrites()

◆ discardControls()

◆ discardControlsIfRequested()

◆ monitor() [1/2]

◆ monitor() [2/2]

◆ read()

◆ readableGeneration()

◆ readPacket()

◆ readVectors()

◆ records()

◆ writableGeneration()

◆ write()

◆ writePacket()

◆ writeVectors()

Member Data Documentation

◆ m_Bytes

◆ m_BytesRead

◆ m_BytesWritten

◆ m_ControlLock

◆ m_Controls

◆ m_DiscardControlsRequested

◆ m_Packets

◆ m_PendingPackets

◆ m_ReceiveLock

◆ m_Records

◆ m_SendLock