Inheritance diagram for epics::pvAccess::Monitor::Impl:

Collaboration diagram for epics::pvAccess::Monitor::Impl:

Public Member Functions
	Impl (ClientChannel::MonitorCallback *cb)

virtual	~Impl ()

void	callEvent (CallbackGuard &G, MonitorEvent::event_t evt=MonitorEvent::Fail)

void	cancel ()

virtual std::string	getRequesterName () OVERRIDE FINAL

virtual void	monitorConnect (pvd::Status const &status, pva::MonitorPtr const &operation, pvd::StructureConstPtr const &structure) OVERRIDE FINAL

virtual void	channelDisconnect (bool destroy) OVERRIDE FINAL

virtual void	monitorEvent (pva::MonitorPtr const &monitor) OVERRIDE FINAL

virtual void	unlisten (pva::MonitorPtr const &monitor) OVERRIDE FINAL

Public Member Functions inherited from pvac::detail::CallbackStorage
	CallbackStorage ()

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

virtual	~MonitorRequester ()

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

	ChannelBaseRequester ()

virtual	~ChannelBaseRequester ()

Public Member Functions inherited from pvac::detail::wrapped_shared_from_this< Monitor::Impl >
std::tr1::shared_ptr< Monitor::Impl >	internal_shared_from_this ()

Public Attributes
pva::Channel::shared_pointer	chan

operation_type::shared_pointer	op

bool	started

bool	done

bool	seenEmpty

ClientChannel::MonitorCallback *	cb

MonitorEvent	event

pva::MonitorElement::Ref	last

Public Attributes inherited from pvac::detail::CallbackStorage
epicsMutex	mutex

epicsEvent	wakeup

size_t	nwaitcb

epicsThreadId	incb

Static Public Attributes
static size_t	num_instances

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

Additional Inherited Members
Public Types inherited from epics::pvAccess::MonitorRequester
typedef Monitor	operation_type

Static Public Member Functions inherited from pvac::detail::wrapped_shared_from_this< Monitor::Impl >
static std::tr1::shared_ptr< Monitor::Impl >	build ()

static std::tr1::shared_ptr< Monitor::Impl >	build (A a)

static std::tr1::shared_ptr< Monitor::Impl >	build (A a, B b)

Detailed Description

Definition at line 25 of file clientMonitor.cpp.

Constructor & Destructor Documentation

epics::pvAccess::Monitor::Impl::Impl ( ClientChannel::MonitorCallback * cb )

inline

Definition at line 40 of file clientMonitor.cpp.

         :started(false)
         ,done(false)
         ,seenEmpty(false)
         ,cb(cb)
     {REFTRACE_INCREMENT(num_instances);}

virtual epics::pvAccess::Monitor::Impl::~Impl ( )

inlinevirtual

Definition at line 46 of file clientMonitor.cpp.

                     {
         CallbackGuard G(*this);
         cb = 0;
         G.wait(); // paranoia
         REFTRACE_DECREMENT(num_instances);
     }

Member Function Documentation

void epics::pvAccess::Monitor::Impl::callEvent	(	CallbackGuard &	G,
		MonitorEvent::event_t	evt = `MonitorEvent::Fail`
	)

inline

Definition at line 53 of file clientMonitor.cpp.

     {
         ClientChannel::MonitorCallback *cb=this->cb;
         if(!cb) return;
 
         event.event = evt;
 
         if(evt==MonitorEvent::Fail || evt==MonitorEvent::Cancel)
             this->cb = 0; // last event
 
         try {
             CallbackUse U(G);
             cb->monitorEvent(event);
             return;
         }catch(std::exception& e){
             if(!this->cb || evt==MonitorEvent::Fail) {
                 LOG(pva::logLevelError, "Unhandled exception in ClientChannel::MonitorCallback::monitorEvent(): %s", e.what());
                 return;
             } else {
                event.event = MonitorEvent::Fail;
                event.message = e.what();
             }
         }
         // continues error handling
         try {
             CallbackUse U(G);
             cb->monitorEvent(event);
             return;
         }catch(std::exception& e){
             LOG(pva::logLevelError, "Unhandled exception following exception in ClientChannel::MonitorCallback::monitorEvent(): %s", e.what());
         }
     }

void epics::pvAccess::Monitor::Impl::cancel ( )

inline

Definition at line 87 of file clientMonitor.cpp.

     {
         operation_type::shared_pointer temp;
         {
             // keepalive for safety in case callback wants to destroy us
             std::tr1::shared_ptr<Monitor::Impl> keepalive(internal_shared_from_this());
 
             CallbackGuard G(*this);
 
             last.reset();
 
             if(started && op) {
                 op->stop();
                 started = false;
             }
             temp.swap(op);
 
             callEvent(G, MonitorEvent::Cancel);
             G.wait();
         }
         if(temp)
             temp->destroy();
     }

virtual void epics::pvAccess::Monitor::Impl::channelDisconnect ( bool destroy )

inlinevirtual

Notification when underlying Channel becomes DISCONNECTED or DESTORYED

(re)connection is notified through a sub-class *Connect() method.

Any in-progress get()/put()/request()/start() is implicitly cancel()'d or stop()'d before this method is called.

Ownership of any PVStructures passed to completion callbacks (eg. ChannelGetRequester::getDone() ) is returned the operation

Parameters

destroy true for final disconnect.

Reimplemented from epics::pvAccess::ChannelBaseRequester.

Definition at line 150 of file clientMonitor.cpp.

     {
         std::tr1::shared_ptr<Monitor::Impl> keepalive(internal_shared_from_this());
         CallbackGuard G(*this);
         if(!cb || done) return;
         event.message = "Disconnect";
         started = false;
         callEvent(G, MonitorEvent::Disconnect);
     }

virtual std::string epics::pvAccess::Monitor::Impl::getRequesterName ( )

inlinevirtual

Definition at line 111 of file clientMonitor.cpp.

     {
         Guard G(mutex);
         return chan ? chan->getRequesterName() : "<dead>";
     }

virtual void epics::pvAccess::Monitor::Impl::monitorConnect	(	pvd::Status const &	status,
		pva::MonitorPtr const &	monitor,
		pvd::StructureConstPtr const &	structure
	)

inlinevirtual

Underlying Channel is connected and operation setup is complete. Call start() to begin subscription updates.

Parameters

status	Completion status.
monitor	The monitor
structure	The structure defining the data.

Implements epics::pvAccess::MonitorRequester.

Definition at line 118 of file clientMonitor.cpp.

     {
         std::tr1::shared_ptr<Monitor::Impl> keepalive(internal_shared_from_this());
         CallbackGuard G(*this);
         if(!cb || started || done) return;
 
         if(!status.isOK()) {
             event.message = status.getMessage();
         } else {
             event.message.clear();
         }
         if(!status.isSuccess()) {
             callEvent(G);
 
         } else {
             pvd::Status sts(operation->start());
             if(sts.isSuccess()) {
                 started = true;
                 /* storing raw pointer to operation, which is expected
                  * to outlive our 'op'.
                  */
                 last.attach(operation);
             } else {
                 event.message = sts.getMessage();
                 callEvent(G);
             }
         }
     }

virtual void epics::pvAccess::Monitor::Impl::monitorEvent ( pva::MonitorPtr const & monitor )

inlinevirtual

Monitor queue is not empty.

The requester must call Monitor.poll to get data.

Parameters

monitor The monitor.

Implements epics::pvAccess::MonitorRequester.

Definition at line 160 of file clientMonitor.cpp.

     {
         std::tr1::shared_ptr<Monitor::Impl> keepalive(internal_shared_from_this());
         CallbackGuard G(*this);
         if(!cb || done) return;
         event.message.clear();
 
         callEvent(G, MonitorEvent::Data);
     }

virtual void epics::pvAccess::Monitor::Impl::unlisten ( pva::MonitorPtr const & monitor )

inlinevirtual

No more subscription update will be sent.

Parameters

monitor The monitor.

Implements epics::pvAccess::MonitorRequester.

Definition at line 170 of file clientMonitor.cpp.

     {
         std::tr1::shared_ptr<Monitor::Impl> keepalive(internal_shared_from_this());
         CallbackGuard G(*this);
         if(!cb || done) return;
         done = true;
 
         if(seenEmpty)
             callEvent(G, MonitorEvent::Data);
         // else // wait until final poll()
     }

Member Data Documentation

ClientChannel::MonitorCallback* epics::pvAccess::Monitor::Impl::cb

Definition at line 33 of file clientMonitor.cpp.

pva::Channel::shared_pointer epics::pvAccess::Monitor::Impl::chan

Definition at line 29 of file clientMonitor.cpp.

bool epics::pvAccess::Monitor::Impl::done

Definition at line 31 of file clientMonitor.cpp.

MonitorEvent epics::pvAccess::Monitor::Impl::event

Definition at line 34 of file clientMonitor.cpp.

pva::MonitorElement::Ref epics::pvAccess::Monitor::Impl::last

Definition at line 36 of file clientMonitor.cpp.

size_t epics::pvAccess::Monitor::Impl::num_instances

static

Definition at line 38 of file clientMonitor.cpp.

operation_type::shared_pointer epics::pvAccess::Monitor::Impl::op

Definition at line 30 of file clientMonitor.cpp.

bool epics::pvAccess::Monitor::Impl::seenEmpty

Definition at line 31 of file clientMonitor.cpp.

bool epics::pvAccess::Monitor::Impl::started

Definition at line 31 of file clientMonitor.cpp.

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

modules/pvAccess/src/client/clientMonitor.cpp

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation