com::apama::epl::EventHandler Class Reference

An interface for subscribing to events and receiving them in the plug-in. More...

#include <epl_plugin.hpp>

Public Types
typedef EventHandlerSubscription	subscription_t
	Pointer to a type used to add and remove channels on a registered handler. More...
typedef std::unique_ptr< EventHandler >	ptr_t
	Pointer type for passing to registerEventHandler. More...

Public Member Functions
virtual	~EventHandler ()
	To allow virtual deletion. More...
virtual void	handleEvent (const char *type, data_t &&event, const char *channel)=0
	Implement this method to receive events. More...

Detailed Description

An interface for subscribing to events and receiving them in the plug-in.

Classes provide an instance of this to receive callbacks. EventHandler registration is done by CorrelatorInterface::registerEventHandler.

Member Typedef Documentation

ptr_t

typedef std::unique_ptr<EventHandler> com::apama::epl::EventHandler::ptr_t

Pointer type for passing to registerEventHandler.

subscription_t

typedef EventHandlerSubscription com::apama::epl::EventHandler::subscription_t

Pointer to a type used to add and remove channels on a registered handler.

Constructor & Destructor Documentation

~EventHandler()

virtual com::apama::epl::EventHandler::~EventHandler ( )

inlinevirtual

To allow virtual deletion.

Member Function Documentation

handleEvent()

virtual void com::apama::epl::EventHandler::handleEvent ( const char *  type, data_t &&  event, const char *  channel  )

pure virtual

Implement this method to receive events.

Parameters

type	The name of the event type
event	The event either in string form or in map form depending on what was specified at subscription type
channel	The channel the event is being delivered on.

---

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

• epl_plugin.hpp