pvAccessCPP
7.1.7
|
The interface through which Operations (get, put, monitor, ...) are initiated. More...
#include <client/pv/pvAccess.h>
Public Types | |
enum | ConnectionState { NEVER_CONNECTED, CONNECTED, DISCONNECTED, DESTROYED } |
Channel connection status. | |
typedef std::tr1::shared_ptr < Channel > | shared_pointer |
typedef std::tr1::shared_ptr < const Channel > | const_shared_pointer |
typedef std::tr1::weak_ptr < Channel > | weak_pointer |
typedef std::tr1::weak_ptr < const Channel > | const_weak_pointer |
typedef ChannelRequester | requester_type |
Public Member Functions | |
virtual std::string | getRequesterName () |
The requester must have a name. More... | |
virtual void | message (std::string const &message, epics::pvData::MessageType messageType) |
virtual std::tr1::shared_ptr < ChannelProvider > | getProvider ()=0 |
The ChannelProvider from which this Channel was requested. More... | |
virtual std::string | getRemoteAddress ()=0 |
Returns the channel's remote address, signal name, etc... More... | |
virtual ConnectionState | getConnectionState () |
Poll the connection state in more detail. | |
virtual std::string | getChannelName ()=0 |
The name passed to ChannelProvider::createChannel() | |
virtual std::tr1::shared_ptr < ChannelRequester > | getChannelRequester ()=0 |
The ChannelRequester passed to ChannelProvider::createChannel() More... | |
virtual bool | isConnected () |
Poll connection state. | |
virtual void | getField (GetFieldRequester::shared_pointer const &requester, std::string const &subField) |
Initiate a request to retrieve a description of the structure of this Channel. More... | |
virtual AccessRights | getAccessRights (epics::pvData::PVField::shared_pointer const &pvField) |
Not useful... More... | |
virtual ChannelProcess::shared_pointer | createChannelProcess (ChannelProcessRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest) |
Initiate a request for a Process action. More... | |
virtual ChannelGet::shared_pointer | createChannelGet (ChannelGetRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest) |
Initiate a request for a Get action. More... | |
virtual ChannelPut::shared_pointer | createChannelPut (ChannelPutRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest) |
Initiate a request for a Put action. More... | |
virtual ChannelPutGet::shared_pointer | createChannelPutGet (ChannelPutGetRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest) |
Initiate a request for a PutGet action. More... | |
virtual ChannelRPC::shared_pointer | createChannelRPC (ChannelRPCRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest) |
Initiate a request for a RPC action. More... | |
virtual Monitor::shared_pointer | createMonitor (MonitorRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest) |
Initiate a request for a Monitor action. More... | |
virtual ChannelArray::shared_pointer | createChannelArray (ChannelArrayRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest) |
Initiate a request for a Array (get) action. More... | |
virtual void | printInfo () |
Prints detailed information about the context to the standard output stream. | |
virtual void | printInfo (std::ostream &out) |
Prints detailed information about the context to the specified output stream. More... | |
virtual void | message (std::string const &message, MessageType messageType=errorMessage) |
Push notification. | |
virtual void | destroy () |
Destroy this instance. | |
Static Public Attributes | |
static size_t | num_instances |
static const char * | ConnectionStateNames [] |
The interface through which Operations (get, put, monitor, ...) are initiated.
Handle for a Channel returned by ChannelProvider::createChannel()
At any given moment a Channel may be CONNECTED or DISCONNECTED. (NEVER_CONNECTED and DESTORYED are special cases of DISCONNECTED)
A Channel is required to honor calls to Channel::create*() methods while in the disconnected state.
A Channel is required to maintain a strong reference (shared_ptr<>) to the ChannelProvider through which it was created.
Definition at line 886 of file pvAccess.h.
|
virtual |
Initiate a request for a Array (get) action.
ChannelArrayRequester::channelArrayConnect() may be called before createChannelArray() returns, or at some time afterwards.
Failure is indicated by a call to channelArrayConnect with !Error::isOk()
Create a ChannelArray.
channelArrayRequester | The ChannelArrayRequester |
pvRequest | Additional options (e.g. triggering). |
ChannelArray
instance.
|
virtual |
Initiate a request for a Get action.
ChannelGetRequester::channelGetConnect() may be called before createChannelGet() returns, or at some time afterwards.
Failure is indicated by a call to channelProcessConnect with !Error::isOk()
|
virtual |
Initiate a request for a Process action.
ChannelProcessRequester::channelProcessConnect() may be called before createChannelProcess() returns, or at some time afterwards.
Failure is indicated by a call to channelProcessConnect with !Error::isOk()
|
virtual |
Initiate a request for a Put action.
ChannelPutRequester::channelPutConnect() may be called before createChannelPut() returns, or at some time afterwards.
Failure is indicated by a call to channelProcessConnect with !Error::isOk()
|
virtual |
Initiate a request for a PutGet action.
ChannelPutGetRequester::channelPutGetConnect() may be called before createChannelPutGet() returns, or at some time afterwards.
Failure is indicated by a call to channelProcessConnect with !Error::isOk()
|
virtual |
Initiate a request for a RPC action.
ChannelRPCRequester::channelRPCConnect() may be called before createChannelRPC() returns, or at some time afterwards.
Failure is indicated by a call to channelProcessConnect with !Error::isOk()
|
virtual |
Initiate a request for a Monitor action.
MonitorRequester::channelMonitorConnect() may be called before createMonitor() returns, or at some time afterwards.
Failure is indicated by a call to monitorConnect with !Error::isOk()
|
virtual |
Not useful...
pvField | The field for which access rights is desired. |
|
pure virtual |
The ChannelRequester passed to ChannelProvider::createChannel()
std::tr1::bad_weak_ptr |
|
virtual |
Initiate a request to retrieve a description of the structure of this Channel.
While the type described by calls to getField() should match what is provided for all operations except RPC.
GetFieldRequester::getDone() will be called before getField() returns, or at some time afterwards.
|
pure virtual |
The ChannelProvider from which this Channel was requested.
May never be NULL.
|
pure virtual |
Returns the channel's remote address, signal name, etc...
For example:
The value returned here will changed depending on the connection status. A disconnected channel should return an empty() string.
|
virtual |
|
inlinevirtual |
Prints detailed information about the context to the specified output stream.
out | the output stream. |
Definition at line 1132 of file pvAccess.h.