pvac::MonitorSync Struct Reference

#include "client.h"

Inheritance diagram for pvac::MonitorSync:

Collaboration diagram for pvac::MonitorSync:

Classes
struct	SImpl

Public Member Functions
	MonitorSync ()
	MonitorSync (const Monitor &, const std::tr1::shared_ptr< SImpl > &)
	~MonitorSync ()
bool	wait ()
bool	wait (double timeout)
bool	test ()
void	wake ()
Public Member Functions inherited from pvac::Monitor
	Monitor ()
	Monitor (const std::tr1::shared_ptr< Impl > &)
	~Monitor ()
std::string	name () const
	Channel name. More...
void	cancel ()
	Immediate cancellation. More...
bool	poll ()
bool	complete () const
bool	valid () const
	operator bool_type () const
void	reset ()

Public Attributes
MonitorEvent	event
Public Attributes inherited from pvac::Monitor
epics::pvData::PVStructure::const_shared_pointer	root
epics::pvData::BitSet	changed
epics::pvData::BitSet	overrun

Detailed Description

Subscription usable w/o callbacks

Basic usage is to call wait() or test(). If true is returned, then the 'event', 'root', 'changed', and 'overrun' members have been updated with a new event. Test 'event.event' first to find out which kind of event has occured.

Note that wait()/test() methods are distinct from base class poll(). wait()/test() check for the arrival of MonitorEvent while poll() checks for the availability of data (eg. following a Data event).

Definition at line 206 of file client.h.

Constructor & Destructor Documentation

pvac::MonitorSync::MonitorSync ( )

inline

Definition at line 209 of file client.h.

{}

pvac::MonitorSync::MonitorSync	(	const Monitor &	mon,
		const std::tr1::shared_ptr< SImpl > &	simpl
	)

Definition at line 318 of file clientSync.cpp.

    :Monitor(mon.impl)
    ,simpl(simpl)
{
    simpl->sub = mon;
    event.event = MonitorEvent::Fail;
}

pvac::MonitorSync::~MonitorSync

(

)

Definition at line 326 of file clientSync.cpp.

                          {
}

Member Function Documentation

bool pvac::MonitorSync::test

(

)

check if new event is immediately available. Does not block.

Definition at line 329 of file clientSync.cpp.

{
    if(!simpl) throw std::logic_error("No subscription");
    Guard G(simpl->mutex);
    event = simpl->last;
    simpl->last.event = MonitorEvent::Fail;
    bool ret = simpl->hadevent;
    simpl->hadevent = false;
    return ret;
}

bool pvac::MonitorSync::wait

(

)

wait for new event

Returns

true when a new event was received. false if wake() was called.

Definition at line 340 of file clientSync.cpp.

{
    if(!simpl) throw std::logic_error("No subscription");
    simpl->event->wait();
    Guard G(simpl->mutex);
    event = simpl->last;
    simpl->last.event = MonitorEvent::Fail;
    bool ret = simpl->hadevent;
    simpl->hadevent = false;
    return ret;
}

bool pvac::MonitorSync::wait

(

double

timeout

)

wait for new event

Returns

false on timeout

Definition at line 352 of file clientSync.cpp.

{
    if(!simpl) throw std::logic_error("No subscription");
    bool ret = simpl->event->wait(timeout);
    if(ret) {
        Guard G(simpl->mutex);
        event = simpl->last;
        simpl->last.event = MonitorEvent::Fail;
        ret = simpl->hadevent;
        simpl->hadevent = false;
    }
    return ret;
}

void pvac::MonitorSync::wake

(

)

Abort one call to wait(), either concurrent or future. Calls are queued. wait() will return with MonitorEvent::Fail.

Definition at line 366 of file clientSync.cpp.

                       {
    if(simpl) simpl->event->signal();
}

Member Data Documentation

MonitorEvent pvac::MonitorSync::event

most recent event updated only during wait() or poll()

Definition at line 231 of file client.h.

---

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

• modules/pvAccess/src/client/pva/client.h
• modules/pvAccess/src/client/clientSync.cpp