hydroiceutil::EventJob Class Reference

#include <eventjob.h>

Inherits hydroiceutil::Job.

List of all members.

Public Member Functions
	EventJob (EventReceiver &receiver, const EventPtr &event, const std::string &signature="")
	EventJob (EventReceiver &receiver, int type)
	Constructor with an event type.
void	execute ()
virtual std::string	toString () const
	Returns the name of the job with the event type.
virtual int	expectedDuration () const
	Dispatching an event should be very quick.
Static Public Attributes
static int	_warnDurationUs = -1

---

Detailed Description

A special job which simply sends an event to the specified event receiver. By convention, the event receiver does not take much time processing the event.

---

Constructor & Destructor Documentation

EventJob::EventJob	(	EventReceiver &	receiver,
		const EventPtr &	event,
		const std::string &	signature = ""
	)

Constructor with an event. Optional signature may contain the sender and receiver of the event. If supplied, this information will be displayed when toString() is called. This is very useful for debuging, e.g. when the event is not excepted.

---

Member Function Documentation

void EventJob::execute

(

)

[virtual]

Sends event of specified type to the receiver. Throws gbxutilacfr::Exception if the receiver does not accept the event.

Implements hydroiceutil::Job.

References _warnDurationUs, hydroiceutil::EventReceiver::event(), hydroiceutil::now(), and toString().

---

Member Data Documentation

int EventJob::_warnDurationUs = -1 [static]

EXPERIMENTAL! Note that access to this variable is not thread-safe. Issue warning if event processing takes longer than this many microseconds. Duration is not measured and no warnings are issued if this value is negative (default).

Referenced by execute().

---

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

• eventjob.h
• eventjob.cpp