pvDatabaseCPP  4.5.3-dev
Public Member Functions | Protected Member Functions | List of all members
epics::pvDatabase::ChannelLocal Class Reference

Channel for accessing a PVRecord. More...

#include <channelProviderLocal.h>

Inheritance diagram for epics::pvDatabase::ChannelLocal:
epics::pvDatabase::PVRecordClient

Public Member Functions

 POINTER_DEFINITIONS (ChannelLocal)
 
 ChannelLocal (ChannelProviderLocalPtr const &channelProvider, epics::pvAccess::ChannelRequester::shared_pointer const &requester, PVRecordPtr const &pvRecord)
 
virtual ~ChannelLocal ()
 Destructor. More...
 
virtual void destroy ()
 DEPRECATED. More...
 
virtual void detach (PVRecordPtr const &pvRecord)
 Detach from the record. More...
 
virtual std::string getRequesterName ()
 Get the requester name. More...
 
virtual void message (std::string const &message, epics::pvData::MessageType messageType)
 Passes the message to the channel requester. More...
 
virtual epics::pvAccess::ChannelProvider::shared_pointer getProvider ()
 Get the channel provider. More...
 
virtual std::string getRemoteAddress ()
 Get the remote address. More...
 
virtual epics::pvAccess::Channel::ConnectionState getConnectionState ()
 
virtual std::string getChannelName ()
 Get the channel name. More...
 
virtual epics::pvAccess::ChannelRequester::shared_pointer getChannelRequester ()
 Get the channel requester. More...
 
virtual bool isConnected ()
 Is the channel connected? More...
 
virtual void getField (epics::pvAccess::GetFieldRequester::shared_pointer const &requester, std::string const &subField)
 Get the introspection interface for subField. More...
 
virtual epics::pvAccess::AccessRights getAccessRights (epics::pvData::PVField::shared_pointer const &pvField)
 
virtual epics::pvAccess::ChannelProcess::shared_pointer createChannelProcess (epics::pvAccess::ChannelProcessRequester::shared_pointer const &requester, epics::pvData::PVStructurePtr const &pvRequest)
 Create a channelProcess. More...
 
virtual epics::pvAccess::ChannelGet::shared_pointer createChannelGet (epics::pvAccess::ChannelGetRequester::shared_pointer const &requester, epics::pvData::PVStructurePtr const &pvRequest)
 Create a channelGet. More...
 
virtual epics::pvAccess::ChannelPut::shared_pointer createChannelPut (epics::pvAccess::ChannelPutRequester::shared_pointer const &requester, epics::pvData::PVStructurePtr const &pvRequest)
 Create a channelPut. More...
 
virtual epics::pvAccess::ChannelPutGet::shared_pointer createChannelPutGet (epics::pvAccess::ChannelPutGetRequester::shared_pointer const &requester, epics::pvData::PVStructurePtr const &pvRequest)
 Create a channelPutGet. More...
 
virtual epics::pvAccess::ChannelRPC::shared_pointer createChannelRPC (epics::pvAccess::ChannelRPCRequester::shared_pointer const &requester, epics::pvData::PVStructurePtr const &pvRequest)
 Create a channelRPC. More...
 
virtual epics::pvData::Monitor::shared_pointer createMonitor (epics::pvData::MonitorRequester::shared_pointer const &requester, epics::pvData::PVStructurePtr const &pvRequest)
 Create a monitor. More...
 
virtual epics::pvAccess::ChannelArray::shared_pointer createChannelArray (epics::pvAccess::ChannelArrayRequester::shared_pointer const &requester, epics::pvData::PVStructurePtr const &pvRequest)
 Create a channelArray. More...
 
virtual void printInfo ()
 calls printInfo(std::cout); More...
 
virtual void printInfo (std::ostream &out)
 displays a message More...
 
 POINTER_DEFINITIONS (PVRecordClient)
 

Protected Member Functions

shared_pointer getPtrSelf ()
 

Detailed Description

Channel for accessing a PVRecord.

A Channel for accessing a record in the PVDatabase. It is a complete implementation of Channel

Definition at line 172 of file channelProviderLocal.h.

Constructor & Destructor Documentation

◆ ChannelLocal()

epics::pvDatabase::ChannelLocal::ChannelLocal ( ChannelProviderLocalPtr const &  channelProvider,
epics::pvAccess::ChannelRequester::shared_pointer const &  requester,
PVRecordPtr const &  pvRecord 
)

Constructor

Parameters
channelProviderThe channel provider.
requesterThe client callback.
pvRecordThe record the channel will access.

Definition at line 1227 of file channelLocal.cpp.

◆ ~ChannelLocal()

epics::pvDatabase::ChannelLocal::~ChannelLocal ( )
virtual

Destructor.

Definition at line 1244 of file channelLocal.cpp.

Member Function Documentation

◆ createChannelArray()

ChannelArray::shared_pointer epics::pvDatabase::ChannelLocal::createChannelArray ( epics::pvAccess::ChannelArrayRequester::shared_pointer const &  requester,
epics::pvData::PVStructurePtr const &  pvRequest 
)
virtual

Create a channelArray.

Parameters
requesterThe client callback.
pvRequestThe options specified by the client.
Returns
A shared pointer to the newly created implementation. The implementation is null if pvRequest has invalid options.

Definition at line 1488 of file channelLocal.cpp.

References getPtrSelf().

◆ createChannelGet()

ChannelGet::shared_pointer epics::pvDatabase::ChannelLocal::createChannelGet ( epics::pvAccess::ChannelGetRequester::shared_pointer const &  requester,
epics::pvData::PVStructurePtr const &  pvRequest 
)
virtual

Create a channelGet.

Parameters
requesterThe client callback.
pvRequestThe options specified by the client.
Returns
A shared pointer to the newly created implementation. The implementation is null if pvRequest has invalid options.

Definition at line 1381 of file channelLocal.cpp.

References getPtrSelf().

◆ createChannelProcess()

ChannelProcess::shared_pointer epics::pvDatabase::ChannelLocal::createChannelProcess ( epics::pvAccess::ChannelProcessRequester::shared_pointer const &  requester,
epics::pvData::PVStructurePtr const &  pvRequest 
)
virtual

Create a channelProcess.

Parameters
requesterThe client callback.
pvRequestThe options specified by the client.
Returns
A shared pointer to the newly created implementation. The implementation is null if pvRequest has invalid options.

Definition at line 1360 of file channelLocal.cpp.

References getPtrSelf().

◆ createChannelPut()

ChannelPut::shared_pointer epics::pvDatabase::ChannelLocal::createChannelPut ( epics::pvAccess::ChannelPutRequester::shared_pointer const &  requester,
epics::pvData::PVStructurePtr const &  pvRequest 
)
virtual

Create a channelPut.

Parameters
requesterThe client callback.
pvRequestThe options specified by the client.
Returns
A shared pointer to the newly created implementation. The implementation is null if pvRequest has invalid options.

Definition at line 1402 of file channelLocal.cpp.

References getPtrSelf().

◆ createChannelPutGet()

ChannelPutGet::shared_pointer epics::pvDatabase::ChannelLocal::createChannelPutGet ( epics::pvAccess::ChannelPutGetRequester::shared_pointer const &  requester,
epics::pvData::PVStructurePtr const &  pvRequest 
)
virtual

Create a channelPutGet.

Parameters
requesterThe client callback.
pvRequestThe options specified by the client.
Returns
A shared pointer to the newly created implementation. The implementation is null if pvRequest has invalid options.

Definition at line 1424 of file channelLocal.cpp.

References getPtrSelf().

◆ createChannelRPC()

ChannelRPC::shared_pointer epics::pvDatabase::ChannelLocal::createChannelRPC ( epics::pvAccess::ChannelRPCRequester::shared_pointer const &  requester,
epics::pvData::PVStructurePtr const &  pvRequest 
)
virtual

Create a channelRPC.

The PVRecord must implement getService or an empty shared pointer is returned.

Parameters
requesterThe client callback
pvRequestThe options specified by the client.
Returns
null.

Definition at line 1446 of file channelLocal.cpp.

References getPtrSelf().

◆ createMonitor()

Monitor::shared_pointer epics::pvDatabase::ChannelLocal::createMonitor ( epics::pvData::MonitorRequester::shared_pointer const &  requester,
epics::pvData::PVStructurePtr const &  pvRequest 
)
virtual

Create a monitor.

Parameters
requesterThe client callback.
pvRequestThe options specified by the client.
Returns
A shared pointer to the newly created implementation. The implementation is null if pvRequest has invalid options.

Definition at line 1468 of file channelLocal.cpp.

References epics::pvDatabase::createMonitorLocal().

◆ destroy()

virtual void epics::pvDatabase::ChannelLocal::destroy ( )
inlinevirtual

DEPRECATED.

Definition at line 197 of file channelProviderLocal.h.

◆ detach()

void epics::pvDatabase::ChannelLocal::detach ( PVRecordPtr const &  pvRecord)
virtual

Detach from the record.

This is called when a record is being removed from the database.

Parameters
pvRecordThe record being removed.

Implements epics::pvDatabase::PVRecordClient.

Definition at line 1254 of file channelLocal.cpp.

◆ getAccessRights()

AccessRights epics::pvDatabase::ChannelLocal::getAccessRights ( epics::pvData::PVField::shared_pointer const &  pvField)
virtual

Get the access rights for the record. This throws an exception because it is assumed that access rights are handled by a higher level.

Definition at line 1354 of file channelLocal.cpp.

◆ getChannelName()

string epics::pvDatabase::ChannelLocal::getChannelName ( )
virtual

Get the channel name.

Returns
the record name.

Definition at line 1314 of file channelLocal.cpp.

◆ getChannelRequester()

ChannelRequester::shared_pointer epics::pvDatabase::ChannelLocal::getChannelRequester ( )
virtual

Get the channel requester.

Returns
The channel requester.

Definition at line 1322 of file channelLocal.cpp.

◆ getConnectionState()

Channel::ConnectionState epics::pvDatabase::ChannelLocal::getConnectionState ( )
virtual

Get the connection state.

Returns
Channel::CONNECTED.

Definition at line 1309 of file channelLocal.cpp.

◆ getField()

void epics::pvDatabase::ChannelLocal::getField ( epics::pvAccess::GetFieldRequester::shared_pointer const &  requester,
std::string const &  subField 
)
virtual

Get the introspection interface for subField.

The introspection interface is given via GetFieldRequester::getDone.

Parameters
requesterThe client callback.
subFieldThe subField of the record. If an empty string then the interface for the top level structure of the record is provided.

Definition at line 1332 of file channelLocal.cpp.

◆ getProvider()

ChannelProvider::shared_pointer epics::pvDatabase::ChannelLocal::getProvider ( )
virtual

Get the channel provider.

Returns
The provider.

Definition at line 1249 of file channelLocal.cpp.

◆ getPtrSelf()

shared_pointer epics::pvDatabase::ChannelLocal::getPtrSelf ( )
inlineprotected

◆ getRemoteAddress()

string epics::pvDatabase::ChannelLocal::getRemoteAddress ( )
virtual

Get the remote address.

Returns
local

Definition at line 1304 of file channelLocal.cpp.

◆ getRequesterName()

string epics::pvDatabase::ChannelLocal::getRequesterName ( )
virtual

Get the requester name.

Returns
returns the name of the channel requester.

Definition at line 1267 of file channelLocal.cpp.

◆ isConnected()

bool epics::pvDatabase::ChannelLocal::isConnected ( )
virtual

Is the channel connected?

Returns
true.

Definition at line 1327 of file channelLocal.cpp.

◆ message()

void epics::pvDatabase::ChannelLocal::message ( std::string const &  message,
epics::pvData::MessageType  messageType 
)
virtual

Passes the message to the channel requester.

Parameters
messageThe message.
messageTypeThe message type.

Definition at line 1281 of file channelLocal.cpp.

◆ POINTER_DEFINITIONS() [1/2]

epics::pvDatabase::ChannelLocal::POINTER_DEFINITIONS ( ChannelLocal  )

◆ POINTER_DEFINITIONS() [2/2]

epics::pvDatabase::PVRecordClient::POINTER_DEFINITIONS ( PVRecordClient  )
inherited

◆ printInfo() [1/2]

void epics::pvDatabase::ChannelLocal::printInfo ( )
virtual

calls printInfo(std::cout);

Definition at line 1509 of file channelLocal.cpp.

◆ printInfo() [2/2]

void epics::pvDatabase::ChannelLocal::printInfo ( std::ostream &  out)
virtual

displays a message

Parameters
outthe stream on which the message is displayed.

Definition at line 1514 of file channelLocal.cpp.


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