#include <StreamBusInterface.h>
Data Structures | |
| class | Client |
Public Member Functions | |
| virtual | ~StreamBusInterface () |
Static Public Member Functions | |
| static StreamBusInterface * | find (Client *, const char *busname, int addr, const char *param) |
Data Fields | |
| Client * | client |
Protected Member Functions | |
| StreamBusInterface (Client *client) | |
| void | lockCallback (StreamIoStatus status) |
| void | writeCallback (StreamIoStatus status) |
| long | readCallback (StreamIoStatus status, const void *input=NULL, long size=0) |
| void | eventCallback (StreamIoStatus status) |
| void | connectCallback (StreamIoStatus status) |
| void | disconnectCallback (StreamIoStatus status) |
| const char * | getInTerminator (size_t &length) |
| const char * | getOutTerminator (size_t &length) |
| long | priority () |
| const char * | clientName () |
| virtual bool | writeRequest (const void *output, size_t size, unsigned long timeout_ms) |
| virtual bool | readRequest (unsigned long replytimeout_ms, unsigned long readtimeout_ms, long expectedLength, bool async) |
| virtual bool | supportsEvent () |
| virtual bool | supportsAsyncRead () |
| virtual bool | acceptEvent (unsigned long mask, unsigned long replytimeout_ms) |
| virtual void | release () |
| virtual bool | connectRequest (unsigned long connecttimeout_ms) |
| virtual bool | disconnectRequest () |
| virtual void | finish () |
| virtual bool | lockRequest (unsigned long timeout_ms)=0 |
| virtual bool | unlock ()=0 |
Friends | |
| class | StreamBusInterfaceClass |
| class | Client |
Detailed Description
Definition at line 32 of file StreamBusInterface.h.
Constructor & Destructor Documentation
| virtual StreamBusInterface::~StreamBusInterface | ( | ) | [inline, virtual] |
Definition at line 100 of file StreamBusInterface.h.
| StreamBusInterface::StreamBusInterface | ( | Client * | client | ) | [protected] |
Member Function Documentation
| virtual bool StreamBusInterface::acceptEvent | ( | unsigned long | mask, | |
| unsigned long | replytimeout_ms | |||
| ) | [protected, virtual] |
Referenced by StreamBusInterface::Client::busAcceptEvent().
| const char* StreamBusInterface::clientName | ( | ) | [inline, protected] |
Definition at line 124 of file StreamBusInterface.h.
References client, and StreamBusInterface::Client::name().
| void StreamBusInterface::connectCallback | ( | StreamIoStatus | status | ) | [inline, protected] |
Definition at line 115 of file StreamBusInterface.h.
References client, and StreamBusInterface::Client::connectCallback().
| virtual bool StreamBusInterface::connectRequest | ( | unsigned long | connecttimeout_ms | ) | [protected, virtual] |
Referenced by StreamBusInterface::Client::busConnectRequest().
| void StreamBusInterface::disconnectCallback | ( | StreamIoStatus | status | ) | [inline, protected] |
Definition at line 117 of file StreamBusInterface.h.
References client, and StreamBusInterface::Client::disconnectCallback().
| virtual bool StreamBusInterface::disconnectRequest | ( | ) | [protected, virtual] |
Referenced by StreamBusInterface::Client::busDisconnect().
| void StreamBusInterface::eventCallback | ( | StreamIoStatus | status | ) | [inline, protected] |
Definition at line 113 of file StreamBusInterface.h.
References client, and StreamBusInterface::Client::eventCallback().
| static StreamBusInterface* StreamBusInterface::find | ( | Client * | , | |
| const char * | busname, | |||
| int | addr, | |||
| const char * | param | |||
| ) | [static] |
| virtual void StreamBusInterface::finish | ( | ) | [protected, virtual] |
Referenced by StreamBusInterface::Client::busFinish().
| const char* StreamBusInterface::getInTerminator | ( | size_t & | length | ) | [inline, protected] |
Definition at line 119 of file StreamBusInterface.h.
References client, and StreamBusInterface::Client::getInTerminator().
| const char* StreamBusInterface::getOutTerminator | ( | size_t & | length | ) | [inline, protected] |
Definition at line 121 of file StreamBusInterface.h.
References client, and StreamBusInterface::Client::getOutTerminator().
| void StreamBusInterface::lockCallback | ( | StreamIoStatus | status | ) | [inline, protected] |
Definition at line 106 of file StreamBusInterface.h.
References client, and StreamBusInterface::Client::lockCallback().
| virtual bool StreamBusInterface::lockRequest | ( | unsigned long | timeout_ms | ) | [protected, pure virtual] |
Referenced by StreamBusInterface::Client::busLockRequest().
| long StreamBusInterface::priority | ( | ) | [inline, protected] |
Definition at line 123 of file StreamBusInterface.h.
References client, and StreamBusInterface::Client::priority().
| long StreamBusInterface::readCallback | ( | StreamIoStatus | status, | |
| const void * | input = NULL, |
|||
| long | size = 0 | |||
| ) | [inline, protected] |
Definition at line 110 of file StreamBusInterface.h.
References client, and StreamBusInterface::Client::readCallback().
| virtual bool StreamBusInterface::readRequest | ( | unsigned long | replytimeout_ms, | |
| unsigned long | readtimeout_ms, | |||
| long | expectedLength, | |||
| bool | async | |||
| ) | [protected, virtual] |
Referenced by StreamBusInterface::Client::busReadRequest().
| virtual void StreamBusInterface::release | ( | ) | [protected, virtual] |
Referenced by StreamBusInterface::Client::busRelease().
| virtual bool StreamBusInterface::supportsAsyncRead | ( | ) | [protected, virtual] |
Referenced by StreamBusInterface::Client::busSupportsAsyncRead().
| virtual bool StreamBusInterface::supportsEvent | ( | ) | [protected, virtual] |
Referenced by StreamBusInterface::Client::busSupportsEvent().
| virtual bool StreamBusInterface::unlock | ( | ) | [protected, pure virtual] |
Referenced by StreamBusInterface::Client::busUnlock().
| void StreamBusInterface::writeCallback | ( | StreamIoStatus | status | ) | [inline, protected] |
Definition at line 108 of file StreamBusInterface.h.
References client, and StreamBusInterface::Client::writeCallback().
| virtual bool StreamBusInterface::writeRequest | ( | const void * | output, | |
| size_t | size, | |||
| unsigned long | timeout_ms | |||
| ) | [protected, virtual] |
Referenced by StreamBusInterface::Client::busWriteRequest().
Friends And Related Function Documentation
friend class Client [friend] |
Definition at line 96 of file StreamBusInterface.h.
friend class StreamBusInterfaceClass [friend] |
Definition at line 95 of file StreamBusInterface.h.
Field Documentation
Definition at line 99 of file StreamBusInterface.h.
Referenced by clientName(), connectCallback(), disconnectCallback(), eventCallback(), getInTerminator(), getOutTerminator(), lockCallback(), priority(), readCallback(), and writeCallback().
The documentation for this class was generated from the following file:
- epics/apps/crucible/stream/src/StreamBusInterface.h (r4864/r2310)
