epics::pvaClient::PvaClientMonitor Class Reference

An easy to use alternative to Monitor. More...

#include "pvaClient.h"

Inheritance diagram for epics::pvaClient::PvaClientMonitor:

Collaboration diagram for epics::pvaClient::PvaClientMonitor:

Public Member Functions
	POINTER_DEFINITIONS (PvaClientMonitor)
	~PvaClientMonitor ()
	Destructor. More...
void	connect ()
	Call issueConnect and then waitConnect. More...
void	issueConnect ()
	Issue the channelMonitor connection to the channel. More...
epics::pvData::Status	waitConnect ()
	Wait until the channelMonitor connection to the channel is complete. More...
void	setRequester (PvaClientMonitorRequesterPtr const &pvaClientMonitorRequester)
	Set a user callback. More...
void	start ()
	Start monitoring. More...
void	start (const std::string &request)
	Start or restart the monitor with a new request. More...
void	stop ()
	Stop monitoring. More...
bool	poll ()
	Poll for a monitor event. More...
bool	waitEvent (double secondsToWait=0.0)
	Wait for a monitor event. More...
void	releaseEvent ()
	Release the monitorElement returned by poll. More...
PvaClientChannelPtr	getPvaClientChannel ()
	Get the PvaClientChannel;. More...
PvaClientMonitorDataPtr	getData ()
	The data in which monitor events are placed. More...
void	channelStateChange (PvaClientChannelPtr const &channel, bool isConnected)
	A channel connection state change has occurred. More...
void	event (PvaClientMonitorPtr const &monitor)
	A monitor event has occurred. More...
Public Member Functions inherited from epics::pvaClient::PvaClientChannelStateChangeRequester
	POINTER_DEFINITIONS (PvaClientChannelStateChangeRequester)
virtual	~PvaClientChannelStateChangeRequester ()
Public Member Functions inherited from epics::pvaClient::PvaClientMonitorRequester
	POINTER_DEFINITIONS (PvaClientMonitorRequester)
virtual void	monitorConnect (epics::pvData::Status const &status, PvaClientMonitorPtr const &monitor, epics::pvData::StructureConstPtr const &structure)
	The server has returned a message that the monitor is connected. More...
virtual	~PvaClientMonitorRequester ()
virtual void	unlisten ()
	The data source is no longer available. More...

Static Public Member Functions
static PvaClientMonitorPtr	create (PvaClientPtr const &pvaClient, PvaClientChannelPtr const &pvaClientChannel, epics::pvData::PVStructurePtr const &pvRequest)
	Create a PvaClientMonitor. More...
static PvaClientMonitorPtr	create (PvaClientPtr const &pvaClient, std::string const &channelName, std::string const &providerName, std::string const &request, PvaClientChannelStateChangeRequesterPtr const &stateChangeRequester=PvaClientChannelStateChangeRequesterPtr(), PvaClientMonitorRequesterPtr const &monitorRequester=PvaClientMonitorRequesterPtr()) EPICS_DEPRECATED
	Create a PvaClientMonitor. More...

Friends
class	MonitorRequesterImpl

Detailed Description

An easy to use alternative to Monitor.

Overview of PvaClientMonitor

Definition at line 1561 of file pvaClient.h.

Constructor & Destructor Documentation

epics::pvaClient::PvaClientMonitor::~PvaClientMonitor

(

)

Destructor.

Definition at line 139 of file pvaClientMonitor.cpp.

{
    if(PvaClient::getDebug()) {
        cout<< "PvaClientMonitor::~PvaClientMonitor"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    if(monitor) {
       if(isStarted) monitor->stop();
    }
}

Member Function Documentation

void epics::pvaClient::PvaClientMonitor::channelStateChange ( PvaClientChannelPtr const &  channel, bool  isConnected  )

virtual

A channel connection state change has occurred.

Warning A call to a method that blocks should not be made by this method.

Parameters

channel	The channel.
isConnected	The new connection status.

Implements epics::pvaClient::PvaClientChannelStateChangeRequester.

Definition at line 151 of file pvaClientMonitor.cpp.

{
    if(PvaClient::getDebug()) {
           cout<< "PvaClientMonitor::channelStateChange"
               << " channelName " << channel->getChannelName()
               << " isConnected " << (isConnected ? "true" : "false")
               << endl;
    }
    if(isConnected&&!monitor)
    {
        connectState = connectActive;
        monitor = pvaClientChannel->getChannel()->createMonitor(monitorRequester,pvRequest);
    }
    PvaClientChannelStateChangeRequesterPtr req(pvaClientChannelStateChangeRequester.lock());
    if(req) {
          req->channelStateChange(channel,isConnected);
    }
}

void epics::pvaClient::PvaClientMonitor::connect

(

)

Call issueConnect and then waitConnect.

An exception is thrown if connect fails.

Definition at line 297 of file pvaClientMonitor.cpp.

{
    if(PvaClient::getDebug()) cout << "PvaClientMonitor::connect\n";
    issueConnect();
    Status status = waitConnect();
    if(status.isOK()) return;
    string message = string("channel ")
        + pvaClientChannel->getChannel()->getChannelName()
        + " PvaClientMonitor::connect "
        + status.getMessage();
    throw std::runtime_error(message);
}

PvaClientMonitorPtr epics::pvaClient::PvaClientMonitor::create ( PvaClientPtr const &  pvaClient, PvaClientChannelPtr const &  pvaClientChannel, epics::pvData::PVStructurePtr const &  pvRequest  )

static

Create a PvaClientMonitor.

Parameters

pvaClient	Interface to PvaClient
pvaClientChannel	Interface to PvaClientChannel
pvRequest	The request structure.

Returns

The interface to the PvaClientMonitor.

Definition at line 79 of file pvaClientMonitor.cpp.

{
    PvaClientMonitorPtr clientMonitor(new PvaClientMonitor(pvaClient,pvaClientChannel,pvRequest));
    clientMonitor->monitorRequester = MonitorRequesterImplPtr(
        new MonitorRequesterImpl(clientMonitor,pvaClient));
    return clientMonitor;
}

PvaClientMonitorPtr epics::pvaClient::PvaClientMonitor::create ( PvaClientPtr const &  pvaClient, std::string const &  channelName, std::string const &  providerName, std::string const &  request, PvaClientChannelStateChangeRequesterPtr const &  stateChangeRequester = PvaClientChannelStateChangeRequesterPtr(), PvaClientMonitorRequesterPtr const &  monitorRequester = PvaClientMonitorRequesterPtr()  )

static

Create a PvaClientMonitor.

Parameters

pvaClient	Interface to PvaClient
channelName	channel name
providerName	provider name
request	The request.
stateChangeRequester	The state change requester. Can be null.
monitorRequester	The monitor requester. Can be null;

Returns

The new instance.

Deprecated:

client can create PvaClientMonitor on first channel connect.

Definition at line 90 of file pvaClientMonitor.cpp.

{
    if(PvaClient::getDebug()) {
         cout<< "PvaClientMonitor::create(pvaClient,channelName,providerName,request,stateChangeRequester,monitorRequester)\n"
             << " channelName " <<  channelName
             << " providerName " <<  providerName
             << " request " << request
             << endl;
    }
    CreateRequest::shared_pointer createRequest(CreateRequest::create());
    PVStructurePtr pvRequest(createRequest->createRequest(request));
    if(!pvRequest) throw std::runtime_error(createRequest->getMessage());
    PvaClientChannelPtr pvaClientChannel = pvaClient->createChannel(channelName,providerName);
    PvaClientMonitorPtr clientMonitor(new PvaClientMonitor(pvaClient,pvaClientChannel,pvRequest));
    clientMonitor->monitorRequester = MonitorRequesterImplPtr(
        new MonitorRequesterImpl(clientMonitor,pvaClient));
    if(stateChangeRequester) clientMonitor->pvaClientChannelStateChangeRequester = stateChangeRequester;
    if(monitorRequester) clientMonitor->pvaClientMonitorRequester = monitorRequester;
    pvaClientChannel->setStateChangeRequester(clientMonitor);
    pvaClientChannel->issueConnect();
    return clientMonitor;
}

void epics::pvaClient::PvaClientMonitor::event ( PvaClientMonitorPtr const &  monitor )

virtual

A monitor event has occurred.

Parameters

monitor

The PvaClientMonitor that received the event.

Implements epics::pvaClient::PvaClientMonitorRequester.

Definition at line 170 of file pvaClientMonitor.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientMonitor::event"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    PvaClientMonitorRequesterPtr req(pvaClientMonitorRequester.lock());
    if(req) req->event(monitor);
}

PvaClientMonitorDataPtr epics::pvaClient::PvaClientMonitor::getData

(

)

The data in which monitor events are placed.

Returns

The interface.

Definition at line 488 of file pvaClientMonitor.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientMonitor::getData"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    checkMonitorState();
    return pvaClientData;
}

PvaClientChannelPtr epics::pvaClient::PvaClientMonitor::getPvaClientChannel

(

)

Get the PvaClientChannel;.

Returns

The interface.

Definition at line 483 of file pvaClientMonitor.cpp.

{
    return pvaClientChannel;
}

void epics::pvaClient::PvaClientMonitor::issueConnect

(

)

Issue the channelMonitor connection to the channel.

This can only be called once. An exception is thrown if connect fails.

Exceptions

runtime_error

if failure.

Definition at line 310 of file pvaClientMonitor.cpp.

{
    if(PvaClient::getDebug()) cout << "PvaClientMonitor::issueConnect\n";
    if(connectState!=connectIdle) {
        string message = string("channel ")
            + pvaClientChannel->getChannel()->getChannelName()
            + " pvaClientMonitor already connected ";
        throw std::runtime_error(message);
    }
    connectState = connectWait;
    monitor = pvaClientChannel->getChannel()->createMonitor(monitorRequester,pvRequest);
}

epics::pvaClient::PvaClientMonitor::POINTER_DEFINITIONS

(

PvaClientMonitor

)

bool epics::pvaClient::PvaClientMonitor::poll

(

)

Poll for a monitor event.

The data will be in PvaClientData.

Returns

(false,true) means event (did not, did) occur.

Definition at line 429 of file pvaClientMonitor.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientMonitor::poll"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    checkMonitorState();
    monitorElement = monitor->poll();
    if(!monitorElement) return false;
    userPoll = true;
    pvaClientData->setData(monitorElement);
   return true;
}

void epics::pvaClient::PvaClientMonitor::releaseEvent

(

)

Release the monitorElement returned by poll.

Definition at line 467 of file pvaClientMonitor.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientMonitor::releaseEvent"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    if(!userPoll) {
        string message = string("channel ") + pvaClientChannel->getChannel()->getChannelName()
            + " PvaClientMonitor::releaseEvent did not call poll";
        throw std::runtime_error(message);
    }
    userPoll = false;
    monitor->release(monitorElement);
}

void epics::pvaClient::PvaClientMonitor::setRequester

(

PvaClientMonitorRequesterPtr const &

pvaClientMonitorRequester

)

Set a user callback.

Parameters

pvaClientMonitorRequester

The requester which must be implemented by the caller.

Definition at line 352 of file pvaClientMonitor.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientMonitor::setRequester"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    this->pvaClientMonitorRequester = pvaClientMonitorRequester;
}

void epics::pvaClient::PvaClientMonitor::start

(

)

Start monitoring.

Definition at line 362 of file pvaClientMonitor.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientMonitor::start"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << " connectState " << connectState
           << endl;
    }
    if(isStarted) {
        return;
    }
    if(connectState==connectIdle) connect();
    if(connectState!=connected) {
        string message = string("channel ") + pvaClientChannel->getChannel()->getChannelName()
            + " PvaClientMonitor::start illegal state ";
        throw std::runtime_error(message);
    }
    isStarted = true;
    monitor->start();
}

void epics::pvaClient::PvaClientMonitor::start

(

const std::string &

request

)

Start or restart the monitor with a new request.

Parameters

request

The new request.

void epics::pvaClient::PvaClientMonitor::stop

(

)

Stop monitoring.

Definition at line 417 of file pvaClientMonitor.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientMonitor::stop"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    if(!isStarted) return;
    isStarted = false;
    monitor->stop();
}

Status epics::pvaClient::PvaClientMonitor::waitConnect

(

)

Wait until the channelMonitor connection to the channel is complete.

Returns

status;

Definition at line 323 of file pvaClientMonitor.cpp.

{
    if(PvaClient::getDebug()) {
       cout << "PvaClientMonitor::waitConnect "
         << pvaClientChannel->getChannel()->getChannelName()
         << endl;
    }
    {
        Lock xx(mutex);
        if(connectState==connected) {
             if(!monitorConnectStatus.isOK()) connectState = connectIdle;
             return monitorConnectStatus;
        }
        if(connectState!=connectWait) {
            string message = string("channel ") + pvaClientChannel->getChannel()->getChannelName()
                + " PvaClientMonitor::waitConnect illegal connect state ";
            throw std::runtime_error(message);
        }
    }
    waitForConnect.wait();
    connectState = monitorConnectStatus.isOK() ? connected : connectIdle;
    if(PvaClient::getDebug()) {
        cout << "PvaClientMonitor::waitConnect"
             << " monitorConnectStatus " << (monitorConnectStatus.isOK() ? "connected" : "not connected")
             << endl;
    }
    return monitorConnectStatus;
}

bool epics::pvaClient::PvaClientMonitor::waitEvent

(

double

secondsToWait = 0.0

)

Wait for a monitor event.

The data will be in PvaClientData.

Parameters

secondsToWait

Time to wait for event.

Returns

(false,true) means event (did not, did) occur.

Definition at line 444 of file pvaClientMonitor.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientMonitor::waitEvent"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    if(!isStarted) {
        string message = string("channel ") + pvaClientChannel->getChannel()->getChannelName()
            + " PvaClientMonitor::waitEvent illegal state ";
        throw std::runtime_error(message);
    }
    if(poll()) return true;
    userWait = true;
    if(secondsToWait==0.0) {
        waitForEvent.wait();
    } else {
        waitForEvent.wait(secondsToWait);
    }
    userWait = false;
    return poll();
}

Friends And Related Function Documentation

friend class MonitorRequesterImpl

friend

Definition at line 1700 of file pvaClient.h.

---

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

• modules/pvaClient/src/pv/pvaClient.h
• modules/pvaClient/src/pvaClientMonitor.cpp