Inheritance diagram for epics::pvAccess::RPCChannel:

Collaboration diagram for epics::pvAccess::RPCChannel:

Public Member Functions
	POINTER_DEFINITIONS (RPCChannel)

	RPCChannel (ChannelProvider::shared_pointer const &provider, string const &channelName, ChannelRequester::shared_pointer const &channelRequester, RPCServiceAsync::shared_pointer const &rpcService)

virtual	~RPCChannel ()

virtual std::tr1::shared_ptr< ChannelProvider >	getProvider ()

virtual std::string	getRemoteAddress ()

virtual ConnectionState	getConnectionState ()

virtual std::string	getChannelName ()

virtual std::tr1::shared_ptr< ChannelRequester >	getChannelRequester ()

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

virtual ChannelRPC::shared_pointer	createChannelRPC (ChannelRPCRequester::shared_pointer const &channelRPCRequester, epics::pvData::PVStructure::shared_pointer const &)

virtual void	printInfo (std::ostream &out)

virtual string	getRequesterName ()

virtual void	destroy ()

Public Member Functions inherited from epics::pvAccess::Channel
	POINTER_DEFINITIONS (Channel)

	Channel ()

virtual	~Channel ()

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

virtual bool	isConnected ()

virtual void	getField (GetFieldRequester::shared_pointer const &requester, std::string const &subField)

virtual ChannelProcess::shared_pointer	createChannelProcess (ChannelProcessRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)

virtual ChannelGet::shared_pointer	createChannelGet (ChannelGetRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)

virtual ChannelPut::shared_pointer	createChannelPut (ChannelPutRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)

virtual ChannelPutGet::shared_pointer	createChannelPutGet (ChannelPutGetRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)

virtual Monitor::shared_pointer	createMonitor (MonitorRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)

virtual ChannelArray::shared_pointer	createChannelArray (ChannelArrayRequester::shared_pointer const &requester, epics::pvData::PVStructure::shared_pointer const &pvRequest)

virtual void	printInfo ()

Public Member Functions inherited from epics::pvAccess::Requester
	POINTER_DEFINITIONS (Requester)

virtual	~Requester ()

virtual void	message (std::string const &message, MessageType messageType=errorMessage)

Public Member Functions inherited from epics::pvAccess::Destroyable
	POINTER_DEFINITIONS (Destroyable)

Additional Inherited Members
Public Types inherited from epics::pvAccess::Channel
enum	ConnectionState { NEVER_CONNECTED, CONNECTED, DISCONNECTED, DESTROYED }

typedef ChannelRequester	requester_type

Static Public Attributes inherited from epics::pvAccess::Channel
static size_t	num_instances

static const char *	ConnectionStateNames [] = { "NEVER_CONNECTED", "CONNECTED", "DISCONNECTED", "DESTROYED" }

Protected Member Functions inherited from epics::pvAccess::Destroyable
virtual	~Destroyable ()

Detailed Description

Definition at line 117 of file rpcServer.cpp.

Constructor & Destructor Documentation

epics::pvAccess::RPCChannel::RPCChannel	(	ChannelProvider::shared_pointer const &	provider,
		string const &	channelName,
		ChannelRequester::shared_pointer const &	channelRequester,
		RPCServiceAsync::shared_pointer const &	rpcService
	)

inline

Definition at line 134 of file rpcServer.cpp.

                                                           :
         m_provider(provider),
         m_channelName(channelName),
         m_channelRequester(channelRequester),
         m_rpcService(rpcService)
     {
     }

virtual epics::pvAccess::RPCChannel::~RPCChannel ( )

inlinevirtual

Definition at line 146 of file rpcServer.cpp.

     {
         destroy();
     }

Member Function Documentation

virtual ChannelRPC::shared_pointer epics::pvAccess::RPCChannel::createChannelRPC	(	ChannelRPCRequester::shared_pointer const &	requester,
		epics::pvData::PVStructure::shared_pointer const &	pvRequest
	)

inlinevirtual

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()

Precondition: The Channel need not be CONNECTED

Postcondition: The returned ChannelRPC will hold a strong reference to the provided ChannelRPCRequester.; Returned shared_ptr<ChannelRPC> will have unique()==true.

Returns: A non-NULL ChannelRPC unless channelRPCConnect() called with an Error

Note: The default implementation yields a not implemented error

Reimplemented from epics::pvAccess::Channel.

Definition at line 184 of file rpcServer.cpp.

     {
         // nothing expected to be in pvRequest
 
         if (channelRPCRequester.get() == 0)
             throw std::invalid_argument("channelRPCRequester == null");
 
         if (m_destroyed.get())
         {
             ChannelRPC::shared_pointer nullPtr;
             channelRPCRequester->channelRPCConnect(epics::pvData::Status(epics::pvData::Status::STATUSTYPE_ERROR, "channel destroyed"), nullPtr);
             return nullPtr;
         }
 
         // TODO use std::make_shared
         std::tr1::shared_ptr<ChannelRPCServiceImpl> tp(
             new ChannelRPCServiceImpl(shared_from_this(), channelRPCRequester, m_rpcService)
         );
         ChannelRPC::shared_pointer channelRPCImpl = tp;
         channelRPCRequester->channelRPCConnect(Status::Ok, channelRPCImpl);
         return channelRPCImpl;
     }

virtual void epics::pvAccess::RPCChannel::destroy ( )

inlinevirtual

Destroy this instance.

Implements epics::pvAccess::Destroyable.

Definition at line 223 of file rpcServer.cpp.

     {
         m_destroyed.set();
     }

virtual AccessRights epics::pvAccess::RPCChannel::getAccessRights ( epics::pvData::PVField::shared_pointer const & pvField )

inlinevirtual

Not useful...

Parameters

pvField The field for which access rights is desired.

Returns: The access rights.

Reimplemented from epics::pvAccess::Channel.

Definition at line 179 of file rpcServer.cpp.

     {
         return none;
     }

virtual std::string epics::pvAccess::RPCChannel::getChannelName ( )

inlinevirtual

The name passed to ChannelProvider::createChannel()

Implements epics::pvAccess::Channel.

Definition at line 169 of file rpcServer.cpp.

     {
         return m_channelName;
     }

virtual std::tr1::shared_ptr<ChannelRequester> epics::pvAccess::RPCChannel::getChannelRequester ( )

inlinevirtual

The ChannelRequester passed to ChannelProvider::createChannel()

Exceptions

std::tr1::bad_weak_ptr

Implements epics::pvAccess::Channel.

Definition at line 174 of file rpcServer.cpp.

     {
         return m_channelRequester;
     }

virtual ConnectionState epics::pvAccess::RPCChannel::getConnectionState ( )

inlinevirtual

Poll the connection state in more detail

Reimplemented from epics::pvAccess::Channel.

Definition at line 162 of file rpcServer.cpp.

     {
         return (!m_destroyed.get()) ?
                Channel::CONNECTED :
                Channel::DESTROYED;
     }

virtual std::tr1::shared_ptr<ChannelProvider> epics::pvAccess::RPCChannel::getProvider ( )

inlinevirtual

The ChannelProvider from which this Channel was requested. May never be NULL.

Implements epics::pvAccess::Channel.

Definition at line 151 of file rpcServer.cpp.

     {
         return m_provider;
     }

virtual std::string epics::pvAccess::RPCChannel::getRemoteAddress ( )

inlinevirtual

Returns the channel's remote address, signal name, etc... For example:

client side channel would return server's address, e.g. "/192.168.1.101:5064"
server side channel would return underlying bus address, e.g. "#C0 S1".

The value returned here will changed depending on the connection status. A disconnected channel should return an empty() string.

Implements epics::pvAccess::Channel.

Definition at line 156 of file rpcServer.cpp.

     {
         // local
         return getChannelName();
     }

virtual string epics::pvAccess::RPCChannel::getRequesterName ( )

inlinevirtual

The requester must have a name.

Returns: The requester's name.

Reimplemented from epics::pvAccess::Channel.

Definition at line 218 of file rpcServer.cpp.

     {
         return getChannelName();
     }

epics::pvAccess::RPCChannel::POINTER_DEFINITIONS ( RPCChannel )

virtual void epics::pvAccess::RPCChannel::printInfo ( std::ostream & out )

inlinevirtual

Prints detailed information about the context to the specified output stream.

Parameters

out	the output stream.

Reimplemented from epics::pvAccess::Channel.

Definition at line 209 of file rpcServer.cpp.

     {
         out << "RPCChannel: ";
         out << getChannelName();
         out << " [";
         out << Channel::ConnectionStateNames[getConnectionState()];
         out << "]";
     }

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

modules/pvAccess/src/rpcService/rpcServer.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation