Client API

Namespaces
	pvac::detail

Classes
struct	pvac::Operation
	Handle for in-progress get/put/rpc operation. More...
struct	pvac::PutEvent
	Information on put completion. More...
struct	pvac::GetEvent
	Information on get/rpc completion. More...
struct	pvac::InfoEvent
struct	pvac::Monitor
	Handle for monitor subscription. More...
struct	pvac::MonitorEvent
	Information on monitor subscription/queue change. More...
struct	pvac::MonitorSync
struct	pvac::ConnectEvent
	information on connect/disconnect More...
struct	pvac::Timeout
	Thrown by blocking methods of ClientChannel on operation timeout. More...
class	pvac::ClientChannel
class	pvac::ClientProvider
	Central client context. More...

Functions
::std::ostream &	pvac::operator<< (::std::ostream &strm, const Operation &op)
::std::ostream &	pvac::operator<< (::std::ostream &strm, const Monitor &op)
::std::ostream &	pvac::operator<< (::std::ostream &strm, const ClientChannel &op)
::std::ostream &	pvac::operator<< (::std::ostream &strm, const ClientProvider &op)
detail::PutBuilder	pvac::ClientChannel::put (const epics::pvData::PVStructure::const_shared_pointer &pvRequest=epics::pvData::PVStructure::const_shared_pointer())
	Synchronious put operation. More...

Detailed Description

PVAccess network client (or other epics::pvAccess::ChannelProvider)

Usage:

1. Construct a ClientProvider
2. Use the ClientProvider to obtain a ClientChannel
3. Use the ClientChannel to begin an get, put, rpc, or monitor operation

Code examples

• examples_getme
• examples_putme
• examples_monitorme

Function Documentation

epicsShareFunc::std::ostream & pvac::operator<<	(	::std::ostream &	strm,
		const Monitor &	op
	)

Definition at line 260 of file clientMonitor.cpp.

{
    if(op.impl) {
        strm << "Monitor("
                "\"" << op.impl->chan->getChannelName() <<"\", "
                "\"" << op.impl->chan->getProvider()->getProviderName() <<"\", "
                "connected="<<(op.impl->chan->isConnected()?"true":"false")
             <<"\")";
    } else {
        strm << "Monitor()";
    }
    return strm;
}

epicsShareFunc::std::ostream & pvac::operator<<	(	::std::ostream &	strm,
		const Operation &	op
	)

Definition at line 336 of file client.cpp.

{
    if(op.impl) {
        op.impl->show(strm);
    } else {
        strm << "Operation()";
    }
    return strm;
}

epicsShareFunc::std::ostream & pvac::operator<<	(	::std::ostream &	strm,
		const ClientChannel &	op
	)

Definition at line 346 of file client.cpp.

{
    if(op.impl) {
        strm << "ClientChannel("
             << typeid(*op.impl->channel.get()).name()<<", "
                "\"" << op.impl->channel->getChannelName() <<"\", "
                "\"" << op.impl->channel->getProvider()->getProviderName() <<"\", "
                "connected="<<(op.impl->channel->isConnected()?"true":"false")
             <<"\")";
    } else {
        strm << "ClientChannel()";
    }
    return strm;
}

epicsShareFunc::std::ostream & pvac::operator<<	(	::std::ostream &	strm,
		const ClientProvider &	op
	)

Definition at line 361 of file client.cpp.

{
    if(op.impl) {
        strm << "ClientProvider("
             << typeid(*op.impl->provider.get()).name()<<", "
                "\""<<op.impl->provider->getProviderName()<<"\")";
    } else {
        strm << "ClientProvider()";
    }
    return strm;
}

detail::PutBuilder pvac::ClientChannel::put ( const epics::pvData::PVStructure::const_shared_pointer &  pvRequest = epics::pvData::PVStructure::const_shared_pointer() )

inline

Synchronious put operation.

Definition at line 574 of file client.h.

{
    return detail::PutBuilder(*this, pvRequest);
}