epics/pvaClient
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity
Files
4e4554af4e86fa6d7814392e6d95d901c676287b
pvaClient/src/pv/pvaClient.h
mrkraimer 6bcc036c71 reimplement methods called by pvaPy 
The methods are:
static PvaClientPtr create() EPICS_DEPRECATED;
and
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;
2018-01-12 13:51:13 -05:00

1937 lines
67 KiB
C++
Raw Blame History

/**
* Copyright - See the COPYRIGHT that is included with this distribution.
* EPICS pvData is distributed subject to a Software License Agreement found
* in file LICENSE that is included with this distribution.
*/
/**
* @author mrk
* @date 2015.02
*/
#ifndef PVACLIENT_H
#define PVACLIENT_H
#ifdef epicsExportSharedSymbols
# define pvaClientEpicsExportSharedSymbols
# undef epicsExportSharedSymbols
#endif
#include <list>
#include <iostream>
#include <sstream>
#include <pv/requester.h>
#include <pv/status.h>
#include <pv/event.h>
#include <pv/lock.h>
#include <pv/pvData.h>
#include <pv/pvCopy.h>
#include <pv/pvTimeStamp.h>
#include <pv/timeStamp.h>
#include <pv/pvAlarm.h>
#include <pv/alarm.h>
#include <pv/pvAccess.h>
#include <pv/standardField.h>
#include <pv/standardPVField.h>
#include <pv/createRequest.h>
#include <pv/nt.h>
#ifdef pvaClientEpicsExportSharedSymbols
# define epicsExportSharedSymbols
# undef pvaClientEpicsExportSharedSymbols
#endif
#include <shareLib.h>
namespace epics { namespace pvaClient {
class PvaClient;
typedef std::tr1::shared_ptr<PvaClient> PvaClientPtr;
class PvaClientGetData;
typedef std::tr1::shared_ptr<PvaClientGetData> PvaClientGetDataPtr;
class PvaClientPutData;
typedef std::tr1::shared_ptr<PvaClientPutData> PvaClientPutDataPtr;
class PvaClientMonitorData;
typedef std::tr1::shared_ptr<PvaClientMonitorData> PvaClientMonitorDataPtr;
class PvaClientChannelStateChangeRequester;
typedef std::tr1::shared_ptr<PvaClientChannelStateChangeRequester> PvaClientChannelStateChangeRequesterPtr;
typedef std::tr1::weak_ptr<PvaClientChannelStateChangeRequester> PvaClientChannelStateChangeRequesterWPtr;
class PvaClientChannel;
typedef std::tr1::shared_ptr<PvaClientChannel> PvaClientChannelPtr;
class PvaClientField;
typedef std::tr1::shared_ptr<PvaClientField> PvaClientFieldPtr;
class PvaClientProcessRequester;
typedef std::tr1::shared_ptr<PvaClientProcessRequester> PvaClientProcessRequesterPtr;
typedef std::tr1::weak_ptr<PvaClientProcessRequester> PvaClientProcessRequesterWPtr;
class PvaClientProcess;
typedef std::tr1::shared_ptr<PvaClientProcess> PvaClientProcessPtr;
class PvaClientGetRequester;
typedef std::tr1::shared_ptr<PvaClientGetRequester> PvaClientGetRequesterPtr;
typedef std::tr1::weak_ptr<PvaClientGetRequester> PvaClientGetRequesterWPtr;
class PvaClientGet;
typedef std::tr1::shared_ptr<PvaClientGet> PvaClientGetPtr;
class PvaClientPutRequester;
typedef std::tr1::shared_ptr<PvaClientPutRequester> PvaClientPutRequesterPtr;
typedef std::tr1::weak_ptr<PvaClientPutRequester> PvaClientPutRequesterWPtr;
class PvaClientPut;
typedef std::tr1::shared_ptr<PvaClientPut> PvaClientPutPtr;
class PvaClientPutGetRequester;
typedef std::tr1::shared_ptr<PvaClientPutGetRequester> PvaClientPutGetRequesterPtr;
typedef std::tr1::weak_ptr<PvaClientPutGetRequester> PvaClientPutGetRequesterWPtr;
class PvaClientPutGet;
typedef std::tr1::shared_ptr<PvaClientPutGet> PvaClientPutGetPtr;
class PvaClientMonitor;
typedef std::tr1::shared_ptr<PvaClientMonitor> PvaClientMonitorPtr;
class PvaClientMonitorRequester;
typedef std::tr1::shared_ptr<PvaClientMonitorRequester> PvaClientMonitorRequesterPtr;
typedef std::tr1::weak_ptr<PvaClientMonitorRequester> PvaClientMonitorRequesterWPtr;
class PvaClientArray;
typedef std::tr1::shared_ptr<PvaClientArray> PvaClientArrayPtr;
class PvaClientRPC;
typedef std::tr1::shared_ptr<PvaClientRPC> PvaClientRPCPtr;
class PvaClientRPCRequester;
typedef std::tr1::shared_ptr<PvaClientRPCRequester> PvaClientRPCRequesterPtr;
typedef std::tr1::weak_ptr<PvaClientRPCRequester> PvaClientRPCRequesterWPtr;
// following are private to pvaClient
class PvaClientChannelCache;
typedef std::tr1::shared_ptr<PvaClientChannelCache> PvaClientChannelCachePtr;
/**
* @brief pvaClient is a synchronous wrapper for the pvAccess API, which is a callback based API.
*
* <a href = "../htmldoxygen/pvaClient.html">Overview of PvaClient</a>
*/
class epicsShareClass PvaClient :
public epics::pvData::Requester,
public std::tr1::enable_shared_from_this<PvaClient>
{
public:
POINTER_DEFINITIONS(PvaClient);
/**
* @brief Destructor
*/
~PvaClient();
/** @brief Get the single instance of PvaClient.
*
* @param providerNames Space separated list of provider names.
* @return shared pointer to the single instance.
*/
static PvaClientPtr get(std::string const & providerNames = "pva ca");
/** @brief Get the requester name.
* @return The name.
*/
/** @brief Create an instance of PvaClient with providerName "pva ca".
* @return shared pointer to the single instance
* @deprecated This method will go away in future versions. Use get instead.
*/
static PvaClientPtr create() EPICS_DEPRECATED;
std::string getRequesterName();
/** @brief A new message.
*
* If a requester is set then it is called otherwise message is displayed
* on standard out.
* @param message The message.
* @param messageType The type.
*/
void message(
std::string const & message,
epics::pvData::MessageType messageType);
/** @brief Get a cached channel or create and connect to a new channel.
*
* @param channelName The channelName.
* @param providerName The providerName.
* @param timeOut The number of seconds to wait for connection. 0.0 means forever.
* @return The interface.
* @throw runtime_error if connection fails.
*/
PvaClientChannelPtr channel(
std::string const & channelName,
std::string const &providerName = "pva",
double timeOut = 5.0);
/** @brief Create an PvaClientChannel with the specified provider.
*
* @param channelName The channelName.
* @param providerName The provider.
* @return The interface.
* @throw runtime_error if connection fails.
*/
PvaClientChannelPtr createChannel(
std::string const & channelName,
std::string const & providerName = "pva");
/** @brief Set a requester.
*
* The default is for PvaClient to handle messages by printing to System.out.
* @param requester The requester.
*/
void setRequester(epics::pvData::RequesterPtr const & requester);
/** @brief Clear the requester. PvaClient will handle messages.
*/
void clearRequester();
/** @brief Show the list of cached channels.
*/
void showCache();
/** @brief Get the number of cached channels.
*/
size_t cacheSize();
/** @brief Should debug info be shown?
*
* @param value true or false
*/
static void setDebug(bool value);
/** @brief Is debug set?
*
* @return true or false
*/
static bool getDebug();
private:
PvaClient(std::string const & providerNames);
PvaClientChannelCachePtr pvaClientChannelCache;
epics::pvData::Requester::weak_pointer requester;
bool pvaStarted;
bool caStarted;
epics::pvData::Mutex mutex;
epics::pvAccess::ChannelProviderRegistry::shared_pointer channelRegistry;
};
// folowing private to PvaClientChannel
class PvaClientGetCache;
typedef std::tr1::shared_ptr<PvaClientGetCache> PvaClientGetCachePtr;
class PvaClientPutCache;
typedef std::tr1::shared_ptr<PvaClientPutCache> PvaClientPutCachePtr;
/**
* @brief A callback for change in connection status.
*
* <a href = "../htmldoxygen/pvaClientChannelStateChangeRequester.html">Overview of PvaClientChannelStateChangeRequester</a>
*
*/
class epicsShareClass PvaClientChannelStateChangeRequester
{
public:
POINTER_DEFINITIONS(PvaClientChannelStateChangeRequester);
/**
* Destructor
*/
virtual ~PvaClientChannelStateChangeRequester(){}
/**
* @brief A channel connection state change has occurred.
*
* <b>Warning</b> A call to a method that blocks should not be made by this method.
* @param channel The channel.
* @param isConnected The new connection status.
*/
virtual void channelStateChange(PvaClientChannelPtr const & channel, bool isConnected) = 0;
};
/**
* @brief An easy to use alternative to directly calling the Channel methods of pvAccess.
*
* <a href = "../htmldoxygen/pvaClientChannel.html">Overview of PvaClientChannel</a>
*/
class epicsShareClass PvaClientChannel :
public epics::pvAccess::ChannelRequester,
public std::tr1::enable_shared_from_this<PvaClientChannel>
{
public:
POINTER_DEFINITIONS(PvaClientChannel);
/**
* @brief Destructor
*/
~PvaClientChannel();
/** @brief Set a client stateChangeRequester.
*
* @param stateChangeRequester The client stateChangeRequester implementation.
*/
void setStateChangeRequester(PvaClientChannelStateChangeRequesterPtr const &stateChangeRequester);
/** @brief Get the name of the channel to which PvaClientChannel is connected.
*
* @return The channel name.
*/
std::string getChannelName();
/** @brief Get the the channel to which PvaClientChannel is connected.
*
* @return The channel interface.
*/
epics::pvAccess::Channel::shared_pointer getChannel();
/** @brief Connect to the channel.
*
* This calls issueConnect and waitConnect.
* @param timeout The time to wait for connecting to the channel. The defaut is 5 seconds.
* @throw runtime_error if connection fails.
*/
void connect(double timeout=5.0);
/** @brief Issue a connect request and return immediately.
*
*/
void issueConnect();
/** @brief Wait until the connection completes or for timeout.
*
* @param timeout The time in seconds to wait. A value of 0 means forever.
* @return status.
*/
epics::pvData::Status waitConnect(double timeout = 5.0);
/** @brief Create a PvaClientField for the specified subField.
*
* @param subField The desired subField, i. e. "field.field...."
* An empty string, i. e. "", asks for the entire top level struture as defined by the server.
* @return The interface.
*/
PvaClientFieldPtr createField(std::string const & subField = "");
/** @brief First call createRequest as implemented by pvDataCPP and then call the next method.
*
* @param request The syntax of request is defined by the copy facility of pvData.
* @return The interface.
* @throw runtime_error if failure.
*/
PvaClientProcessPtr createProcess(std::string const & request = "");
/** Creates a PvaClientProcess.
*
* @param pvRequest The syntax of pvRequest is defined by the copy facility of pvData.
* @return The interface.
* @throw runtime_error if failure.
*/
PvaClientProcessPtr createProcess(epics::pvData::PVStructurePtr const & pvRequest);
/** @brief create a PvaChannelGet
*
* Get a cached PvaClientGet or create and connect to a new PvaClientGet.
* @return The interface.
* @throw runtime_error if failure.
*/
PvaClientGetPtr get(std::string const & request = "field(value,alarm,timeStamp)");
/** @brief create a PvaClientGet.
*
* First call createRequest as implemented by pvData and then call the next method.
* @param request The syntax of request is defined by the copy facility of pvData.
* @return The interface.
* @throw runtime_error if failure.
*/
PvaClientGetPtr createGet(std::string const & request = "field(value,alarm,timeStamp)");
/** @brief Creates an PvaClientGet.
*
* @param pvRequest The syntax of pvRequest is defined by the copy facility of pvData.
* @return The interface.
* @throw runtime_error if failure.
*/
PvaClientGetPtr createGet(epics::pvData::PVStructurePtr const & pvRequest);
/** @brief create a PvaClientPut.
*
* Get a cached PvaClientPut or create and connect to a new PvaClientPut.
* Then call it's get method.
* @param request The syntax of request is defined by the copy facility of pvData.
* @return The interface.
* @throw runtime_error if connection fails
*/
PvaClientPutPtr put(std::string const & request = "field(value)");
/** @brief create a PvaClientPut.
*
* First call createRequest as implemented by pvDataJava and then call the next method.
* @param request The syntax of request is defined by the copy facility of pvData.
* @return The interface.
* @throw runtime_error if failure.
*/
PvaClientPutPtr createPut(std::string const & request = "field(value)");
/** @brief Create a PvaClientPut.
*
* @param pvRequest The syntax of pvRequest is defined by the copy facility of pvData.
* @return The interface.
*/
PvaClientPutPtr createPut(epics::pvData::PVStructurePtr const & pvRequest);
/** @brief create a PvaClientPutGet.
*
* First call createRequest as implemented by pvDataJava and then calls the next method.
* @param request The syntax of request is defined by the copy facility of pvData.
* @return The interface.
* @throw runtime_error if failure.
*/
PvaClientPutGetPtr createPutGet(
std::string const & request = "putField(argument)getField(result)");
/** @brief Create a PvaClientPutGet.
*
* @param pvRequest The syntax of pvRequest is defined by the copy facility of pvData.
* @return The interface.
*/
PvaClientPutGetPtr createPutGet(epics::pvData::PVStructurePtr const & pvRequest);
/** @brief Create a PvaClientArray.
*
* First call createRequest as implemented by pvDataJava and then call the next method.
* @param request The syntax of request is defined by the copy facility of pvData.
* @return The interface.
* @throw runtime_error if failure.
*/
PvaClientArrayPtr createArray(std::string const & request = "field(value)");
/** @brief Create a PvaClientArray.
* @param pvRequest The syntax of pvRequest is defined by the copy facility of pvData.
* @return The interface.
* @throw runtime_error if failure.
*/
PvaClientArrayPtr createArray(epics::pvData::PVStructurePtr const & pvRequest);
/** @brief Create a PvaClientMonitor.
*
* Create and connect to a new PvaClientMonitor.
* Then call it's start method.
* If connection can not be made an exception is thrown.
* @param request The syntax of request is defined by the copy facility of pvData.
* @return The interface.
* @throw runtime_error if failure.
*/
PvaClientMonitorPtr monitor(std::string const & request = "field(value,alarm,timeStamp)");
/** @brief Call the next method with request = "field(value,alarm,timeStamp)"
*
* @param pvaClientMonitorRequester The client callback.
* @return The interface.
* @throw runtime_error if failure.
*/
PvaClientMonitorPtr monitor(PvaClientMonitorRequesterPtr const & pvaClientMonitorRequester);
/** @brief Create and connect to a new PvaClientMonitor.
*
* Then call it's start method.
* If connection can not be made an exception is thrown.
* @param request The syntax of request is defined by the copy facility of pvData.
* @param pvaClientMonitorRequester The client callback.
* @return The interface.
* @throw runtime_error if failure.
*/
PvaClientMonitorPtr monitor(
std::string const & request,
PvaClientMonitorRequesterPtr const & pvaClientMonitorRequester);
/**
* @brief First call createRequest as implemented by pvDataJava and then call the next method.
*
* @param request The syntax of request is defined by the copy facility of pvData.
* @return The interface.
* @throw runtime_error if failure.
*/
PvaClientMonitorPtr createMonitor(
std::string const & request = "field(value,alarm,timeStamp)");
/** Create an PvaClientMonitor.
* @param pvRequest The syntax of pvRequest is defined by the copy facility of pvData.
*
* @return The interface.
* @throw runtime_error if failure.
*/
PvaClientMonitorPtr createMonitor(epics::pvData::PVStructurePtr const & pvRequest);
/** @brief Issue a channelRPC request
*
* @param pvRequest The pvRequest that is passed to createRPC.
* @param pvArgument The argument for a request.
* @return The result.
* @throw runtime_error if failure.
*/
epics::pvData::PVStructurePtr rpc(
epics::pvData::PVStructurePtr const & pvRequest,
epics::pvData::PVStructurePtr const & pvArgument);
/** @brief Issue a channelRPC request
*
* @param pvArgument The argument for the request.
* @return The result.
* @throw runtime_error if failure.
*/
epics::pvData::PVStructurePtr rpc(
epics::pvData::PVStructurePtr const & pvArgument);
/** @brief Create a PvaClientRPC.
*
* @return The interface.
* @throw runtime_error if failure.
*/
PvaClientRPCPtr createRPC();
/** @brief Create a PvaClientRPC.
*
* @param pvRequest The pvRequest that must have the same interface
* as a pvArgument that is passed to an rpc request.
* @return The interface.
* @throw runtime_error if failure.
*/
PvaClientRPCPtr createRPC(epics::pvData::PVStructurePtr const & pvRequest);
/** @brief Show the list of cached gets and puts.
*/
void showCache();
/** @brief Get the number of cached gets and puts.
*/
size_t cacheSize();
private:
static PvaClientChannelPtr create(
PvaClientPtr const &pvaClient,
std::string const & channelName,
std::string const & providerName);
PvaClientChannel(
PvaClientPtr const &pvaClient,
std::string const & channelName,
std::string const & providerName);
enum ConnectState {connectIdle,connectActive,notConnected,connected};
PvaClient::weak_pointer pvaClient;
std::string channelName;
std::string providerName;
ConnectState connectState;
epics::pvData::CreateRequest::shared_pointer createRequest;
PvaClientGetCachePtr pvaClientGetCache;
PvaClientPutCachePtr pvaClientPutCache;
epics::pvData::Mutex mutex;
epics::pvData::Event waitForConnect;
epics::pvAccess::Channel::shared_pointer channel;
epics::pvAccess::ChannelProvider::shared_pointer channelProvider;
PvaClientChannelStateChangeRequesterWPtr stateChangeRequester;
public:
virtual std::string getRequesterName();
virtual void message(std::string const & message, epics::pvData::MessageType messageType);
virtual void channelCreated(
const epics::pvData::Status& status,
epics::pvAccess::Channel::shared_pointer const & channel);
virtual void channelStateChange(
epics::pvAccess::Channel::shared_pointer const & channel,
epics::pvAccess::Channel::ConnectionState connectionState);
friend class PvaClient;
};
/**
* @brief A class that holds data returned by PvaClientGet or PvaClientPutGet
*
* <a href = "../htmldoxygen/pvaClientGetData.html">Overview of PvaClientGetData</a>
*/
class epicsShareClass PvaClientGetData
{
public:
POINTER_DEFINITIONS(PvaClientGetData);
/**
* @brief Destructor
*/
~PvaClientGetData() {}
/** @brief Set a prefix for throw messages.
*
* This is called by other pvaClient classes.
* @param value The prefix.
*/
void setMessagePrefix(std::string const & value);
/** @brief Get the structure.
*
* @return The Structure
* @throw runtime_error if failure.
*/
epics::pvData::StructureConstPtr getStructure();
/** @brief Get the pvStructure.
*
* @return the pvStructure.
* @throw runtime_error if failure.
*/
epics::pvData::PVStructurePtr getPVStructure();
/** @brief Get the changed BitSet for the pvStructure
*
* This shows which fields have changed value since the last get.
* @return The bitSet
* @throw runtime_error if failure
*/
epics::pvData::BitSetPtr getChangedBitSet();
/** @brief Show the fields that have changed value since the last get.
*
* @param out The stream that shows the changed fields.
* @return The stream that was passed as out.
*/
std::ostream & showChanged(std::ostream & out);
/** @brief New data is present.
*
* This is called by other pvaClient classes, i. e. not by client.
* @param pvStructureFrom The new data.
* @param bitSetFrom the bitSet showing which values have changed.
*/
void setData(
epics::pvData::PVStructurePtr const & pvStructureFrom,
epics::pvData::BitSetPtr const & bitSetFrom);
/** @brief Is there a top level field named value.
* @return The answer.
*/
bool hasValue();
/** @brief Is the value field a scalar?
* @return The answer.
*/
bool isValueScalar();
/** @brief Is the value field a scalar array?
* @return The answer.
*/
bool isValueScalarArray();
/** @brief Get the interface to the value field.
* @return The interface.
* @throw runtime_error if failure.
*/
epics::pvData::PVFieldPtr getValue();
/**
* @brief Return the interface to a scalar value field.
* @return The interface for a scalar value field.
* @throw runtime_error if failure.
*/
epics::pvData::PVScalarPtr getScalarValue();
/** @brief Get the interface to an array value field.
* @return The interface.
* @throw runtime_error if failure.
*/
std::tr1::shared_ptr<epics::pvData::PVArray> getArrayValue();
/** @brief Get the interface to a scalar array value field.
* @return Return the interface.
* @throw runtime_error if failure.
*/
std::tr1::shared_ptr<epics::pvData::PVScalarArray> getScalarArrayValue();
/** @brief Get the value as a double.
* @return The value.
* @throw runtime_error if failure.
*/
double getDouble();
/** Get the value as a string.
* @return The value.
* @throw runtime_error if failure.
*/
std::string getString();
/** @brief Get the value as a double array.
* @return The value.
* @throw runtime_error if failure.
*/
epics::pvData::shared_vector<const double> getDoubleArray();
/** @brief Get the value as a string array.
* @return The value.
* @throw runtime_error if failure.
*/
epics::pvData::shared_vector<const std::string> getStringArray();
/** @brief Get the alarm.
* If the pvStructure has an alarm field it's values are returned.
* Otherwise an exception is thrown.
* @return The alarm.
* @throw runtime_error if failure.
*/
epics::pvData::Alarm getAlarm();
/** @brief Get the timeStamp.
* If the pvStructure has a timeStamp field, it's values are returned.
* Otherwise an exception is thrown.
* @return The timeStamp.
*/
epics::pvData::TimeStamp getTimeStamp();
/** @brief Factory method for creating an instance of PvaClientGetData.
*
* NOTE: Not normally called by clients
* @param structure Introspection interface
* @throw runtime_error if failure.
*/
static PvaClientGetDataPtr create(epics::pvData::StructureConstPtr const & structure);
private:
PvaClientGetData(epics::pvData::StructureConstPtr const & structure);
void checkValue();
epics::pvData::StructureConstPtr structure;
epics::pvData::PVStructurePtr pvStructure;
epics::pvData::BitSetPtr bitSet;
std::string messagePrefix;
epics::pvData::PVFieldPtr pvValue;
epics::pvData::PVAlarm pvAlarm;
epics::pvData::PVTimeStamp pvTimeStamp;
friend class PvaClientGet;
friend class PvaClientPutGet;
};
class PvaClientPostHandlerPvt; // private to PvaClientPutData
/**
* @brief A class that holds data given to by PvaClientPut or PvaClientPutGet
*
* <a href = "../htmldoxygen/pvaClientPutData.html">Overview of PvaClientPutData</a>
*/
class epicsShareClass PvaClientPutData
{
public:
POINTER_DEFINITIONS(PvaClientPutData);
/**
* @brief Destructor
*/
~PvaClientPutData() {}
/** @brief Set a prefix for throw messages.
*
* @param value The prefix.
*/
void setMessagePrefix(std::string const & value);
/** @brief Get the structure.
*
* @return The Structure
* @throw runtime_error if failure.
*/
epics::pvData::StructureConstPtr getStructure();
/** @brief Get the pvStructure.
*
* @return the pvStructure.
* @throw runtime_error if failure.
*/
epics::pvData::PVStructurePtr getPVStructure();
/** @brief Get the changed BitSet for the pvStructure
*
* This shows which fields have changed values.
* @return The bitSet
* @throw runtime_error if failure.
*/
epics::pvData::BitSetPtr getChangedBitSet();
/** @brief Show the fields that have changed values.
*
* @param out The stream that shows the changed fields.
* @return The stream that was passed as out.
*/
std::ostream & showChanged(std::ostream & out);
/**
* @brief Is there a top level field named value.
*
* @return The answer.
*/
bool hasValue();
/** @brief Is the value field a scalar?
*
* @return The answer.
*/
bool isValueScalar();
/** @brief Is the value field a scalar array?
* @return The answer.
*/
bool isValueScalarArray();
/** Get the interface to the value field.
*
* @return The interface. an excetion is thrown if a value field does not exist.
*/
epics::pvData::PVFieldPtr getValue();
/** @brief Get the interface to a scalar value field.
*
* @return The interface for a scalar value field.
* @throw runtime_error if failure.
*/
epics::pvData::PVScalarPtr getScalarValue();
/** @brief Get the interface to an array value field.
* @return The interface.
* An exception is thown if no array value field.
*/
std::tr1::shared_ptr<epics::pvData::PVArray> getArrayValue();
/** @brief Get the interface to a scalar array value field.
* @return Return the interface.
* @throw runtime_error if failure.
*/
std::tr1::shared_ptr<epics::pvData::PVScalarArray> getScalarArrayValue();
/** @brief Get the value as a double.
*
* If value is not a numeric scalar an exception is thrown.
* @return The value.
*/
double getDouble();
/** @brief Get the value as a string.
* @return The value.
* @throw runtime_error if failure.
*/
std::string getString();
/** @brief Get the value as a double array.
* If the value is not a numeric array an exception is thrown.
* @return The value.
*/
epics::pvData::shared_vector<const double> getDoubleArray();
/** @brief Get the value as a string array.
* @return The value.
* @throw runtime_error if failure.
*/
epics::pvData::shared_vector<const std::string> getStringArray();
/** @brief Put the value as a double.
* @param value The new value.
* An exception is also thrown if the actualy type can cause an overflow.
* @throw runtime_error if failure.
*/
void putDouble(double value);
/** @brief Put the value as a string.
*
* If value is not a scalar an exception is thrown.
*/
void putString(std::string const & value);
/** @brief Copy the array to the value field.
* @param value The place where data is copied.
* @throw runtime_error if failure.
*/
void putDoubleArray(epics::pvData::shared_vector<const double> const & value);
/** @brief Copy array to the value field.
* @param value data source
* @throw runtime_error if failure.
*/
void putStringArray(epics::pvData::shared_vector<const std::string> const & value);
/** @brief Copy array to the value field.
* @param value data source
* @throw runtime_error if failure.
*/
void putStringArray(std::vector<std::string> const & value);
/** Factory method for creating an instance of PvaClientGetData.
* NOTE: Not normally called by clients
* @param structure Introspection interface
*/
static PvaClientPutDataPtr create(epics::pvData::StructureConstPtr const & structure);
private:
PvaClientPutData(epics::pvData::StructureConstPtr const &structure);
void checkValue();
void postPut(size_t fieldNumber);
std::vector<epics::pvData::PostHandlerPtr> postHandler;
epics::pvData::StructureConstPtr structure;
epics::pvData::PVStructurePtr pvStructure;
epics::pvData::BitSetPtr bitSet;
friend class PvaClientPostHandlerPvt;
std::string messagePrefix;
epics::pvData::PVFieldPtr pvValue;
friend class PvaClientPut;
friend class PvaClientPutGet;
};
/**
* @brief A class that holds data returned by PvaClientMonitor
*
* <a href = "../htmldoxygen/pvaClientMonitorData.html">Overview of PvaClientMonitorData</a>
*/
class epicsShareClass PvaClientMonitorData
{
public:
POINTER_DEFINITIONS(PvaClientMonitorData);
/**
* @brief Destructor
*/
~PvaClientMonitorData() {}
/** @brief Set a prefix for throw messages.
* @param value The prefix.
*/
void setMessagePrefix(std::string const & value);
/** @brief Get the structure.
* @return The Structure
* @throw runtime_error if failure.
*/
epics::pvData::StructureConstPtr getStructure();
/** @brief Get the pvStructure.
* @return the pvStructure.
* @throw runtime_error if failure.
*/
epics::pvData::PVStructurePtr getPVStructure();
/** @brief Get the changed BitSet for the pvStructure,
*
* This shows which fields have changed value.
* @return The bitSet
* @throw runtime_error if failure.
*/
epics::pvData::BitSetPtr getChangedBitSet();
/** @brief Get the overrun BitSet for the pvStructure
* This shows which fields have had more than one change.
* @return The bitSet
* @throw runtime_error if failure.
*/
epics::pvData::BitSetPtr getOverrunBitSet();
/** @brief Show the fields that have changed.
* @param out The stream that shows the changed fields.
* @return The stream that was passed as out.
*/
std::ostream & showChanged(std::ostream & out);
/** @brief Show the fields that have overrun.
* @param out The stream that shows the overrun fields.
* @return The stream that was passed as out
*/
std::ostream & showOverrun(std::ostream & out);
/** @brief Is there a top level field named value.
* @return The answer.
*/
bool hasValue();
/** @brief Is the value field a scalar?
* @return The answer.
*/
bool isValueScalar();
/** @brief Is the value field a scalar array?
* @return The answer.
*/
bool isValueScalarArray();
/** @brief Get the interface to the value field.
* @return The interface. an excetion is thrown if a value field does not exist.
*/
epics::pvData::PVFieldPtr getValue();
/** @brief Get the interface to a scalar value field.
* @return The interface for a scalar value field.
* @throw runtime_error if failure.
* An exception is thown if no scalar value field.
*/
epics::pvData::PVScalarPtr getScalarValue();
/** @brief Get the interface to an array value field.
* @return The interface.
* @throw runtime_error if failure.
* An exception is thown if no array value field.
*/
std::tr1::shared_ptr<epics::pvData::PVArray> getArrayValue();
/** @brief Get the interface to a scalar array value field.
* @return Return the interface.
* @throw runtime_error if failure.
* An exception is thown if no scalar array value field.
*/
std::tr1::shared_ptr<epics::pvData::PVScalarArray> getScalarArrayValue();
/** @brief Get the value as a double.
*
* If value is not a numeric scalar an exception is thrown.
* @return The value.
*/
double getDouble();
/** @brief Get the value as a string.
*
* If value is not a scalar an exception is thrown
* @return The value.
* @throw runtime_error if failure.
*/
std::string getString();
/** @brief Get the value as a double array.
*
* If the value is not a numeric array an exception is thrown.
* @return The value.
* @throw runtime_error if failure.
*/
epics::pvData::shared_vector<const double> getDoubleArray();
/** @brief Get the value as a string array.
*
* If the value is not a string array an exception is thrown.
* @return The value.
* @throw runtime_error if failure.
*/
epics::pvData::shared_vector<const std::string> getStringArray();
/** @brief Get the alarm.
*
* If the pvStructure as an alarm field it's values are returned.
* If no then alarm shows that not alarm defined.
* @return The alarm.
* @throw runtime_error if failure.
*/
epics::pvData::Alarm getAlarm();
/** @brief Get the timeStamp.
*
* If the pvStructure has a timeStamp field, it's values are returned.
* If no then all fields are 0.
* @return The timeStamp.
*/
epics::pvData::TimeStamp getTimeStamp();
/** Factory method for creating an instance of PvaClientGetData.
* NOTE: Not normally called by clients
* @param structure Introspection interface
*/
static PvaClientMonitorDataPtr create(epics::pvData::StructureConstPtr const & structure);
/** Put data into PVStructure from monitorElement
* NOTE: Not normally called by clients
* @param monitorElement the monitorElement that has new data.
*/
void setData(epics::pvData::MonitorElementPtr const & monitorElement);
private:
PvaClientMonitorData(epics::pvData::StructureConstPtr const & structure);
void checkValue();
epics::pvData::StructureConstPtr structure;
epics::pvData::PVStructurePtr pvStructure;
epics::pvData::BitSetPtr changedBitSet;
epics::pvData::BitSetPtr overrunBitSet;
std::string messagePrefix;
epics::pvData::PVFieldPtr pvValue;
epics::pvData::PVAlarm pvAlarm;
epics::pvData::PVTimeStamp pvTimeStamp;
friend class PvaClientMonitor;
};
/**
* @brief Optional client callback.
*
* <a href = "../htmldoxygen/pvaClientProcessRequester.html">Overview of PvaClientProcessRequester</a>
*/
class epicsShareClass PvaClientProcessRequester
{
public:
POINTER_DEFINITIONS(PvaClientProcessRequester);
virtual ~PvaClientProcessRequester() {}
/** @brief A channelProcess has connected.
*
* @param status The status returned by the server.
* @param clientProcess The PvaClientProcess that issued the request to create a ChannelProcess.
*/
virtual void channelProcessConnect(
const epics::pvData::Status& status,
PvaClientProcessPtr const & clientProcess)
{
}
/** @brief A process request is complete.
*
* @param status The status returned by the server.
* @param clientProcess The PvaClientProcess that issued the process request.
*/
virtual void processDone(
const epics::pvData::Status& status,
PvaClientProcessPtr const & clientProcess) = 0;
};
// NOTE: must use separate class that implements ChannelProcessRequester,
// because pvAccess holds a shared_ptr to ChannelProcessRequester instead of weak_pointer
class ChannelProcessRequesterImpl;
typedef std::tr1::shared_ptr<ChannelProcessRequesterImpl> ChannelProcessRequesterImplPtr;
/**
* @brief An easy to use alternative to ChannelProcess.
*
* <a href = "../htmldoxygen/pvaClientProcess.html">Overview of PvaClientProcess</a>
*/
class epicsShareClass PvaClientProcess :
public std::tr1::enable_shared_from_this<PvaClientProcess>
{
public:
POINTER_DEFINITIONS(PvaClientProcess);
/** @brief Create a PvaClientProcess.
* @param pvaClient Interface to PvaClient
* @param pvaClientChannel Interface to Channel
* @param pvRequest The request structure.
* @return The interface to the PvaClientProcess.
*/
static PvaClientProcessPtr create(
PvaClientPtr const &pvaClient,
PvaClientChannelPtr const & pvaClientChannel,
epics::pvData::PVStructurePtr const &pvRequest
);
/** @brief Destructor
*/
~PvaClientProcess();
/** @brief Set a user callback.
* @param pvaClientProcessRequester The requester which must be implemented by the caller.
*/
void setRequester(PvaClientProcessRequesterPtr const & pvaClientProcessRequester);
/** @brief Call issueConnect and then waitConnect.
*
* An exception is thrown if connect fails.
* @throw runtime_error if failure.
*/
void connect();
/** @brief Issue the channelProcess connection to the channel.
*
* This can only be called once.
*/
void issueConnect();
/** @brief Wait until the channelProcess connection to the channel is complete.
* @return status;
*/
epics::pvData::Status waitConnect();
/** @brief Call issueProcess and then waitProcess.
*
* An exception is thrown if process fails.
*/
void process();
/** @brief Issue a process request and return immediately.
*/
void issueProcess();
/** @brief Wait until process completes.
* @return status.
*/
epics::pvData::Status waitProcess();
/** @brief Get the PvaClientChannel;
*
* @return The interface.
*/
PvaClientChannelPtr getPvaClientChannel();
private:
std::string getRequesterName();
void message(std::string const & message,epics::pvData::MessageType messageType);
void channelProcessConnect(
const epics::pvData::Status& status,
epics::pvAccess::ChannelProcess::shared_pointer const & channelProcess);
void processDone(
const epics::pvData::Status& status,
epics::pvAccess::ChannelProcess::shared_pointer const & channelProcess);
PvaClientProcess(
PvaClientPtr const &pvaClient,
PvaClientChannelPtr const & pvaClientChannel,
epics::pvData::PVStructurePtr const &pvRequest);
void checkProcessState();
enum ProcessConnectState {connectIdle,connectActive,connected};
PvaClient::weak_pointer pvaClient;
PvaClientChannelPtr pvaClientChannel;
epics::pvData::PVStructurePtr pvRequest;
epics::pvData::Mutex mutex;
epics::pvData::Event waitForConnect;
epics::pvData::Event waitForProcess;
epics::pvData::Status channelProcessConnectStatus;
epics::pvData::Status channelProcessStatus;
epics::pvAccess::ChannelProcess::shared_pointer channelProcess;
ProcessConnectState connectState;
PvaClientProcessRequesterWPtr pvaClientProcessRequester;
enum ProcessState {processIdle,processActive,processComplete};
ProcessState processState;
ChannelProcessRequesterImplPtr channelProcessRequester;
public:
friend class ChannelProcessRequesterImpl;
};
// NOTE: must use separate class that implements ChannelGetRequester,
// because pvAccess holds a shared_ptr to ChannelGetRequester instead of weak_pointer
class ChannelGetRequesterImpl;
typedef std::tr1::shared_ptr<ChannelGetRequesterImpl> ChannelGetRequesterImplPtr;
/**
* @brief Optional client callback.
*
* <a href = "../htmldoxygen/pvaClientGetRequester.html">Overview of PvaClientGetRequester</a>
*/
class epicsShareClass PvaClientGetRequester
{
public:
POINTER_DEFINITIONS(PvaClientGetRequester);
virtual ~PvaClientGetRequester() {}
/** @brief A channelGet has connected.
*
* @param status The status returned by the server.
* @param clientGet The PvaClientGet that issued the request to create a ChannelGet.
*/
virtual void channelGetConnect(
const epics::pvData::Status& status,
PvaClientGetPtr const & clientGet)
{
}
/** @brief A get request is complete.
*
* @param status The status returned by the server.
* @param clientGet The PvaClientGet that issued the get request
*/
virtual void getDone(
const epics::pvData::Status& status,
PvaClientGetPtr const & clientGet) = 0;
};
/**
* @brief An easy to use alternative to ChannelGet.
*
* <a href = "../htmldoxygen/pvaClientGet.html">Overview of PvaClientGet</a>
*/
class epicsShareClass PvaClientGet :
public std::tr1::enable_shared_from_this<PvaClientGet>
{
public:
POINTER_DEFINITIONS(PvaClientGet);
/** @brief Create a PvaClientGet.
* @param pvaClient Interface to PvaClient
* @param pvaClientChannel Interface to PvaClientChannel
* @param pvRequest The request structure.
* @return The interface to the PvaClientGet.
*/
static PvaClientGetPtr create(
PvaClientPtr const &pvaClient,
PvaClientChannelPtr const & pvaClientChannel,
epics::pvData::PVStructurePtr const &pvRequest
);
/** @brief Destructor
*/
~PvaClientGet();
/** @brief Set a user callback.
* @param pvaClientGetRequester The requester which must be implemented by the caller.
*/
void setRequester(PvaClientGetRequesterPtr const & pvaClientGetRequester);
/** @brief Call issueConnect and then waitConnect.
*
* An exception is thrown if connect fails.
* @throw runtime_error if failure.
*/
void connect();
/**
* @brief create the channelGet connection to the channel.
*
* This can only be called once.
*/
void issueConnect();
/** @brief Wait until the channelGet connection to the channel is complete.
* @return status;
*/
epics::pvData::Status waitConnect();
/** @brief Call issueGet and then waitGet.
* An exception is thrown if get fails.
*/
void get();
/** @brief Issue a get and return immediately.
*/
void issueGet();
/** @brief Wait until get completes.
* @return status;
*/
epics::pvData::Status waitGet();
/**
* @brief Get the data/
* @return The interface.
*/
PvaClientGetDataPtr getData();
/** @brief Get the PvaClientChannel;
*
* @return The interface.
*/
PvaClientChannelPtr getPvaClientChannel();
private:
std::string getRequesterName();
void message(std::string const & message,epics::pvData::MessageType messageType);
void channelGetConnect(
const epics::pvData::Status& status,
epics::pvAccess::ChannelGet::shared_pointer const & channelGet,
epics::pvData::StructureConstPtr const & structure);
void getDone(
const epics::pvData::Status& status,
epics::pvAccess::ChannelGet::shared_pointer const & channelGet,
epics::pvData::PVStructurePtr const & pvStructure,
epics::pvData::BitSetPtr const & bitSet);
PvaClientGet(
PvaClientPtr const &pvaClient,
PvaClientChannelPtr const & pvaClientChannel,
epics::pvData::PVStructurePtr const &pvRequest);
void checkGetState();
enum GetConnectState {connectIdle,connectActive,connected};
PvaClient::weak_pointer pvaClient;
PvaClientChannelPtr pvaClientChannel;
epics::pvData::PVStructurePtr pvRequest;
epics::pvData::Mutex mutex;
epics::pvData::Event waitForConnect;
epics::pvData::Event waitForGet;
PvaClientGetDataPtr pvaClientData;
epics::pvData::Status channelGetConnectStatus;
epics::pvData::Status channelGetStatus;
epics::pvAccess::ChannelGet::shared_pointer channelGet;
GetConnectState connectState;
PvaClientGetRequesterWPtr pvaClientGetRequester;
enum GetState {getIdle,getActive,getComplete};
GetState getState;
ChannelGetRequesterImplPtr channelGetRequester;
public:
friend class ChannelGetRequesterImpl;
};
// NOTE: must use separate class that implements ChannelPutRequester,
// because pvAccess holds a shared_ptr to ChannelPutRequester instead of weak_pointer
class ChannelPutRequesterImpl;
typedef std::tr1::shared_ptr<ChannelPutRequesterImpl> ChannelPutRequesterImplPtr;
/**
* @brief Optional client callback.
*
* <a href = "../htmldoxygen/pvaClientPutRequester.html">Overview of PvaClientPutRequester</a>
*/
class epicsShareClass PvaClientPutRequester
{
public:
POINTER_DEFINITIONS(PvaClientPutRequester);
virtual ~PvaClientPutRequester() {}
/** @brief A channelPut has connected.
*
* @param status The status returned by the server.
* @param clientPut The PvaClientPut that issued the request to create a ChannelPut.
*/
virtual void channelPutConnect(
const epics::pvData::Status& status,
PvaClientPutPtr const & clientPut)
{
}
/** @brief A get request is complete.
*
* @param status The status returned by the server.
* @param clientPut The PvaClientPut that issued the get request.
*/
virtual void getDone(
const epics::pvData::Status& status,
PvaClientPutPtr const & clientPut)
{
}
/** @brief A put request is complete.
*
* @param status The status returned by the server.
* @param clientPut The PvaClientPut that issued the put request.
*/
virtual void putDone(
const epics::pvData::Status& status,
PvaClientPutPtr const & clientPut) = 0;
};
/**
* @brief An easy to use alternative to ChannelPut.
*
* <a href = "../htmldoxygen/pvaClientPut.html">Overview of PvaClientPut</a>
*/
class epicsShareClass PvaClientPut :
public std::tr1::enable_shared_from_this<PvaClientPut>
{
public:
POINTER_DEFINITIONS(PvaClientPut);
/** @brief Create a PvaClientPut.
* @param pvaClient Interface to PvaClient
* @param pvaClientChannel Interface to Channel
* @param pvRequest The request structure.
* @return The interface to the PvaClientPut.
*/
static PvaClientPutPtr create(
PvaClientPtr const &pvaClient,
PvaClientChannelPtr const & pvaClientChannel,
epics::pvData::PVStructurePtr const &pvRequest
);
/** @brief Destructor
*/
~PvaClientPut();
/** @brief Set a user callback.
* @param pvaClientPutRequester The requester which must be implemented by the caller.
*/
void setRequester(PvaClientPutRequesterPtr const & pvaClientPutRequester);
/** @brief Call issueConnect and then waitConnect.
*
* An exception is thrown if connect fails.
* @throw runtime_error if failure.
*/
void connect();
/** @brief Issue the channelPut connection to the channel.
*
* This can only be called once.
*/
void issueConnect();
/** @brief Wait until the channelPut connection to the channel is complete.
* @return status;
*/
epics::pvData::Status waitConnect();
/** @brief Call issueGet and then waitGet.
*
* An exception is thrown if get fails.
* @throw runtime_error if failure.
*/
void get();
/** @brief Issue a get and return immediately.
*/
void issueGet();
/** @brief Wait until get completes.
* @return status
*/
epics::pvData::Status waitGet();
/** @brief Call issuePut and then waitPut.
* An exception is thrown if get fails.
*/
void put();
/** @brief Issue a put and return immediately.
*/
void issuePut();
/** @brief Wait until put completes.
* @return status
*/
epics::pvData::Status waitPut();
/**
* @brief Get the data/
* @return The interface.
*/
PvaClientPutDataPtr getData();
/** @brief Get the PvaClientChannel;
*
* @return The interface.
*/
PvaClientChannelPtr getPvaClientChannel();
private :
std::string getRequesterName();
void message(std::string const & message,epics::pvData::MessageType messageType);
void channelPutConnect(
const epics::pvData::Status& status,
epics::pvAccess::ChannelPut::shared_pointer const & channelPut,
epics::pvData::StructureConstPtr const & structure);
void getDone(
const epics::pvData::Status& status,
epics::pvAccess::ChannelPut::shared_pointer const & channelPut,
epics::pvData::PVStructurePtr const & pvStructure,
epics::pvData::BitSetPtr const & bitSet);
void putDone(
const epics::pvData::Status& status,
epics::pvAccess::ChannelPut::shared_pointer const & channelPut);
PvaClientPut(
PvaClientPtr const &pvaClient,
PvaClientChannelPtr const & pvaClientChannel,
epics::pvData::PVStructurePtr const &pvRequest);
void checkPutState();
enum PutConnectState {connectIdle,connectActive,connected};
PvaClient::weak_pointer pvaClient;
PvaClientChannelPtr pvaClientChannel;
epics::pvData::PVStructurePtr pvRequest;
epics::pvData::Mutex mutex;
epics::pvData::Event waitForConnect;
epics::pvData::Event waitForGetPut;
PvaClientPutDataPtr pvaClientData;
epics::pvData::Status channelPutConnectStatus;
epics::pvData::Status channelGetPutStatus;
epics::pvAccess::ChannelPut::shared_pointer channelPut;
PutConnectState connectState;
enum PutState {putIdle,getActive,putActive,putComplete};
PutState putState;
ChannelPutRequesterImplPtr channelPutRequester;
PvaClientPutRequesterWPtr pvaClientPutRequester;
public:
friend class ChannelPutRequesterImpl;
};
// NOTE: must use separate class that implements ChannelPutGetRequester,
// because pvAccess holds a shared_ptr to ChannelPutGetRequester instead of weak_pointer
class ChannelPutGetRequesterImpl;
typedef std::tr1::shared_ptr<ChannelPutGetRequesterImpl> ChannelPutGetRequesterImplPtr;
/**
* @brief Optional client callback.
*
* <a href = "../htmldoxygen/pvaClientPutGetRequester.html">Overview of PvaClientPutGetRequester</a>
*/
class epicsShareClass PvaClientPutGetRequester
{
public:
POINTER_DEFINITIONS(PvaClientPutGetRequester);
virtual ~PvaClientPutGetRequester() {}
/** @brief A channelPutGet has connected.
*
* @param status The status returned by the server.
* @param clientPutGet The PvaClientPutGet that issued the request to create a ChannelPutGet.
*/
virtual void channelPutGetConnect(
const epics::pvData::Status& status,
PvaClientPutGetPtr const & clientPutGet)
{
}
/** @brief A putGet request is complete.
*
* @param status The status returned by the server.
* @param clientPutGet The PvaClientPutGet that issued the putGet request.
*/
virtual void putGetDone(
const epics::pvData::Status& status,
PvaClientPutGetPtr const & clientPutGet) = 0;
/** @brief A getPut request is complete.
*
* @param status The status returned by the server.
* @param clientPutGet The PvaClientPutGet that issued the getPut request.
*/
virtual void getPutDone(
const epics::pvData::Status& status,
PvaClientPutGetPtr const & clientPutGet)
{
}
/** @brief A getGet request is complete.
*
* @param status The status returned by the server.
* @param clientPutGet The PvaClientPutGet that issued the getGet request.
*/
virtual void getGetDone(
const epics::pvData::Status& status,
PvaClientPutGetPtr const & clientPutGet)
{
}
};
/**
* @brief An easy to use alternative to ChannelPutGet.
*
* <a href = "../htmldoxygen/pvaClientPutGet.html">Overview of PvaClientPutGet</a>
*/
class epicsShareClass PvaClientPutGet :
public std::tr1::enable_shared_from_this<PvaClientPutGet>
{
public:
POINTER_DEFINITIONS(PvaClientPutGet);
/** @brief Create a PvaClientPutGet.
* @param pvaClient Interface to PvaClient
* @param pvaClientChannel Interface to Channel
* @param pvRequest The request structure.
* @return The interface to the PvaClientPutGet.
*/
static PvaClientPutGetPtr create(
PvaClientPtr const &pvaClient,
PvaClientChannelPtr const & pvaClientChannel,
epics::pvData::PVStructurePtr const &pvRequest
);
/** @brief Destructor
*/
~PvaClientPutGet();
/** @brief Set a user callback.
* @param pvaClientPutGetRequester The requester which must be implemented by the caller.
*/
void setRequester(PvaClientPutGetRequesterPtr const & pvaClientPutGetRequester);
/** @brief Call issueConnect and then waitConnect.
*
* An exception is thrown if connect fails.
* @throw runtime_error if failure.
*/
void connect();
/** @brief Issue the channelPutGet connection to the channel.
*
* This can only be called once.
* An exception is thrown if connect fails.
*/
void issueConnect();
/** @brief Wait until the channelPutGet connection to the channel is complete.
* @return status;
*/
epics::pvData::Status waitConnect();
/** @brief Call issuePutGet and then waitPutGet.
*
* An exception is thrown if putGet fails.
*/
void putGet();
/** @brief Issue a putGet and return immediately.
*/
void issuePutGet();
/** @brief Wait until putGet completes.
*
* If failure getStatus can be called to get reason.
* @return status
*/
epics::pvData::Status waitPutGet();
/** @brief Call issueGet and then waitGetGet.
* An exception is thrown if get fails.
*/
void getGet();
/** @brief Issue a getGet and return immediately.
*/
void issueGetGet();
/** @brief Wait until getGet completes.
*
* If failure getStatus can be called to get reason.
* @return status
*/
epics::pvData::Status waitGetGet();
/** @brief Call issuePut and then waitGetPut.
*
* An exception is thrown if getPut fails.
*/
void getPut();
/** @brief Issue a getPut and return immediately.
*/
void issueGetPut();
/** @brief Wait until getPut completes.
* @return status
*/
epics::pvData::Status waitGetPut();
/** @brief Get the put data.
* @return The interface.
*/
PvaClientPutDataPtr getPutData();
/** @brief Get the get data.
* @return The interface.
*/
PvaClientGetDataPtr getGetData();
/** @brief Get the PvaClientChannel;
*
* @return The interface.
*/
PvaClientChannelPtr getPvaClientChannel();
private :
std::string getRequesterName();
void message(std::string const & message,epics::pvData::MessageType messageType);
void channelPutGetConnect(
const epics::pvData::Status& status,
epics::pvAccess::ChannelPutGet::shared_pointer const & channelPutGet,
epics::pvData::StructureConstPtr const & putStructure,
epics::pvData::StructureConstPtr const & getStructure);
void putGetDone(
const epics::pvData::Status& status,
epics::pvAccess::ChannelPutGet::shared_pointer const & channelPutGet,
epics::pvData::PVStructurePtr const & getPVStructure,
epics::pvData::BitSetPtr const & getBitSet);
void getPutDone(
const epics::pvData::Status& status,
epics::pvAccess::ChannelPutGet::shared_pointer const & channelPutGet,
epics::pvData::PVStructurePtr const & putPVStructure,
epics::pvData::BitSet::shared_pointer const & putBitSet);
void getGetDone(
const epics::pvData::Status& status,
epics::pvAccess::ChannelPutGet::shared_pointer const & channelPutGet,
epics::pvData::PVStructurePtr const & getPVStructure,
epics::pvData::BitSet::shared_pointer const & getBitSet);
PvaClientPutGet(
PvaClientPtr const &pvaClient,
PvaClientChannelPtr const & pvaClientChannel,
epics::pvData::PVStructurePtr const &pvRequest);
void checkPutGetState();
enum PutGetConnectState {connectIdle,connectActive,connected};
PvaClient::weak_pointer pvaClient;
PvaClientChannelPtr pvaClientChannel;
epics::pvData::PVStructurePtr pvRequest;
epics::pvData::Mutex mutex;
epics::pvData::Event waitForConnect;
epics::pvData::Event waitForPutGet;
PvaClientGetDataPtr pvaClientGetData;
PvaClientPutDataPtr pvaClientPutData;
epics::pvData::Status channelPutGetConnectStatus;
epics::pvData::Status channelPutGetStatus;
epics::pvAccess::ChannelPutGet::shared_pointer channelPutGet;
PutGetConnectState connectState;
enum PutGetState {putGetIdle,putGetActive,putGetComplete};
PutGetState putGetState;
ChannelPutGetRequesterImplPtr channelPutGetRequester;
PvaClientPutGetRequesterWPtr pvaClientPutGetRequester;
public:
friend class ChannelPutGetRequesterImpl;
};
//class ChannelMonitorRequester; // private to PvaClientMonitor
/**
* @brief Optional client callback.
*
* <a href = "../htmldoxygen/pvaClientMonitorRequester.html">Overview of PvaClientMonitorRequester</a>
*/
class epicsShareClass PvaClientMonitorRequester
{
public:
POINTER_DEFINITIONS(PvaClientMonitorRequester);
/** @brief The server has returned a message that the monitor is connected.
*
* @param status Completion status.
* @param monitor The monitor
* @param structure The structure defining the data.
*/
virtual void monitorConnect(epics::pvData::Status const & status,
PvaClientMonitorPtr const & monitor, epics::pvData::StructureConstPtr const & structure)
{
}
virtual ~PvaClientMonitorRequester() {}
/** @brief A monitor event has occurred.
* @param monitor The PvaClientMonitor that received the event.
*/
virtual void event(PvaClientMonitorPtr const & monitor) = 0;
/**
* @brief The data source is no longer available.
*/
virtual void unlisten()
{
std::cerr << "PvaClientMonitorRequester::unlisten called"
<< " but no PvaClientMonitorRequester::unlisten\n";
}
};
// NOTE: must use separate class that implements MonitorRequester,
// because pvAccess holds a shared_ptr to MonitorRequester instead of weak_pointer
class MonitorRequesterImpl;
typedef std::tr1::shared_ptr<MonitorRequesterImpl> MonitorRequesterImplPtr;
/**
* @brief An easy to use alternative to Monitor.
*
* <a href = "../htmldoxygen/pvaClientMonitor.html">Overview of PvaClientMonitor</a>
*/
class epicsShareClass PvaClientMonitor :
public PvaClientChannelStateChangeRequester, // remove when deprecated create removed
public PvaClientMonitorRequester,
public std::tr1::enable_shared_from_this<PvaClientMonitor>
{
public:
POINTER_DEFINITIONS(PvaClientMonitor);
/** @brief Create a PvaClientMonitor.
* @param pvaClient Interface to PvaClient
* @param pvaClientChannel Interface to PvaClientChannel
* @param pvRequest The request structure.
* @return The interface to the PvaClientMonitor.
*/
static PvaClientMonitorPtr create(
PvaClientPtr const &pvaClient,
PvaClientChannelPtr const & pvaClientChannel,
epics::pvData::PVStructurePtr const &pvRequest
);
/** @brief Create a PvaClientMonitor.
* @param pvaClient Interface to PvaClient
* @param channelName channel name
* @param providerName provider name
* @param request The request.
* @param stateChangeRequester The state change requester. Can be null.
* @param monitorRequester The monitor requester. Can be null;
* @return The new instance.
* @deprecated client can create PvaClientMonitor on first channel connect.
*/
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;
/** @brief Destructor
*/
~PvaClientMonitor();
/** @brief Call issueConnect and then waitConnect.
*
* An exception is thrown if connect fails.
*/
void connect();
/** @brief Issue the channelMonitor connection to the channel.
*
* This can only be called once.
* An exception is thrown if connect fails.
* @throw runtime_error if failure.
*/
void issueConnect();
/** @brief Wait until the channelMonitor connection to the channel is complete.
* @return status;
*/
epics::pvData::Status waitConnect();
/** @brief Set a user callback.
* @param pvaClientMonitorRequester The requester which must be implemented by the caller.
*/
void setRequester(PvaClientMonitorRequesterPtr const & pvaClientMonitorRequester);
/** @brief Start monitoring.
*/
void start();
/**
* @brief Start or restart the monitor with a new request.
*
* @param request The new request.
*/
void start(const std::string & request);
/** @brief Stop monitoring.
*/
void stop();
/** @brief Poll for a monitor event.
*
* The data will be in PvaClientData.
* @return (false,true) means event (did not, did) occur.
*/
bool poll();
/** @brief Wait for a monitor event.
*
* The data will be in PvaClientData.
* @param secondsToWait Time to wait for event.
* @return (false,true) means event (did not, did) occur.
*/
bool waitEvent(double secondsToWait = 0.0);
/** @brief Release the monitorElement returned by poll
*/
void releaseEvent();
/** @brief Get the PvaClientChannel;
*
* @return The interface.
*/
PvaClientChannelPtr getPvaClientChannel();
/** @brief The data in which monitor events are placed.
*
* @return The interface.
*/
PvaClientMonitorDataPtr getData();
private:
std::string getRequesterName();
void message(std::string const & message,epics::pvData::MessageType messageType);
void monitorConnect(
const epics::pvData::Status& status,
epics::pvData::MonitorPtr const & monitor,
epics::pvData::StructureConstPtr const & structure);
void unlisten(epics::pvData::MonitorPtr const & monitor);
void monitorEvent(epics::pvData::MonitorPtr const & monitor);
PvaClientMonitor(
PvaClientPtr const &pvaClient,
PvaClientChannelPtr const & pvaClientChannel,
epics::pvData::PVStructurePtr const &pvRequest);
void checkMonitorState();
enum MonitorConnectState {connectIdle,connectWait,connectActive,connected};
PvaClient::weak_pointer pvaClient;
PvaClientChannelPtr pvaClientChannel;
epics::pvData::PVStructurePtr pvRequest;
epics::pvData::Mutex mutex;
epics::pvData::Event waitForConnect;
epics::pvData::Event waitForEvent;
PvaClientMonitorDataPtr pvaClientData;
bool isStarted;
epics::pvData::Status monitorConnectStatus;
epics::pvData::MonitorPtr monitor;
epics::pvData::MonitorElementPtr monitorElement;
PvaClientMonitorRequesterWPtr pvaClientMonitorRequester;
MonitorConnectState connectState;
bool userPoll;
bool userWait;
MonitorRequesterImplPtr monitorRequester;
PvaClientChannelStateChangeRequesterWPtr pvaClientChannelStateChangeRequester; //deprecate
public:
void channelStateChange(PvaClientChannelPtr const & channel, bool isConnected); //deprecate
void event(PvaClientMonitorPtr const & monitor);
friend class MonitorRequesterImpl;
};
/**
* @brief Optional client callback.
*
* <a href = "../htmldoxygen/pvaClientRPCRequester.html">Overview of PvaClientRPCRequester</a>
*/
class PvaClientRPCRequester
{
public:
POINTER_DEFINITIONS(PvaClientRPCRequester);
virtual ~PvaClientRPCRequester() {}
/**
* @brief The request is done. This is always called with no locks held.
* @param status Completion status.
* @param pvaClientRPC The pvaClientRPC interface.
* @param pvResponse The response data for the RPC request or <code>null</code> if the request failed.
*/
virtual void requestDone(
const epics::pvData::Status& status,
PvaClientRPCPtr const & pvaClientRPC,
epics::pvData::PVStructure::shared_pointer const & pvResponse) = 0;
};
// NOTE: must use separate class that implements RPCRequester,
// because pvAccess holds a shared_ptr to RPCRequester instead of weak_pointer
class RPCRequesterImpl;
typedef std::tr1::shared_ptr<RPCRequesterImpl> RPCRequesterImplPtr;
/**
* @brief An easy to use alternative to RPC.
*
* <a href = "../htmldoxygen/pvaClientRPC.html">Overview of PvaClientRPC</a>
*/
class epicsShareClass PvaClientRPC :
public std::tr1::enable_shared_from_this<PvaClientRPC>
{
public:
POINTER_DEFINITIONS(PvaClientRPC);
/** @brief Create a PvaClientRPC.
* @param &pvaClient Interface to PvaClient
* @param channel Interface to Channel
* @return The interface to the PvaClientRPC.
*/
static PvaClientRPCPtr create(
PvaClientPtr const &pvaClient,
epics::pvAccess::Channel::shared_pointer const & channel);
/** @brief Create a PvaClientRPC.
* @param &pvaClient Interface to PvaClient
* @param channel Interface to Channel
* @param pvRequest The request structure.
* @return The interface to the PvaClientRPC.
*/
static PvaClientRPCPtr create(
PvaClientPtr const &pvaClient,
epics::pvAccess::Channel::shared_pointer const & channel,
epics::pvData::PVStructurePtr const &pvRequest
);
/** @brief Destructor
*/
~PvaClientRPC();
/**
* @brief Set a timeout for a request.
* @param responseTimeout The time in seconds to wait for a request to complete.
*/
void setResponseTimeout(double responseTimeout)
{
this->responseTimeout = responseTimeout;
}
/**
* @brief Get the responseTimeout.
* @return The value.
*/
double getResponseTimeout()
{
return responseTimeout;
}
/** @brief Call issueConnect and then waitConnect.
*
* An exception is thrown if connect fails.
*/
void connect();
/** @brief Issue the channelRPC connection to the channel.
*
* This can only be called once.
* An exception is thrown if connect fails.
* @throw runtime_error if failure.
*/
void issueConnect();
/** @brief Wait until the channelRPC connection to the channel is complete.
* @return status;
*/
epics::pvData::Status waitConnect();
/** @brief Issue a request and wait for response
*
* Note that if responseTimeout is ( lt 0.0, ge 0.0) then this (will, will not) block
* until response completes or timeout.
* @param pvArgument The data to send to the service.
* @return The result
* @throw runtime_error if failure.
*/
epics::pvData::PVStructure::shared_pointer request(
epics::pvData::PVStructure::shared_pointer const & pvArgument);
/** @brief issue a request and return immediately.
* @param pvArgument The data to send to the service.
* @param pvaClientRPCRequester The requester that is called with the result.
* @throw runtime_error if failure.
*/
void request(
epics::pvData::PVStructure::shared_pointer const & pvArgument,
PvaClientRPCRequesterPtr const & pvaClientRPCRequester);
private:
PvaClientRPC(
PvaClientPtr const &pvaClient,
epics::pvAccess::Channel::shared_pointer const & channel,
epics::pvData::PVStructurePtr const &pvRequest);
std::string getRequesterName();
void message(std::string const & message,epics::pvData::MessageType messageType);
void rpcConnect(
const epics::pvData::Status& status,
epics::pvAccess::ChannelRPC::shared_pointer const & channelRPC);
void requestDone(
const epics::pvData::Status& status,
epics::pvAccess::ChannelRPC::shared_pointer const & channelRPC,
epics::pvData::PVStructure::shared_pointer const & pvResponse);
void checkRPCState();
enum RPCConnectState {connectIdle,connectActive,connected};
epics::pvData::Status connectStatus;
RPCConnectState connectState;
PvaClient::weak_pointer pvaClient;
epics::pvAccess::Channel::weak_pointer channel;
epics::pvData::PVStructurePtr pvRequest;
epics::pvData::Mutex mutex;
epics::pvData::Event waitForConnect;
epics::pvData::Event waitForDone;
PvaClientRPCRequesterWPtr pvaClientRPCRequester;
RPCRequesterImplPtr rpcRequester;
epics::pvAccess::ChannelRPC::shared_pointer channelRPC;
epics::pvData::PVStructurePtr pvResponse;
enum RPCState {rpcIdle,rpcActive,rpcComplete};
RPCState rpcState;
double responseTimeout;
friend class RPCRequesterImpl;
};
}}
#endif /* PVACLIENT_H */
/** @page Overview Documentation
*
* <a href = "../pvaClientCPP.html">pvaClientCPP.html</a>
*
*/
Reference in New Issue View Git Blame Copy Permalink