An easy to use alternative to directly calling the Channel methods of pvAccess. More...

#include "pvaClient.h"

Inheritance diagram for epics::pvaClient::PvaClientChannel:

Collaboration diagram for epics::pvaClient::PvaClientChannel:

Public Member Functions
	POINTER_DEFINITIONS (PvaClientChannel)

	~PvaClientChannel ()
	Destructor. More...

void	setStateChangeRequester (PvaClientChannelStateChangeRequesterPtr const &stateChangeRequester)
	Set a client stateChangeRequester. More...

std::string	getChannelName ()
	Get the name of the channel to which PvaClientChannel is connected. More...

epics::pvAccess::Channel::shared_pointer	getChannel ()
	Get the the channel to which PvaClientChannel is connected. More...

void	connect (double timeout=5.0)
	Connect to the channel. More...

void	issueConnect ()
	Issue a connect request and return immediately. More...

epics::pvData::Status	waitConnect (double timeout=5.0)
	Wait until the connection completes or for timeout. More...

PvaClientFieldPtr	createField (std::string const &subField="")
	Create a PvaClientField for the specified subField. More...

PvaClientProcessPtr	createProcess (std::string const &request="")
	First call createRequest as implemented by pvDataCPP and then call the next method. More...

PvaClientProcessPtr	createProcess (epics::pvData::PVStructurePtr const &pvRequest)

PvaClientGetPtr	get (std::string const &request="field(value,alarm,timeStamp)")
	create a PvaChannelGet More...

PvaClientGetPtr	createGet (std::string const &request="field(value,alarm,timeStamp)")
	create a PvaClientGet. More...

PvaClientGetPtr	createGet (epics::pvData::PVStructurePtr const &pvRequest)
	Creates an PvaClientGet. More...

double	getDouble (std::string const &request="field(value)")
	Get the value as a double. More...

std::string	getString (std::string const &request="field(value)")

epics::pvData::shared_vector< const double >	getDoubleArray (std::string const &request="field(value)")
	Get the value as a double array. More...

epics::pvData::shared_vector< const std::string >	getStringArray (std::string const &request="field(value)")
	Get the value as a string array. More...

PvaClientPutPtr	put (std::string const &request="field(value)")
	create a PvaClientPut. More...

PvaClientPutPtr	createPut (std::string const &request="field(value)")
	create a PvaClientPut. More...

PvaClientPutPtr	createPut (epics::pvData::PVStructurePtr const &pvRequest)
	Create a PvaClientPut. More...

void	putDouble (double value, std::string const &request="field(value)")
	Put the value as a double. More...

void	putString (std::string const &value, std::string const &request="field(value)")
	Put the value as a string. More...

void	putDoubleArray (epics::pvData::shared_vector< const double > const &value, std::string const &request="field(value)")
	Copy the array to the value field. More...

void	putStringArray (epics::pvData::shared_vector< const std::string > const &value, std::string const &request="field(value)")
	Copy array to the value field. More...

void	putStringArray (std::vector< std::string > const &value, std::string const &request="field(value)")
	Copy array to the value field. More...

PvaClientPutGetPtr	createPutGet (std::string const &request="putField(argument)getField(result)")
	create a PvaClientPutGet. More...

PvaClientPutGetPtr	createPutGet (epics::pvData::PVStructurePtr const &pvRequest)
	Create a PvaClientPutGet. More...

PvaClientArrayPtr	createArray (std::string const &request="field(value)")
	Create a PvaClientArray. More...

PvaClientArrayPtr	createArray (epics::pvData::PVStructurePtr const &pvRequest)
	Create a PvaClientArray. More...

PvaClientMonitorPtr	monitor (std::string const &request="field(value,alarm,timeStamp)")
	Create a PvaClientMonitor. More...

PvaClientMonitorPtr	monitor (PvaClientMonitorRequesterPtr const &pvaClientMonitorRequester)
	Call the next method with request = "field(value,alarm,timeStamp)". More...

PvaClientMonitorPtr	monitor (std::string const &request, PvaClientMonitorRequesterPtr const &pvaClientMonitorRequester)
	Create and connect to a new PvaClientMonitor. More...

PvaClientMonitorPtr	createMonitor (std::string const &request="field(value,alarm,timeStamp)")
	First call createRequest as implemented by pvDataJava and then call the next method. More...

PvaClientMonitorPtr	createMonitor (epics::pvData::PVStructurePtr const &pvRequest)

epics::pvData::PVStructurePtr	rpc (epics::pvData::PVStructurePtr const &pvRequest, epics::pvData::PVStructurePtr const &pvArgument)
	Issue a channelRPC request. More...

epics::pvData::PVStructurePtr	rpc (epics::pvData::PVStructurePtr const &pvArgument)
	Issue a channelRPC request. More...

PvaClientRPCPtr	createRPC ()
	Create a PvaClientRPC. More...

PvaClientRPCPtr	createRPC (epics::pvData::PVStructurePtr const &pvRequest)
	Create a PvaClientRPC. More...

void	showCache ()
	Show the list of cached gets and puts. More...

size_t	cacheSize ()
	Get the number of cached gets and puts. More...

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)

Public Member Functions inherited from epics::pvAccess::ChannelRequester
	POINTER_DEFINITIONS (ChannelRequester)

	ChannelRequester ()

virtual	~ChannelRequester ()

virtual void	channelCreated (const epics::pvData::Status &status, Channel::shared_pointer const &channel)=0

virtual void	channelStateChange (Channel::shared_pointer const &channel, Channel::ConnectionState connectionState)=0

virtual std::tr1::shared_ptr< const PeerInfo >	getPeerInfo ()
	Return information on connected peer if applicable. More...

Public Member Functions inherited from epics::pvAccess::Requester
	POINTER_DEFINITIONS (Requester)

virtual	~Requester ()

virtual void	message (std::string const &message, MessageType messageType=errorMessage)

Friends
class	PvaClient

Additional Inherited Members
Public Types inherited from epics::pvAccess::ChannelRequester
typedef Channel	operation_type

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

Detailed Description

An easy to use alternative to directly calling the Channel methods of pvAccess.

Overview of PvaClientChannel

Definition at line 237 of file pvaClient.h.

Constructor & Destructor Documentation

epics::pvaClient::PvaClientChannel::~PvaClientChannel ( )

Destructor.

Definition at line 151 of file pvaClientChannel.cpp.

 {
     if(PvaClient::getDebug()) {
         cout  << "PvaClientChannel::~PvaClientChannel() "
              << " channelName " << channelName
             << endl;
     }
     if(PvaClient::getDebug()) showCache();
 }

Member Function Documentation

size_t epics::pvaClient::PvaClientChannel::cacheSize ( )

Get the number of cached gets and puts.

Definition at line 608 of file pvaClientChannel.cpp.

 {
     return pvaClientGetCache->cacheSize() + pvaClientPutCache->cacheSize();
 }

void epics::pvaClient::PvaClientChannel::channelCreated	(	const epics::pvData::Status &	status,
		epics::pvAccess::Channel::shared_pointer const &	channel
	)

virtual

Definition at line 161 of file pvaClientChannel.cpp.

 {
     if(PvaClient::getDebug()) {
         cout << "PvaClientChannel::channelCreated"
            << " channelName " << channelName
            << " connectState " << connectState
            << " isConnected " << (channel->isConnected() ? "true" : "false")
            << " status.isOK " << (status.isOK() ? "true" : "false")
            << endl;
     }
     Lock xx(mutex);
     this->channel = channel;
     if(connectState==connected) return;
     if(connectState!=connectActive) {
          string message("PvaClientChannel::channelCreated");
          message += " channel " + channelName
                  + " why was this called when connectState!=ConnectState.connectActive";
          throw std::runtime_error(message);
     }
     if(!status.isOK()) {
         string message("PvaClientChannel::channelCreated");
             + " status " +  status.getMessage() + " why??";
         throw std::runtime_error(message);
     }
     if(channel->isConnected()) {
         connectState = connected;
         waitForConnect.signal();
     }
 }

void epics::pvaClient::PvaClientChannel::channelStateChange	(	epics::pvAccess::Channel::shared_pointer const &	channel,
		epics::pvAccess::Channel::ConnectionState	connectionState
	)

virtual

Definition at line 191 of file pvaClientChannel.cpp.

 {
     if(PvaClient::getDebug()) {
         cout << " PvaClientChannel::channelStateChange "
         << " channelName " << channelName
         << " " << Channel::ConnectionStateNames[connectionState]
         << endl;
     }
     bool waitingForConnect = false;
     if(connectState==connectActive) waitingForConnect = true;
     if(connectionState!=Channel::CONNECTED) {
         Lock xx(mutex);
         string mess(channelName +
                 " connection state " + Channel::ConnectionStateNames[connectionState]);
         message(mess,errorMessage);
         connectState = notConnected;
     } else {
         Lock xx(mutex);
         this->channel = channel;
         connectState = connected;
     }
     if(waitingForConnect) {
          Lock xx(mutex);
          waitForConnect.signal();
     }
     PvaClientChannelStateChangeRequesterPtr req(stateChangeRequester.lock());
     if(req) {
          bool value = (connectionState==Channel::CONNECTED ? true :  false);
          req->channelStateChange(shared_from_this(),value);
     }
 }

void epics::pvaClient::PvaClientChannel::connect ( double timeout = 5.0 )

Connect to the channel.

This calls issueConnect and waitConnect.

Parameters

timeout The time to wait for connecting to the channel. The defaut is 5 seconds.

Exceptions

runtime_error if connection fails.

Definition at line 260 of file pvaClientChannel.cpp.

 {
     if(PvaClient::getDebug()) {
         cout << "PvaClientChannel::connect"
         << " channelName " << channelName << endl;
     }
     issueConnect();
     Status status = waitConnect(timeout);
     if(status.isOK()) return;
     if(PvaClient::getDebug()) cout << "PvaClientChannel::connect  waitConnect failed\n";
     string message = string("channel ") + channelName
                     + " PvaClientChannel::connect " + status.getMessage();
     throw std::runtime_error(message);
 }

PvaClientArrayPtr epics::pvaClient::PvaClientChannel::createArray ( std::string const & request = "field(value)" )

Create a PvaClientArray.

First call createRequest as implemented by pvDataJava and then call the next method.

Parameters

request The syntax of request is defined by the copy facility of pvData.

Returns: The interface.

Exceptions

runtime_error if failure.

PvaClientArrayPtr epics::pvaClient::PvaClientChannel::createArray ( epics::pvData::PVStructurePtr const & pvRequest )

Create a PvaClientArray.

Parameters

pvRequest The syntax of pvRequest is defined by the copy facility of pvData.

Returns: The interface.

Exceptions

runtime_error if failure.

Definition at line 510 of file pvaClientChannel.cpp.

 {
     if(connectState!=connected) connect(5.0);
     throw std::runtime_error("PvaClientChannel::createArray not implemented");
 }

PvaClientFieldPtr epics::pvaClient::PvaClientChannel::createField ( std::string const & subField = "" )

Create a PvaClientField for the specified subField.

Parameters

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.

Returns: The interface.

Definition at line 323 of file pvaClientChannel.cpp.

 {
     if(connectState!=connected) connect(5.0);
     throw std::runtime_error("PvaClientChannel::createField not implemented");
 }

PvaClientGetPtr epics::pvaClient::PvaClientChannel::createGet ( std::string const & request = "field(value,alarm,timeStamp)" )

create a PvaClientGet.

First call createRequest as implemented by pvData and then call the next method.

Parameters

request The syntax of request is defined by the copy facility of pvData.

Returns: The interface.

Exceptions

runtime_error if failure.

PvaClientGetPtr epics::pvaClient::PvaClientChannel::createGet ( epics::pvData::PVStructurePtr const & pvRequest )

Creates an PvaClientGet.

Parameters

pvRequest The syntax of request is defined by the copy facility of pvData.

Returns: The interface.; The interface.

Exceptions

runtime_error if failure.

Definition at line 375 of file pvaClientChannel.cpp.

 {
     if(connectState!=connected) connect(5.0);
     PvaClientPtr yyy = pvaClient.lock();
     if(!yyy) throw std::runtime_error("PvaClient was destroyed");
     return PvaClientGet::create(yyy,shared_from_this(),pvRequest);
 }

PvaClientMonitorPtr epics::pvaClient::PvaClientChannel::createMonitor ( std::string const & request = "field(value,alarm,timeStamp)" )

First call createRequest as implemented by pvDataJava and then call the next method.

Parameters

request The syntax of request is defined by the copy facility of pvData.

Returns: The interface.

Exceptions

runtime_error if failure.

PvaClientMonitorPtr epics::pvaClient::PvaClientChannel::createMonitor ( epics::pvData::PVStructurePtr const & pvRequest )

Create an PvaClientMonitor.

Parameters

pvRequest The syntax of pvRequest is defined by the copy facility of pvData.

Returns: The interface.

Exceptions

runtime_error if failure.

Definition at line 552 of file pvaClientChannel.cpp.

 {
     if(connectState!=connected) connect(5.0);
     PvaClientPtr yyy = pvaClient.lock();
     if(!yyy) throw std::runtime_error("PvaClient was destroyed");
     return PvaClientMonitor::create(yyy,shared_from_this(),pvRequest);
 }

PvaClientProcessPtr epics::pvaClient::PvaClientChannel::createProcess ( std::string const & request = "" )

First call createRequest as implemented by pvDataCPP and then call the next method.

Parameters

request The syntax of request is defined by the copy facility of pvData.

Returns: The interface.

Exceptions

runtime_error if failure.

PvaClientProcessPtr epics::pvaClient::PvaClientChannel::createProcess ( epics::pvData::PVStructurePtr const & pvRequest )

Creates a PvaClientProcess.

Parameters

pvRequest The syntax of pvRequest is defined by the copy facility of pvData.

Returns: The interface.

Exceptions

runtime_error if failure.

Definition at line 341 of file pvaClientChannel.cpp.

 {
     if(connectState!=connected) connect(5.0);
     PvaClientPtr yyy = pvaClient.lock();
     if(!yyy) throw std::runtime_error("PvaClient was destroyed");
     return PvaClientProcess::create(yyy,shared_from_this(),pvRequest);
 }

PvaClientPutPtr epics::pvaClient::PvaClientChannel::createPut ( std::string const & request = "field(value)" )

create a PvaClientPut.

First call createRequest as implemented by pvDataJava and then call the next method.

Parameters

request The syntax of request is defined by the copy facility of pvData.

Returns: The interface.

Exceptions

runtime_error if failure.

PvaClientPutPtr epics::pvaClient::PvaClientChannel::createPut ( epics::pvData::PVStructurePtr const & pvRequest )

Create a PvaClientPut.

Parameters

pvRequest The syntax of pvRequest is defined by the copy facility of pvData.

Returns: The interface.

Definition at line 430 of file pvaClientChannel.cpp.

 {
     if(connectState!=connected) connect(5.0);
     PvaClientPtr yyy = pvaClient.lock();
     if(!yyy) throw std::runtime_error("PvaClient was destroyed");
     return PvaClientPut::create(yyy,shared_from_this(),pvRequest);
 }

PvaClientPutGetPtr epics::pvaClient::PvaClientChannel::createPutGet ( std::string const & request = "putField(argument)getField(result)" )

create a PvaClientPutGet.

First call createRequest as implemented by pvDataJava and then calls the next method.

Parameters

request The syntax of request is defined by the copy facility of pvData.

Returns: The interface.

Exceptions

runtime_error if failure.

PvaClientPutGetPtr epics::pvaClient::PvaClientChannel::createPutGet ( epics::pvData::PVStructurePtr const & pvRequest )

Create a PvaClientPutGet.

Parameters

pvRequest The syntax of pvRequest is defined by the copy facility of pvData.

Returns: The interface.

Definition at line 488 of file pvaClientChannel.cpp.

 {
     if(connectState!=connected) connect(5.0);
     PvaClientPtr yyy = pvaClient.lock();
     if(!yyy) throw std::runtime_error("PvaClient was destroyed");
     return PvaClientPutGet::create(yyy,shared_from_this(),pvRequest);
 }

PvaClientRPCPtr epics::pvaClient::PvaClientChannel::createRPC ( )

Create a PvaClientRPC.

Returns: The interface.

Exceptions

runtime_error if failure.

Definition at line 576 of file pvaClientChannel.cpp.

 {
     if(connectState!=connected) connect(5.0);
     PvaClientPtr yyy = pvaClient.lock();
     if(!yyy) throw std::runtime_error("PvaClient was destroyed");
     return PvaClientRPC::create(yyy,channel);
 }

PvaClientRPCPtr epics::pvaClient::PvaClientChannel::createRPC ( epics::pvData::PVStructurePtr const & pvRequest )

Create a PvaClientRPC.

Parameters

pvRequest The pvRequest that must have the same interface as a pvArgument that is passed to an rpc request.

Returns: The interface.

Exceptions

runtime_error if failure.

Definition at line 584 of file pvaClientChannel.cpp.

 {
     if(connectState!=connected) connect(5.0);
     PvaClientPtr yyy = pvaClient.lock();
     if(!yyy) throw std::runtime_error("PvaClient was destroyed");
     return PvaClientRPC::create(yyy,channel,pvRequest);
 }

PvaClientGetPtr epics::pvaClient::PvaClientChannel::get ( std::string const & request = "field(value,alarm,timeStamp)" )

create a PvaChannelGet

Get a cached PvaClientGet or create and connect to a new PvaClientGet.

Returns: The interface.

Exceptions

runtime_error if failure.

Definition at line 350 of file pvaClientChannel.cpp.

 {
     PvaClientGetPtr pvaClientGet = pvaClientGetCache->getGet(request);
     if(!pvaClientGet) {
         pvaClientGet = createGet(request);
         pvaClientGet->connect();
         pvaClientGetCache->addGet(request,pvaClientGet);
     }
     pvaClientGet->get();
     return pvaClientGet;
 }

Channel::shared_pointer epics::pvaClient::PvaClientChannel::getChannel ( )

Get the the channel to which PvaClientChannel is connected.

Returns: The channel interface.

Definition at line 246 of file pvaClientChannel.cpp.

 {
     return channel;
 }

string epics::pvaClient::PvaClientChannel::getChannelName ( )

Get the name of the channel to which PvaClientChannel is connected.

Returns: The channel name.

Definition at line 241 of file pvaClientChannel.cpp.

 {
     return channelName;
 }

double epics::pvaClient::PvaClientChannel::getDouble ( std::string const & request = "field(value)" )

Get the value as a double.

Parameters

request The syntax of request is defined by the copy facility of pvData.

Returns: The value.

Exceptions

runtime_error if failure.

Definition at line 383 of file pvaClientChannel.cpp.

 {
      return get(request)->getData()->getDouble();
 }

shared_vector< const double > epics::pvaClient::PvaClientChannel::getDoubleArray ( std::string const & request = "field(value)" )

Get the value as a double array.

Parameters

request The syntax of request is defined by the copy facility of pvData.

Returns: The value.

Exceptions

runtime_error if failure.

Definition at line 393 of file pvaClientChannel.cpp.

 {
     return get(request)->getData()->getDoubleArray();
 }

string epics::pvaClient::PvaClientChannel::getRequesterName ( )

virtual

The requester must have a name.

Returns: The requester's name.

Implements epics::pvAccess::Requester.

Definition at line 225 of file pvaClientChannel.cpp.

 {
     PvaClientPtr yyy = pvaClient.lock();
     if(!yyy) return string("PvaClientChannel::getRequesterName() PvaClient isDestroyed");
     return yyy->getRequesterName();
 }

string epics::pvaClient::PvaClientChannel::getString ( std::string const & request = "field(value)" )

Get the value as a string.

Parameters

request The syntax of request is defined by the copy facility of pvData.

Returns: The value.

Exceptions

runtime_error if failure.

Definition at line 388 of file pvaClientChannel.cpp.

 {
     return get(request)->getData()->getString();
 }

shared_vector< const std::string > epics::pvaClient::PvaClientChannel::getStringArray ( std::string const & request = "field(value)" )

Get the value as a string array.

Parameters

request The syntax of request is defined by the copy facility of pvData.

Returns: The value.

Exceptions

runtime_error if failure.

Definition at line 398 of file pvaClientChannel.cpp.

 {
     return get(request)->getData()->getStringArray();
 }

void epics::pvaClient::PvaClientChannel::issueConnect ( )

Issue a connect request and return immediately.

Definition at line 275 of file pvaClientChannel.cpp.

 {
     if(PvaClient::getDebug()) {
         cout << "PvaClientChannel::issueConnect"
         << " channelName " << channelName << endl;
     }
     {
         Lock xx(mutex);
         if(connectState==connected) return;
         if(connectState!=connectIdle) {
            throw std::runtime_error("pvaClientChannel already connected");
         }
         connectState = connectActive;
     }
     ChannelProviderRegistry::shared_pointer reg(ChannelProviderRegistry::clients());
     channelProvider = reg->getProvider(providerName);
     if(!channelProvider) {
         throw std::runtime_error(channelName + " provider " + providerName + " not registered");
     }
     if(PvaClient::getDebug()) cout << "PvaClientChannel::issueConnect calling provider->createChannel\n";
     channel = channelProvider->createChannel(channelName,shared_from_this(),ChannelProvider::PRIORITY_DEFAULT);
     if(!channel) {
          throw std::runtime_error(channelName + " channelCreate failed ");
     }
 }

void epics::pvaClient::PvaClientChannel::message	(	std::string const &	message,
		epics::pvData::MessageType	messageType
	)

virtual

Definition at line 232 of file pvaClientChannel.cpp.

 {
     PvaClientPtr yyy = pvaClient.lock();
     if(!yyy) return;
     yyy->message(channelName + " " + message, messageType);
 }

PvaClientMonitorPtr epics::pvaClient::PvaClientChannel::monitor ( std::string const & request = "field(value,alarm,timeStamp)" )

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.

Parameters

request The syntax of request is defined by the copy facility of pvData.

Returns: The interface.

Exceptions

runtime_error if failure.

PvaClientMonitorPtr epics::pvaClient::PvaClientChannel::monitor ( PvaClientMonitorRequesterPtr const & pvaClientMonitorRequester )

Call the next method with request = "field(value,alarm,timeStamp)".

Parameters

pvaClientMonitorRequester The client callback.

Returns: The interface.

Exceptions

runtime_error if failure.

Definition at line 525 of file pvaClientChannel.cpp.

 {
       return monitor("field(value,alarm,timeStamp)",pvaClientMonitorRequester);
 }

PvaClientMonitorPtr epics::pvaClient::PvaClientChannel::monitor	(	std::string const &	request,
		PvaClientMonitorRequesterPtr const &	pvaClientMonitorRequester
	)

Create and connect to a new PvaClientMonitor.

Then call it's start method. If connection can not be made an exception is thrown.

Parameters

request	The syntax of request is defined by the copy facility of pvData.
pvaClientMonitorRequester	The client callback.

Returns: The interface.

Exceptions

runtime_error if failure.

epics::pvaClient::PvaClientChannel::POINTER_DEFINITIONS ( PvaClientChannel )

PvaClientPutPtr epics::pvaClient::PvaClientChannel::put ( std::string const & request = "field(value)" )

create a PvaClientPut.

Get a cached PvaClientPut or create and connect to a new PvaClientPut. Then call it's get method.

Parameters

request The syntax of request is defined by the copy facility of pvData.

Returns: The interface.

Exceptions

runtime_error if connection fails

Definition at line 404 of file pvaClientChannel.cpp.

 {
     PvaClientPutPtr pvaClientPut = pvaClientPutCache->getPut(request);
     if(pvaClientPut) return pvaClientPut;
     if(!pvaClientPut) {
         pvaClientPut = createPut(request);
         pvaClientPut->connect();
         pvaClientPut->get();
         pvaClientPutCache->addPut(request,pvaClientPut);
     }
     return pvaClientPut;
 }

void epics::pvaClient::PvaClientChannel::putDouble	(	double	value,
		std::string const &	request = `"field(value)"`
	)

Put the value as a double.

Parameters

value	The new value.
request	The syntax of request is defined by the copy facility of pvData.

Exceptions

runtime_error if failure.

Definition at line 438 of file pvaClientChannel.cpp.

 {
     PvaClientPutPtr clientPut = put(request);
     PvaClientPutDataPtr putData = clientPut->getData();
     putData->putDouble(value); clientPut->put();
 }

void epics::pvaClient::PvaClientChannel::putDoubleArray	(	epics::pvData::shared_vector< const double > const &	value,
		std::string const &	request = `"field(value)"`
	)

Copy the array to the value field.

Parameters

value	The new value.
request	The syntax of request is defined by the copy facility of pvData.

Exceptions

runtime_error if failure.

Definition at line 452 of file pvaClientChannel.cpp.

 {
     PvaClientPutPtr clientPut = put(request);
     PvaClientPutDataPtr putData = clientPut->getData();
     size_t n = value.size();
     shared_vector<double> valueArray(n);
     for(size_t i=0; i<n; ++i) valueArray[i] = value[i];
     putData->putDoubleArray(freeze(valueArray)); clientPut->put();
 }

void epics::pvaClient::PvaClientChannel::putString	(	std::string const &	value,
		std::string const &	request = `"field(value)"`
	)

Put the value as a string.

Parameters

value	The new value.
request	The syntax of request is defined by the copy facility of pvData.

Exceptions

runtime_error if failure.

Definition at line 445 of file pvaClientChannel.cpp.

 {
     PvaClientPutPtr clientPut = put(request);
     PvaClientPutDataPtr putData = clientPut->getData();
     putData->putString(value); clientPut->put();
 }

void epics::pvaClient::PvaClientChannel::putStringArray	(	epics::pvData::shared_vector< const std::string > const &	value,
		std::string const &	request = `"field(value)"`
	)

Copy array to the value field.

Parameters

value	The new value.
request	The syntax of request is defined by the copy facility of pvData.

Exceptions

runtime_error if failure.

void epics::pvaClient::PvaClientChannel::putStringArray	(	std::vector< std::string > const &	value,
		std::string const &	request = `"field(value)"`
	)

Copy array to the value field.

Parameters

value	The data used to update the channel value.
request	The request as a string to pass to createRequest.

Exceptions

runtime_error if failure.

PVStructurePtr epics::pvaClient::PvaClientChannel::rpc	(	epics::pvData::PVStructurePtr const &	pvRequest,
		epics::pvData::PVStructurePtr const &	pvArgument
	)

Issue a channelRPC request.

Parameters

pvRequest	The pvRequest that is passed to createRPC.
pvArgument	The argument for a request.

Returns: The result.

Exceptions

runtime_error if failure.

Definition at line 560 of file pvaClientChannel.cpp.

 {
 
     PvaClientRPCPtr rpc = createRPC(pvRequest);
     return rpc->request(pvArgument);
 }

PVStructurePtr epics::pvaClient::PvaClientChannel::rpc ( epics::pvData::PVStructurePtr const & pvArgument )

Issue a channelRPC request.

Parameters

pvArgument The argument for the request.

Returns: The result.

Exceptions

runtime_error if failure.

Definition at line 569 of file pvaClientChannel.cpp.

 {
     PvaClientRPCPtr rpc = createRPC();
     return rpc->request(pvArgument);
 }

void epics::pvaClient::PvaClientChannel::setStateChangeRequester ( PvaClientChannelStateChangeRequesterPtr const & stateChangeRequester )

Set a client stateChangeRequester.

Parameters

stateChangeRequester The client stateChangeRequester implementation.

Definition at line 251 of file pvaClientChannel.cpp.

 {
     this->stateChangeRequester = stateChangeRequester;
     bool isConnected = false;
     if(channel) isConnected = channel->isConnected();
     stateChangeRequester->channelStateChange(shared_from_this(),isConnected);
 }

void epics::pvaClient::PvaClientChannel::showCache ( )

Show the list of cached gets and puts.

Definition at line 592 of file pvaClientChannel.cpp.

 {
      if(pvaClientGetCache->cacheSize()>=1) {
          cout << "    pvaClientGet cache" << endl;
          pvaClientGetCache->showCache();
      } else {
          cout << "    pvaClientGet cache is empty\n";
      }
      if(pvaClientPutCache->cacheSize()>=1) {
          cout << "    pvaClientPut cache" << endl;
          pvaClientPutCache->showCache();
      } else {
         cout << "    pvaClientPut cache is empty\n";
      }
 }

Status epics::pvaClient::PvaClientChannel::waitConnect ( double timeout = 5.0 )

Wait until the connection completes or for timeout.

Parameters

timeout The time in seconds to wait. A value of 0 means forever.

Returns: status.

Definition at line 301 of file pvaClientChannel.cpp.

 {
     if(PvaClient::getDebug()) {
         cout << "PvaClientChannel::waitConnect"
         << " channelName " << channelName << endl;
     }
     {
         Lock xx(mutex);
         if(!channel) return Status(Status::STATUSTYPE_ERROR,"");
         if(channel->isConnected()) return Status::Ok;
     }
     if(timeout>0.0) {
         waitForConnect.wait(timeout);
     } else {
         waitForConnect.wait();
     }
     if(!channel) return Status(Status::STATUSTYPE_ERROR,"pvaClientChannel::waitConnect channel is null");
     if(channel->isConnected()) return Status::Ok;
     return Status(Status::STATUSTYPE_ERROR," not connected");
 }

Friends And Related Function Documentation

friend class PvaClient

friend

Definition at line 561 of file pvaClient.h.

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

modules/pvaClient/src/pv/pvaClient.h
modules/pvaClient/src/pvaClientChannel.cpp

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation