StreamBusInterface::Client Class Reference

#include <StreamBusInterface.h>

Inheritance diagram for StreamBusInterface::Client:

Collaboration diagram for StreamBusInterface::Client:

Public Member Functions
virtual	~Client ()
Protected Member Functions
bool	busSupportsEvent ()
bool	busSupportsAsyncRead ()
bool	busAcceptEvent (unsigned long mask, unsigned long replytimeout_ms)
void	busRelease ()
bool	busLockRequest (unsigned long timeout_ms)
bool	busUnlock ()
bool	busWriteRequest (const void *output, size_t size, unsigned long timeout_ms)
bool	busReadRequest (unsigned long replytimeout_ms, unsigned long readtimeout_ms, long expectedLength, bool async)
void	busFinish ()
bool	busConnectRequest (unsigned long timeout_ms)
bool	busDisconnect ()
Protected Attributes
StreamBusInterface *	businterface
Private Member Functions
virtual void	lockCallback (StreamIoStatus status)=0
virtual void	writeCallback (StreamIoStatus status)
virtual long	readCallback (StreamIoStatus status, const void *input, long size)
virtual void	eventCallback (StreamIoStatus status)
virtual void	connectCallback (StreamIoStatus status)
virtual void	disconnectCallback (StreamIoStatus status)
virtual long	priority ()
virtual const char *	name ()=0
virtual const char *	getInTerminator (size_t &length)=0
virtual const char *	getOutTerminator (size_t &length)=0
Friends
class	StreamBusInterface

---

Detailed Description

Definition at line 36 of file StreamBusInterface.h.

---

Constructor & Destructor Documentation

virtual StreamBusInterface::Client::~Client

(

)

[virtual]

---

Member Function Documentation

bool StreamBusInterface::Client::busAcceptEvent	(	unsigned long	mask,
		unsigned long	replytimeout_ms
	)			[inline, protected]

Definition at line 60 of file StreamBusInterface.h.

References StreamBusInterface::acceptEvent(), and businterface.

bool StreamBusInterface::Client::busConnectRequest

(

unsigned long

timeout_ms

)

[inline, protected]

Definition at line 86 of file StreamBusInterface.h.

References businterface, and StreamBusInterface::connectRequest().

bool StreamBusInterface::Client::busDisconnect

(

)

[inline, protected]

Definition at line 89 of file StreamBusInterface.h.

References businterface, and StreamBusInterface::disconnectRequest().

void StreamBusInterface::Client::busFinish

(

)

[inline, protected]

Definition at line 83 of file StreamBusInterface.h.

References businterface, and StreamBusInterface::finish().

bool StreamBusInterface::Client::busLockRequest

(

unsigned long

timeout_ms

)

[inline, protected]

Definition at line 67 of file StreamBusInterface.h.

References businterface, and StreamBusInterface::lockRequest().

bool StreamBusInterface::Client::busReadRequest	(	unsigned long	replytimeout_ms,
		unsigned long	readtimeout_ms,
		long	expectedLength,
		bool	async
	)			[inline, protected]

Definition at line 77 of file StreamBusInterface.h.

References businterface, and StreamBusInterface::readRequest().

void StreamBusInterface::Client::busRelease

(

)

[inline, protected]

Definition at line 64 of file StreamBusInterface.h.

References businterface, and StreamBusInterface::release().

bool StreamBusInterface::Client::busSupportsAsyncRead

(

)

[inline, protected]

Definition at line 57 of file StreamBusInterface.h.

References businterface, and StreamBusInterface::supportsAsyncRead().

bool StreamBusInterface::Client::busSupportsEvent

(

)

[inline, protected]

Definition at line 54 of file StreamBusInterface.h.

References businterface, and StreamBusInterface::supportsEvent().

bool StreamBusInterface::Client::busUnlock

(

)

[inline, protected]

Definition at line 70 of file StreamBusInterface.h.

References businterface, and StreamBusInterface::unlock().

bool StreamBusInterface::Client::busWriteRequest	(	const void *	output,
		size_t	size,
		unsigned long	timeout_ms
	)			[inline, protected]

Definition at line 73 of file StreamBusInterface.h.

References businterface, and StreamBusInterface::writeRequest().

virtual void StreamBusInterface::Client::connectCallback

(

StreamIoStatus

status

)

[private, virtual]

Reimplemented in StreamCore.

Referenced by StreamBusInterface::connectCallback().

virtual void StreamBusInterface::Client::disconnectCallback

(

StreamIoStatus

status

)

[private, virtual]

Reimplemented in StreamCore.

Referenced by StreamBusInterface::disconnectCallback().

virtual void StreamBusInterface::Client::eventCallback

(

StreamIoStatus

status

)

[private, virtual]

Reimplemented in StreamCore.

Referenced by StreamBusInterface::eventCallback().

virtual const char* StreamBusInterface::Client::getInTerminator

(

size_t &

length

)

[private, pure virtual]

Implemented in StreamCore.

Referenced by StreamBusInterface::getInTerminator().

virtual const char* StreamBusInterface::Client::getOutTerminator

(

size_t &

length

)

[private, pure virtual]

Implemented in StreamCore.

Referenced by StreamBusInterface::getOutTerminator().

virtual void StreamBusInterface::Client::lockCallback

(

StreamIoStatus

status

)

[private, pure virtual]

Implemented in StreamCore.

Referenced by StreamBusInterface::lockCallback().

virtual const char* StreamBusInterface::Client::name

(

)

[private, pure virtual]

Implemented in StreamCore.

Referenced by StreamBusInterface::clientName().

virtual long StreamBusInterface::Client::priority

(

)

[private, virtual]

Referenced by StreamBusInterface::priority().

virtual long StreamBusInterface::Client::readCallback	(	StreamIoStatus	status,
		const void *	input,
		long	size
	)			[private, virtual]

Reimplemented in StreamCore.

Referenced by StreamBusInterface::readCallback().

virtual void StreamBusInterface::Client::writeCallback

(

StreamIoStatus

status

)

[private, virtual]

Reimplemented in StreamCore.

Referenced by StreamBusInterface::writeCallback().

---

Friends And Related Function Documentation

friend class StreamBusInterface [friend]

Definition at line 38 of file StreamBusInterface.h.

---

Field Documentation

StreamBusInterface* StreamBusInterface::Client::businterface [protected]

Definition at line 53 of file StreamBusInterface.h.

Referenced by busAcceptEvent(), busConnectRequest(), busDisconnect(), busFinish(), busLockRequest(), busReadRequest(), busRelease(), busSupportsAsyncRead(), busSupportsEvent(), busUnlock(), and busWriteRequest().

---

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

• epics/apps/crucible/stream/src/StreamBusInterface.h (r4864/r2310)