gov::fnal::cd::rms::provider::EpicsConnection Class Reference

#include "/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-01-24/rms/cxx/include/provider/EpicsConnection.h"

Inheritance diagram for gov::fnal::cd::rms::provider::EpicsConnection:

Public Member Functions
	EpicsConnection (const std::string applicationName, const int applicationPartition)
	~EpicsConnection ()
bool	supportsDestination (const base::RmsDestination &candidateDestination)
void	sendString (const base::RmsDestination &dest, const std::string &messageString)
void	sendMessage (const base::RmsDestination &dest, const base::RmsMessage &message)
void	addListener (const base::RmsDestination &dest, ProviderListener *listener)
void	removeListener (const base::RmsDestination &dest, ProviderListener *listener)
bool	ping (const base::RmsDestination &pingDestination)
void	close ()
base::RmsDestination	getMessageSource ()
const std::string	getUUID ()

Static Public Attributes
static const std::string	PV_DELIMITER

Protected Attributes
util::UUIDGenerator *	_uuidGenerator
base::RmsDestination	_messageSource

Private Member Functions
std::string	getDestinationPVFromDest (const base::RmsDestination &dest) const
std::string	getMonitoringPVFromDest (const base::RmsDestination &dest) const
EpicsMessenger *	getPVHandle (std::string pvName)

Private Attributes
std::map< std::string, EpicsMessenger * >	_cachedPVs
struct ca_client_context *	_caCurrentContext
boost::mutex	_epicsLock

Detailed Description

Manages the interface to EPICS. Responsibilities include registering listeners with EPICS, creating EpicsMessengers objects when needed to talk to PVs and translating destination objects into PV names.

Author

Kurt Biery

Steve Foulkes

Version

Revision

1.1.1.1

Date

2009/10/09 20:03:00

Definition at line 41 of file EpicsConnection.h.

Constructor & Destructor Documentation

gov::fnal::cd::rms::provider::EpicsConnection::EpicsConnection	(	const std::string	applicationName,
		const int	applicationPartition
	)

Create a new EpicsConnection given the application name and partition.

Parameters

applicationName	The name of the application generating/receiving messages.
applicationPartition	The partition of the application that is generating/receiving messages.

Definition at line 27 of file EpicsConnection.cpp.

References _caCurrentContext, gov::fnal::cd::rms::provider::RmsConnection::_messageSource, gov::fnal::cd::rms::provider::RmsConnection::_uuidGenerator, and gov::fnal::cd::rms::base::RmsDestination::TARGET_PROPERTY_NAME.

                                                                 {
    char hostname[20];

    ca_context_create(ca_enable_preemptive_callback);
    _caCurrentContext = ca_current_context();

    _messageSource.setProperty(base::RmsDestination::TARGET_PROPERTY_NAME, applicationName);
    _messageSource.setPartitionProperty(applicationPartition);

    if (gethostname(hostname, 20) == 0) {
        _uuidGenerator = new util::UUIDGenerator(hostname);
    }
    else {
        _uuidGenerator = new util::UUIDGenerator("C++EpicsConnection");
    }
}

gov::fnal::cd::rms::provider::EpicsConnection::~EpicsConnection

(

)

Destructor, call close() and have it clean up everything.

Definition at line 49 of file EpicsConnection.cpp.

References close().

                                  {
    close();
}

Member Function Documentation

void gov::fnal::cd::rms::provider::EpicsConnection::addListener ( const base::RmsDestination &  dest, ProviderListener *  listener  )

virtual

Add a listener to a particular PV represented by a destination.

Parameters

dest	The destination that we will be listening to.
listener	The listener that will be called when messages are posted to the PV.

If the target is empty, return the PV for the monitoring outbox.

Implements gov::fnal::cd::rms::provider::RmsConnection.

Definition at line 164 of file EpicsConnection.cpp.

References _epicsLock, gov::fnal::cd::rms::provider::EpicsMessenger::addListener(), om::cout, allTimeWatchdog::endl, getDestinationPVFromDest(), getMonitoringPVFromDest(), getPVHandle(), string, and gov::fnal::cd::rms::base::RmsDestination::TARGET_PROPERTY_NAME.

                                                              {
    std::string destinationPV;
    EpicsMessenger *pvHandle;

    /**
     * If the target is empty, return the PV for the monitoring
     * outbox.
     */
    if (dest.getProperty(base::RmsDestination::TARGET_PROPERTY_NAME) != 
        std::string("")) {
        destinationPV = getDestinationPVFromDest(dest);
    } 
    else {
        destinationPV = getMonitoringPVFromDest(dest);
    }

    pvHandle = getPVHandle(destinationPV);
    
    if (pvHandle) {
        boost::mutex::scoped_lock lk(_epicsLock);
        pvHandle->addListener(listener);
    } 
    else {
        std::cout << "Unable to create PV handle for:" << std::endl;
        std::cout << destinationPV << std::endl;
        std::cout << "in EpicsConnection.addListener()" << std::endl;
    }
    
    return;
}

void gov::fnal::cd::rms::provider::EpicsConnection::close ( )

virtual

Free the memory allocated for the UUID generator and delete any instances of the EpicsMessenger class that were created. Finally, call ca_context_destroy().

Implements gov::fnal::cd::rms::provider::RmsConnection.

Definition at line 266 of file EpicsConnection.cpp.

References _cachedPVs, _caCurrentContext, _epicsLock, gov::fnal::cd::rms::provider::RmsConnection::_uuidGenerator, and string.

Referenced by ~EpicsConnection().

                            {
    std::map <std::string, EpicsMessenger *>::iterator cacheIterator;
    
    if (_uuidGenerator) {
        delete _uuidGenerator;
        _uuidGenerator = NULL;
    }

    boost::mutex::scoped_lock lk(_epicsLock);

    cacheIterator = _cachedPVs.begin();

    while (cacheIterator != _cachedPVs.end()) {
        delete cacheIterator->second;
        cacheIterator++;
    }
    
    _cachedPVs.clear();

    if (_caCurrentContext) {
        ca_attach_context(_caCurrentContext);
        ca_context_destroy();
        _caCurrentContext = NULL;
    }
}

std::string gov::fnal::cd::rms::provider::EpicsConnection::getDestinationPVFromDest ( const base::RmsDestination &  dest ) const

private

Translate a destination object into an Epics PV.

Parameters

dest	The destination object that will be translated into a PV.

Returns

The name of the PV for the location that the destination object represents.

The heartbeat channel is a special case. For each target, their will be one heartbeat channel. All heartbeat messages will be pushed out to the outbox.

Definition at line 302 of file EpicsConnection.cpp.

References gov::fnal::cd::rms::base::RmsDestination::CHANNEL_PROPERTY_NAME, gov::fnal::cd::rms::base::RmsDestination::ENVIRONMENT_PROPERTY_NAME, gov::fnal::cd::rms::base::RmsDestination::HEARTBEAT_CHANNEL, gov::fnal::cd::rms::base::RmsDestination::PARTITION_PROPERTY_NAME, PV_DELIMITER, string, and gov::fnal::cd::rms::base::RmsDestination::TARGET_PROPERTY_NAME.

Referenced by addListener(), ping(), removeListener(), sendMessage(), sendString(), and supportsDestination().

                                                                              {
    std::string destinationPV;
    
    std::string destinationTarget = 
        dest.getProperty(base::RmsDestination::TARGET_PROPERTY_NAME);
    std::string destinationChannel = 
        dest.getProperty(base::RmsDestination::CHANNEL_PROPERTY_NAME);
    std::string destinationPartition = 
        dest.getProperty(base::RmsDestination::PARTITION_PROPERTY_NAME);
    std::string destinationEnvironment = 
        dest.getProperty(base::RmsDestination::ENVIRONMENT_PROPERTY_NAME);

    /**
     * The heartbeat channel is a special case.  For each target, their will 
     * be one heartbeat channel.  All heartbeat messages will be pushed out 
     * to the outbox.
     */
    if(destinationChannel == base::RmsDestination::HEARTBEAT_CHANNEL) {
        if (destinationEnvironment != "") {
            destinationPV.append(destinationEnvironment + "_");
        }

        destinationPV.append(destinationTarget);
        destinationPV.append(EpicsConnection::PV_DELIMITER);
        destinationPV.append(destinationChannel);
        destinationPV.append(EpicsConnection::PV_DELIMITER);
        destinationPV.append("outbox");
        return destinationPV;
    }

    if (destinationEnvironment != "") {
        destinationPV.append(destinationEnvironment + "_");
    }
        
    destinationPV.append(destinationTarget);
    destinationPV.append(EpicsConnection::PV_DELIMITER);
    destinationPV.append(destinationPartition);
    destinationPV.append(EpicsConnection::PV_DELIMITER);
    destinationPV.append(destinationChannel);
    destinationPV.append(EpicsConnection::PV_DELIMITER);
    destinationPV.append("inbox");

    return destinationPV;
}

base::RmsDestination gov::fnal::cd::rms::provider::RmsConnection::getMessageSource ( )

inlineinherited

Get a copy of the message source.

Returns

A destination object that contains the source of messages for this connection.

Definition at line 112 of file RmsConnection.h.

References gov::fnal::cd::rms::provider::RmsConnection::_messageSource.

                                          {
        return _messageSource;
    }

std::string gov::fnal::cd::rms::provider::EpicsConnection::getMonitoringPVFromDest ( const base::RmsDestination &  dest ) const

private

Find the name of the monitoring outbox that a message should be posted to when sending to a particular destination.

Parameters

dest	The destination that the message is going to

Returns

This will return the name of the PV for the monitoring outbox that the message should be posted to.

There is no monitoring outbox for the heartbeat channel

Definition at line 357 of file EpicsConnection.cpp.

References gov::fnal::cd::rms::base::RmsDestination::CHANNEL_PROPERTY_NAME, gov::fnal::cd::rms::base::RmsDestination::ENVIRONMENT_PROPERTY_NAME, gov::fnal::cd::rms::base::RmsDestination::HEARTBEAT_CHANNEL, gov::fnal::cd::rms::base::RmsDestination::PARTITION_PROPERTY_NAME, PV_DELIMITER, gov::fnal::cd::rms::base::RmsDestination::SOURCE_PROPERTY_NAME, string, and gov::fnal::cd::rms::base::RmsDestination::TARGET_PROPERTY_NAME.

Referenced by addListener(), removeListener(), sendMessage(), and supportsDestination().

                                                                             {
    std::string targetName = 
        dest.getProperty(base::RmsDestination::TARGET_PROPERTY_NAME);
    std::string destinationPartition = 
        dest.getProperty(base::RmsDestination::PARTITION_PROPERTY_NAME);
   std::string destinationChannel = 
        dest.getProperty(base::RmsDestination::CHANNEL_PROPERTY_NAME);

    /**
     * There is no monitoring outbox for the heartbeat channel
     */
    if (destinationChannel == base::RmsDestination::HEARTBEAT_CHANNEL) {
        return std::string("");
    }

    if (targetName == std::string("")) {
        targetName = dest.getProperty(base::RmsDestination::SOURCE_PROPERTY_NAME);
    }

    targetName.append(EpicsConnection::PV_DELIMITER);
    targetName.append(destinationPartition);
    targetName.append(EpicsConnection::PV_DELIMITER);
    targetName.append(destinationChannel);
    targetName.append(EpicsConnection::PV_DELIMITER);
    targetName.append("monitoringOutbox");
    
    std::string destinationEnvironment = 
        dest.getProperty(base::RmsDestination::ENVIRONMENT_PROPERTY_NAME);

    if (destinationEnvironment != "") {
        targetName.insert(0, destinationEnvironment + "_");
    }

    return targetName;
}

EpicsMessenger * gov::fnal::cd::rms::provider::EpicsConnection::getPVHandle ( std::string  pvName )

private

Obtain a handle to a particular PV. If the handle has already been created, find it in the _cachedPVs table and return it. Otherwise, create a new one and insert it into the _cachedPVs table.

Parameters

pvName

The name of the PV to get a handle for.

Returns

An EpicsMessenger for a particular PV.

Definition at line 403 of file EpicsConnection.cpp.

References _cachedPVs, _caCurrentContext, _epicsLock, and gov::fnal::cd::rms::provider::RmsConnection::_uuidGenerator.

Referenced by addListener(), removeListener(), sendMessage(), sendString(), and supportsDestination().

                                                             {
    EpicsMessenger *pvHandle;
    std::map <std::string, EpicsMessenger *>::iterator cacheIterator;

    boost::mutex::scoped_lock lk(_epicsLock);

    cacheIterator = _cachedPVs.find(pvName);

    if (cacheIterator == _cachedPVs.end()) {
        pvHandle = 
            new EpicsMessenger(pvName, _caCurrentContext, 
                               1024, _uuidGenerator);
        _cachedPVs.insert(std::pair<std::string, EpicsMessenger *>
                          (pvName, pvHandle));
    }
    else {
        return cacheIterator->second;
    }

    return pvHandle;
}

const std::string gov::fnal::cd::rms::provider::RmsConnection::getUUID ( )

inlineinherited

Get a new human readbale UUID from the UUID generator.

Returns

A new UUID.

Definition at line 121 of file RmsConnection.h.

References gov::fnal::cd::rms::provider::RmsConnection::_uuidGenerator, gov::fnal::cd::rms::provider::RmsConnection::close(), and gov::fnal::cd::rms::util::UUIDGenerator::getUUIDHex().

                              {
        return _uuidGenerator->getUUIDHex();
    }

bool gov::fnal::cd::rms::provider::EpicsConnection::ping ( const base::RmsDestination &  pingDestination )

virtual

Try to connect to a PV to verify that it exists and is runing.

Parameters

pingDestination

The destination that we are going to ping.

Returns

True is the PV exists and is running, false otherwise.

Implements gov::fnal::cd::rms::provider::RmsConnection.

Definition at line 241 of file EpicsConnection.cpp.

References _caCurrentContext, _epicsLock, getDestinationPVFromDest(), fillBadChanDBTables::result, and string.

                                                                    {
    chid channelID;
    int result;

    std::string destinationPV = getDestinationPVFromDest(pingDestination);

    boost::mutex::scoped_lock lk(_epicsLock);
    ca_attach_context(_caCurrentContext);

    ca_create_channel(destinationPV.c_str(), NULL, NULL, 10, &channelID);
    result = ca_pend_io(0.5);
    ca_clear_channel(channelID);

    if (result != ECA_NORMAL) {
        return false;
    }

    return true;
}

void gov::fnal::cd::rms::provider::EpicsConnection::removeListener ( const base::RmsDestination &  dest, ProviderListener *  listener  )

virtual

Remove a listener from the EpicsConnection so that it no longer receives messages.

Parameters

dest	The destination to remove.
listener	The listener to remove.

If the target is empty, return the PV for the monitoring outbox.

Implements gov::fnal::cd::rms::provider::RmsConnection.

Definition at line 203 of file EpicsConnection.cpp.

References _epicsLock, om::cout, allTimeWatchdog::endl, getDestinationPVFromDest(), getMonitoringPVFromDest(), getPVHandle(), gov::fnal::cd::rms::provider::EpicsMessenger::removeListener(), string, and gov::fnal::cd::rms::base::RmsDestination::TARGET_PROPERTY_NAME.

                                                                                               {
    std::string destinationPV;
    EpicsMessenger *pvHandle;

    /**
     * If the target is empty, return the PV for the monitoring
     * outbox.
     */
    if (dest.getProperty(base::RmsDestination::TARGET_PROPERTY_NAME) != 
        std::string("")) {
        destinationPV = getDestinationPVFromDest(dest);
    } 
    else {
        destinationPV = getMonitoringPVFromDest(dest);
    }
    
    pvHandle = getPVHandle(destinationPV);
    
    if (pvHandle) {
        boost::mutex::scoped_lock lk(_epicsLock);
        pvHandle->removeListener(listener);
    } 
    else {
        std::cout << "Unable to create PV handle for:" << std::endl;
        std::cout << destinationPV << std::endl;
        std::cout << "in EpicsConnection.removeListener()" << std::endl;
    }
    
    return;
}

void gov::fnal::cd::rms::provider::EpicsConnection::sendMessage ( const base::RmsDestination &  dest, const base::RmsMessage &  message  )

virtual

Send an RmsMessage to a particular destination.

Parameters

dest	The destination that the message is going to
message	The RmsMessage that is being sent

Implements gov::fnal::cd::rms::provider::RmsConnection.

Definition at line 118 of file EpicsConnection.cpp.

References _epicsLock, om::cout, allTimeWatchdog::endl, getDestinationPVFromDest(), getMonitoringPVFromDest(), getPVHandle(), gov::fnal::cd::rms::provider::EpicsMessenger::sendMessage(), and string.

                                                                 {
    std::string destinationPV;
    std::string monitoringOutboxPV;
    EpicsMessenger *pvHandle;
   
    destinationPV = getDestinationPVFromDest(dest);
    monitoringOutboxPV = getMonitoringPVFromDest(message.getReplyDestination());
    std::string serializedMessage = message.serialize();

    pvHandle = getPVHandle(destinationPV);

    if (pvHandle) {
        boost::mutex::scoped_lock lk(_epicsLock);
        pvHandle->sendMessage(serializedMessage);
    }
    else {
        std::cout << "Unable to create PV handler for:" << std::endl;
        std::cout << destinationPV << std::endl;
        std::cout << "in EpicsConnection.sendMessage()" << std::endl;
        return;
    }

    pvHandle = getPVHandle(monitoringOutboxPV);

    if (pvHandle) {
        boost::mutex::scoped_lock lk(_epicsLock);
        pvHandle->sendMessage(serializedMessage);
    }
    else {
        std::cout << "Unable to create PV handler for:" << std::endl;
        std::cout << monitoringOutboxPV << std::endl;
        std::cout << "in EpicsConnection.sendMessage()" << std::endl;
        return;
    }

    return;
}

void gov::fnal::cd::rms::provider::EpicsConnection::sendString ( const base::RmsDestination &  dest, const std::string &  messageString  )

virtual

Send a string to a particular destination.

Parameters

dest	The destination that the message is going to
messageString	The string that is being sent

Implements gov::fnal::cd::rms::provider::RmsConnection.

Definition at line 91 of file EpicsConnection.cpp.

References _epicsLock, om::cout, allTimeWatchdog::endl, getDestinationPVFromDest(), getPVHandle(), gov::fnal::cd::rms::provider::EpicsMessenger::sendMessage(), and string.

                                                                 {
    std::string destinationPV;
    EpicsMessenger *pvHandle;
    
    destinationPV = getDestinationPVFromDest(dest);
    pvHandle = getPVHandle(destinationPV);

    if (pvHandle) {
        boost::mutex::scoped_lock lk(_epicsLock);
        pvHandle->sendMessage(messageString);
    }
    else {
        std::cout << "Unable to create PV handler for:" << std::endl;
        std::cout << destinationPV << std::endl;
        std::cout << "in EpicsConnection.sendMessage()" << std::endl;
    }

    return;
}

bool gov::fnal::cd::rms::provider::EpicsConnection::supportsDestination ( const base::RmsDestination &  dest )

virtual

Determine if the given destination can be reached with the EPICS provider.

Parameters

dest	The destination to check to see if messages can be sent to it.

Returns

True if the destination can be reached, false otherwise.

Implements gov::fnal::cd::rms::provider::RmsConnection.

Definition at line 62 of file EpicsConnection.cpp.

References getDestinationPVFromDest(), getMonitoringPVFromDest(), getPVHandle(), and string.

                                                                        {
    std::string destinationPV;
    std::string monitoringOutboxPV;
    EpicsMessenger *pvHandle;
    
    destinationPV = getDestinationPVFromDest(dest);
    monitoringOutboxPV = getMonitoringPVFromDest(dest);

    pvHandle = getPVHandle(destinationPV);

    if (!pvHandle) {
        return false;
    }

    pvHandle = getPVHandle(monitoringOutboxPV);

    if (!pvHandle) {
        return false;
    }

    return true;
}

Member Data Documentation

std::map<std::string, EpicsMessenger *> gov::fnal::cd::rms::provider::EpicsConnection::_cachedPVs

private

A set of handles to PVs that have been used.

Definition at line 67 of file EpicsConnection.h.

Referenced by close(), and getPVHandle().

struct ca_client_context* gov::fnal::cd::rms::provider::EpicsConnection::_caCurrentContext

private

The EPICS context.

Definition at line 72 of file EpicsConnection.h.

Referenced by close(), EpicsConnection(), getPVHandle(), and ping().

boost::mutex gov::fnal::cd::rms::provider::EpicsConnection::_epicsLock

private

Lock for the EPICS code as EpicsMessenger is not thread safe.

Definition at line 78 of file EpicsConnection.h.

Referenced by addListener(), close(), getPVHandle(), ping(), removeListener(), sendMessage(), and sendString().

base::RmsDestination gov::fnal::cd::rms::provider::RmsConnection::_messageSource

protectedinherited

A destination to hold the application name and application partition that is passed into the constructor.

Definition at line 141 of file RmsConnection.h.

Referenced by EpicsConnection(), gov::fnal::cd::rms::provider::RmsConnection::getMessageSource(), and gov::fnal::cd::rms::provider::LocalhostConnection::LocalhostConnection().

util::UUIDGenerator* gov::fnal::cd::rms::provider::RmsConnection::_uuidGenerator

protectedinherited

All providers will need to generate UUIDs.

Definition at line 135 of file RmsConnection.h.

Referenced by close(), EpicsConnection(), getPVHandle(), gov::fnal::cd::rms::provider::RmsConnection::getUUID(), and gov::fnal::cd::rms::provider::LocalhostConnection::LocalhostConnection().

const std::string gov::fnal::cd::rms::provider::EpicsConnection::PV_DELIMITER

static

The character that is to be used as a delimiter in PV names.

The character that is used a delimiter is PV names.

Definition at line 47 of file EpicsConnection.h.

Referenced by getDestinationPVFromDest(), and getMonitoringPVFromDest().

---

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

• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-01-24/rms/cxx/include/provider/EpicsConnection.h
• /cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-01-24/rms/cxx/src/provider/EpicsConnection.cpp