#include "channel.h"

Inheritance diagram for GWChannel:

Collaboration diagram for GWChannel:

Public Member Functions
	POINTER_DEFINITIONS (GWChannel)

	GWChannel (const ChannelCacheEntry::shared_pointer &e, const epics::pvAccess::ChannelProvider::weak_pointer &srvprov, const requester_type::weak_pointer &, const std::string &addr)

virtual	~GWChannel ()

virtual std::string	getRequesterName ()

virtual void	destroy ()

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

virtual std::string	getRemoteAddress ()

virtual ConnectionState	getConnectionState ()

virtual std::string	getChannelName ()

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

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

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 &channelProcessRequester, epics::pvData::PVStructure::shared_pointer const &pvRequest)

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

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

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

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

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

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

virtual void	printInfo (std::ostream &out)

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 ChannelRPC::shared_pointer	createChannelRPC (ChannelRPCRequester::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)

Public Attributes
weak_pointer	weakref

const ChannelCacheEntry::shared_pointer	entry

const requester_type::weak_pointer	requester

const std::string	address

const epics::pvAccess::ChannelProvider::weak_pointer	server_provder

Static Public Attributes
static size_t	num_instances

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

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

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

typedef ChannelRequester	requester_type

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

Detailed Description

Definition at line 10 of file channel.h.

Constructor & Destructor Documentation

GWChannel::GWChannel	(	const ChannelCacheEntry::shared_pointer &	e,
		const epics::pvAccess::ChannelProvider::weak_pointer &	srvprov,
		const requester_type::weak_pointer &	,
		const std::string &	addr
	)

Definition at line 25 of file channel.cpp.

     :entry(e)
     ,requester(r)
     ,address(addr)
     ,server_provder(srvprov)
 {
     epicsAtomicIncrSizeT(&num_instances);
 }

GWChannel::~GWChannel ( )

virtual

Definition at line 37 of file channel.cpp.

 {
     epicsAtomicDecrSizeT(&num_instances);
 }

Member Function Documentation

pva::ChannelArray::shared_pointer GWChannel::createChannelArray	(	epics::pvAccess::ChannelArrayRequester::shared_pointer const &	channelArrayRequester,
		epics::pvData::PVStructure::shared_pointer const &	pvRequest
	)

virtual

Definition at line 227 of file channel.cpp.

 {
     return entry->channel->createChannelArray(channelArrayRequester, pvRequest);
 }

pva::ChannelGet::shared_pointer GWChannel::createChannelGet	(	epics::pvAccess::ChannelGetRequester::shared_pointer const &	channelGetRequester,
		epics::pvData::PVStructure::shared_pointer const &	pvRequest
	)

virtual

Definition at line 110 of file channel.cpp.

 {
     return entry->channel->createChannelGet(channelGetRequester, pvRequest);
 }

pva::ChannelProcess::shared_pointer GWChannel::createChannelProcess	(	epics::pvAccess::ChannelProcessRequester::shared_pointer const &	channelProcessRequester,
		epics::pvData::PVStructure::shared_pointer const &	pvRequest
	)

virtual

Definition at line 99 of file channel.cpp.

 {
     if(!p2pReadOnly)
         return entry->channel->createChannelProcess(channelProcessRequester, pvRequest);
     else
         return Channel::createChannelProcess(channelProcessRequester, pvRequest);
 }

pva::ChannelPut::shared_pointer GWChannel::createChannelPut	(	epics::pvAccess::ChannelPutRequester::shared_pointer const &	channelPutRequester,
		epics::pvData::PVStructure::shared_pointer const &	pvRequest
	)

virtual

Definition at line 118 of file channel.cpp.

 {
     //TODO: allow ChannelPut::get()
     if(!p2pReadOnly)
         return entry->channel->createChannelPut(channelPutRequester, pvRequest);
     else
         return Channel::createChannelPut(channelPutRequester, pvRequest);
 }

pva::ChannelPutGet::shared_pointer GWChannel::createChannelPutGet	(	epics::pvAccess::ChannelPutGetRequester::shared_pointer const &	channelPutGetRequester,
		epics::pvData::PVStructure::shared_pointer const &	pvRequest
	)

virtual

Definition at line 130 of file channel.cpp.

 {
     if(!p2pReadOnly)
         return entry->channel->createChannelPutGet(channelPutGetRequester, pvRequest);
     else
         return Channel::createChannelPutGet(channelPutGetRequester, pvRequest);
 }

pva::ChannelRPC::shared_pointer GWChannel::createChannelRPC	(	epics::pvAccess::ChannelRPCRequester::shared_pointer const &	channelRPCRequester,
		epics::pvData::PVStructure::shared_pointer const &	pvRequest
	)

virtual

Definition at line 141 of file channel.cpp.

 {
     if(!p2pReadOnly)
         return entry->channel->createChannelRPC(channelRPCRequester, pvRequest);
     else
         return Channel::createChannelRPC(channelRPCRequester, pvRequest);
 }

pvd::Monitor::shared_pointer GWChannel::createMonitor	(	epics::pvData::MonitorRequester::shared_pointer const &	monitorRequester,
		epics::pvData::PVStructure::shared_pointer const &	pvRequest
	)

virtual

Definition at line 158 of file channel.cpp.

 {
     ChannelCacheEntry::pvrequest_t ser;
     // serialize request struct to string using host byte order (only used for local comparison)
     pvd::serializeToVector(pvRequest.get(), EPICS_BYTE_ORDER, ser);
 
     MonitorCacheEntry::shared_pointer ment;
     MonitorUser::shared_pointer mon;
 
     pvd::Status startresult;
     pvd::StructureConstPtr typedesc;
 
     try {
         {
             Guard G(entry->mutex());
 
             // TODO: no-cache/no-share flag in pvRequest
 
             ment = entry->mon_entries.find(ser);
             if(!ment) {
                 ment.reset(new MonitorCacheEntry(entry.get(), pvRequest));
                 entry->mon_entries[ser] = ment; // ref. wrapped
                 ment->weakref = ment;
 
                 // We've added an incomplete entry (no Monitor)
                 // so MonitorUser must check validity before de-ref.
                 // in this case we use !!typedesc as this also indicates
                 // that the upstream monitor is connected
                 pvd::MonitorPtr M;
                 {
                     UnGuard U(G);
 
                     M = entry->channel->createMonitor(ment, pvRequest);
                 }
                 ment->mon = M;
             }
         }
 
         Guard G(ment->mutex());
 
         mon.reset(new MonitorUser(ment));
         ment->interested.insert(mon);
         mon->weakref = mon;
         mon->srvchan = shared_pointer(weakref);
         mon->req = monitorRequester;
 
         typedesc = ment->typedesc;
         startresult = ment->startresult;
 
     } catch(std::exception& e) {
         mon.reset();
         std::cerr<<"Exception in GWChannel::createMonitor()\n"
                    "is "<<e.what()<<"\n";
         startresult = pvd::Status(pvd::Status::STATUSTYPE_FATAL, "Error during GWChannel setup");
     }
 
     // unlock for callback
 
     if(typedesc || !startresult.isSuccess()) {
         // upstream monitor already connected, or never will be.
         monitorRequester->monitorConnect(startresult, mon, typedesc);
     }
 
     return mon;
 }

void GWChannel::destroy ( )

virtual

Destroy this instance.

Implements epics::pvAccess::Destroyable.

Definition at line 49 of file channel.cpp.

50 {}

pva::AccessRights GWChannel::getAccessRights ( epics::pvData::PVField::shared_pointer const & pvField )

virtual

Not useful...

Parameters

pvField The field for which access rights is desired.

Returns: The access rights.

Reimplemented from epics::pvAccess::Channel.

Definition at line 93 of file channel.cpp.

 {
     return entry->channel->getAccessRights(pvField);
 }

std::string GWChannel::getChannelName ( )

virtual

The name passed to ChannelProvider::createChannel()

Implements epics::pvAccess::Channel.

Definition at line 72 of file channel.cpp.

 {
     return entry->channelName;
 }

std::tr1::shared_ptr< pva::ChannelRequester > GWChannel::getChannelRequester ( )

virtual

The ChannelRequester passed to ChannelProvider::createChannel()

Exceptions

std::tr1::bad_weak_ptr

Implements epics::pvAccess::Channel.

Definition at line 78 of file channel.cpp.

 {
     return pva::ChannelRequester::shared_pointer(requester);
 }

pva::Channel::ConnectionState GWChannel::getConnectionState ( )

virtual

Poll the connection state in more detail

Reimplemented from epics::pvAccess::Channel.

Definition at line 66 of file channel.cpp.

 {
     return entry->channel->getConnectionState();
 }

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

virtual

Definition at line 85 of file channel.cpp.

 {
     //TODO: cache for top level field?
     entry->channel->getField(requester, subField);
 }

std::tr1::shared_ptr< pva::ChannelProvider > GWChannel::getProvider ( )

virtual

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

Implements epics::pvAccess::Channel.

Definition at line 53 of file channel.cpp.

 {
     return pva::ChannelProvider::shared_pointer(server_provder);
 }

std::string GWChannel::getRemoteAddress ( )

virtual

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 59 of file channel.cpp.

 {
     // pass through address of origin server (information leak?)
     return entry->channel->getRemoteAddress();
 }

std::string GWChannel::getRequesterName ( )

virtual

The requester must have a name.

Returns: The requester's name.

Reimplemented from epics::pvAccess::Channel.

Definition at line 43 of file channel.cpp.

 {
     return "GWChannel";
 }

GWChannel::POINTER_DEFINITIONS ( GWChannel )

void GWChannel::printInfo ( std::ostream & out )

virtual

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

Parameters

out	the output stream.

Reimplemented from epics::pvAccess::Channel.

Definition at line 236 of file channel.cpp.

 {
     out<<"GWChannel for "<<entry->channelName<<"\n";
 }

Member Data Documentation

const std::string GWChannel::address

Definition at line 18 of file channel.h.

const ChannelCacheEntry::shared_pointer GWChannel::entry

Definition at line 16 of file channel.h.

size_t GWChannel::num_instances

static

Definition at line 13 of file channel.h.

const requester_type::weak_pointer GWChannel::requester

Definition at line 17 of file channel.h.

const epics::pvAccess::ChannelProvider::weak_pointer GWChannel::server_provder

Definition at line 19 of file channel.h.

weak_pointer GWChannel::weakref

Definition at line 14 of file channel.h.

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

modules/pva2pva/p2pApp/channel.h
modules/pva2pva/p2pApp/channel.cpp

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation