epics::pvAccess::ca::CAChannel Class Reference

#include "caChannel.h"

Inheritance diagram for epics::pvAccess::ca::CAChannel:

Collaboration diagram for epics::pvAccess::ca::CAChannel:

Public Member Functions
	POINTER_DEFINITIONS (CAChannel)
virtual	~CAChannel ()
chid	getChannelID ()
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 void	getField (GetFieldRequester::shared_pointer const &requester, std::string const &subField)
virtual AccessRights	getAccessRights (epics::pvData::PVField::shared_pointer const &pvField)
virtual ChannelGet::shared_pointer	createChannelGet (ChannelGetRequester::shared_pointer const &channelGetRequester, epics::pvData::PVStructurePtr const &pvRequest)
virtual ChannelPut::shared_pointer	createChannelPut (ChannelPutRequester::shared_pointer const &channelPutRequester, epics::pvData::PVStructurePtr const &pvRequest)
virtual Monitor::shared_pointer	createMonitor (MonitorRequester::shared_pointer const &monitorRequester, epics::pvData::PVStructurePtr const &pvRequest)
virtual void	printInfo (std::ostream &out)
void	attachContext ()
void	disconnectChannel ()
void	connect (bool isConnected)
void	notifyClient ()
Public Member Functions inherited from epics::pvAccess::Channel
	POINTER_DEFINITIONS (Channel)
	Channel ()
virtual	~Channel ()
virtual std::string	getRequesterName ()
virtual void	message (std::string const &message, epics::pvData::MessageType messageType)
virtual bool	isConnected ()
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)

Static Public Member Functions
static CAChannelPtr	create (CAChannelProvider::shared_pointer const &channelProvider, std::string const &channelName, short priority, ChannelRequester::shared_pointer const &channelRequester)

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 88 of file caChannel.h.

Constructor & Destructor Documentation

epics::pvAccess::ca::CAChannel::~CAChannel ( )

virtual

Definition at line 162 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>0) {
        cout << "CAChannel::~CAChannel() " << channelName
             << " channelCreated " << (channelCreated ? "true" : "false")
             << endl;
    }
    {
        Lock lock(requestsMutex);
        if(!channelCreated) return;
    }
    disconnectChannel();
}

Member Function Documentation

void epics::pvAccess::ca::CAChannel::attachContext

(

)

Definition at line 424 of file caChannel.cpp.

{
    CAChannelProviderPtr provider(channelProvider.lock());
    if(provider) {
        std::tr1::static_pointer_cast<CAChannelProvider>(provider)->attachContext();
        return;
    }
    string mess("CAChannel::attachContext provider does not exist ");
    mess += getChannelName();
    throw  std::runtime_error(mess);
}

void epics::pvAccess::ca::CAChannel::connect

(

bool

isConnected

)

Definition at line 61 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>0) {
          cout<< "CAChannel::connect " << channelName << endl;
    }
    {
         Lock lock(requestsMutex);
         channelConnected = isConnected;
    }
    channelConnectThread->channelConnected(notifyChannelRequester);
}

CAChannel::shared_pointer epics::pvAccess::ca::CAChannel::create ( CAChannelProvider::shared_pointer const &  channelProvider, std::string const &  channelName, short  priority, ChannelRequester::shared_pointer const &  channelRequester  )

static

Definition at line 36 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>0) {
          cout<< "CAChannel::create " << channelName << endl;
    }
    CAChannelPtr caChannel(
        new CAChannel(channelName, channelProvider, channelRequester));
    caChannel->activate(priority);
    return caChannel;
}

ChannelGet::shared_pointer epics::pvAccess::ca::CAChannel::createChannelGet ( ChannelGetRequester::shared_pointer const &  channelGetRequester, epics::pvData::PVStructurePtr const &  pvRequest  )

virtual

Definition at line 281 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>0) {
        cout << "CAChannel::createChannelGet " << channelName << endl;
    }
    CAChannelGetPtr channelGet =
        CAChannelGet::create(shared_from_this(), channelGetRequester, pvRequest);
    {
         Lock lock(requestsMutex);
         if(getConnectionState()!=Channel::CONNECTED) {
              getQueue.push(channelGet);
              return channelGet;
         }
    }
    channelGet->activate();
    return channelGet;
}

ChannelPut::shared_pointer epics::pvAccess::ca::CAChannel::createChannelPut ( ChannelPutRequester::shared_pointer const &  channelPutRequester, epics::pvData::PVStructurePtr const &  pvRequest  )

virtual

Definition at line 302 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>0) {
        cout << "CAChannel::createChannelPut " << channelName << endl;
    }
    CAChannelPutPtr channelPut =
        CAChannelPut::create(shared_from_this(), channelPutRequester, pvRequest);
    {
         Lock lock(requestsMutex);
         if(getConnectionState()!=Channel::CONNECTED) {
              putQueue.push(channelPut);
              return channelPut;
         }
    }
    channelPut->activate();
    return channelPut;
}

Monitor::shared_pointer epics::pvAccess::ca::CAChannel::createMonitor ( MonitorRequester::shared_pointer const &  monitorRequester, epics::pvData::PVStructurePtr const &  pvRequest  )

virtual

Definition at line 323 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>0) {
        cout << "CAChannel::createMonitor " << channelName << endl;
    }
    CAChannelMonitorPtr channelMonitor =
        CAChannelMonitor::create(shared_from_this(), monitorRequester, pvRequest);
    {
         Lock lock(requestsMutex);
         if(getConnectionState()!=Channel::CONNECTED) {
              monitorQueue.push(channelMonitor);
              return channelMonitor;
         }
    }
    channelMonitor->activate();
    addMonitor(channelMonitor);
    return channelMonitor;
}

void epics::pvAccess::ca::CAChannel::disconnectChannel

(

)

Definition at line 176 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>0) {
        cout << "CAChannel::disconnectChannel() "
             << channelName
             << " channelCreated " << (channelCreated ? "true" : "false")
             << endl;
    }
    {
        Lock lock(requestsMutex);
        if(!channelCreated) return;
        channelCreated = false;
    }
    std::vector<CAChannelMonitorWPtr>::iterator it;
    for(it = monitorlist.begin(); it!=monitorlist.end(); ++it)
    {
         CAChannelMonitorPtr mon = (*it).lock();
         if(!mon) continue;
         mon->stop();
    }
    monitorlist.resize(0);
    /* Clear CA Channel */
    CAChannelProviderPtr provider(channelProvider.lock());
    if(provider) {
        std::tr1::static_pointer_cast<CAChannelProvider>(provider)->attachContext();
    }
    int result = ca_clear_channel(channelID);
    if (result == ECA_NORMAL) return;
    string mess("CAChannel::disconnectChannel() ");
    mess += ca_message(result);
    cerr << mess << endl;
}

AccessRights epics::pvAccess::ca::CAChannel::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 270 of file caChannel.cpp.

{
    if (ca_write_access(channelID))
        return readWrite;
    else if (ca_read_access(channelID))
        return read;
    else
        return none;
}

chid epics::pvAccess::ca::CAChannel::getChannelID

(

)

Definition at line 209 of file caChannel.cpp.

{
    return channelID;
}

std::string epics::pvAccess::ca::CAChannel::getChannelName ( )

virtual

The name passed to ChannelProvider::createChannel()

Implements epics::pvAccess::Channel.

Definition at line 240 of file caChannel.cpp.

{
    return channelName;
}

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

virtual

The ChannelRequester passed to ChannelProvider::createChannel()

Exceptions

std::tr1::bad_weak_ptr

Implements epics::pvAccess::Channel.

Definition at line 246 of file caChannel.cpp.

{
    return channelRequester.lock();
}

Channel::ConnectionState epics::pvAccess::ca::CAChannel::getConnectionState ( )

virtual

Poll the connection state in more detail

Reimplemented from epics::pvAccess::Channel.

Definition at line 234 of file caChannel.cpp.

{
    return cs2CS[ca_state(channelID)];
}

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

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.

Parameters

Requester	The Requester.
subField	Empty string, or the field name of a sub-structure.

Reimplemented from epics::pvAccess::Channel.

Definition at line 251 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>0) {
        cout << "CAChannel::getField " << channelName << endl;
    }
    CAChannelGetFieldPtr getField(
         new CAChannelGetField(shared_from_this(),requester,subField));
    {
         Lock lock(requestsMutex);
         if(getConnectionState()!=Channel::CONNECTED) {
             getFieldQueue.push(getField);
             return;
         }
     }
     getField->callRequester(shared_from_this());
}

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

virtual

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

Implements epics::pvAccess::Channel.

Definition at line 214 of file caChannel.cpp.

{
    return channelProvider.lock();
}

std::string epics::pvAccess::ca::CAChannel::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 220 of file caChannel.cpp.

{
    return std::string(ca_host_name(channelID));
}

void epics::pvAccess::ca::CAChannel::notifyClient

(

)

Definition at line 73 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>0) {
          cout<< "CAChannel::notifyClient " << channelName << endl;
    }
    CAChannelProviderPtr provider(channelProvider.lock());
    if(!provider) return;
    bool isConnected = false;
    {
         Lock lock(requestsMutex);
         isConnected = channelConnected;
    }
    if(!isConnected) {
        ChannelRequester::shared_pointer req(channelRequester.lock());
        if(req) {
            EXCEPTION_GUARD(req->channelStateChange(
                shared_from_this(), Channel::DISCONNECTED));
        }
        return;
    }
    while(!getFieldQueue.empty()) {
        getFieldQueue.front()->activate();
        getFieldQueue.pop();
    }
    while(!putQueue.empty()) {
        putQueue.front()->activate();
        putQueue.pop();
    }
    while(!getQueue.empty()) {
        getQueue.front()->activate();
        getQueue.pop();
    }
    while(!monitorQueue.empty()) {
        CAChannelMonitorPtr monitor(monitorQueue.front());
        monitor->activate();
        addMonitor(monitor);
        monitorQueue.pop();
    }
    ChannelRequester::shared_pointer req(channelRequester.lock());
    if(req) {
        EXCEPTION_GUARD(req->channelStateChange(
             shared_from_this(), Channel::CONNECTED));
    }
}

epics::pvAccess::ca::CAChannel::POINTER_DEFINITIONS

(

CAChannel

)

void epics::pvAccess::ca::CAChannel::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 357 of file caChannel.cpp.

{
    out << "CHANNEL  : " << getChannelName() << std::endl;

    ConnectionState state = getConnectionState();
    out << "STATE    : " << ConnectionStateNames[state] << std::endl;
    if (state == CONNECTED)
    {
        out << "ADDRESS  : " << getRemoteAddress() << std::endl;
        //out << "RIGHTS   : " << getAccessRights() << std::endl;
    }
}

---

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

• modules/pvAccess/src/ca/caChannel.h
• modules/pvAccess/src/ca/caChannel.cpp