[DEPRECATED]
An interface class that should be implemented by event handlers which are registered via AP_CorrelatorInterface::subscribe. More...

#include <correlator_plugin.hpp>

Public Types
typedef std::shared_ptr< AP_EventHandlerInterface >	ptr_t

Public Member Functions
virtual	~AP_EventHandlerInterface ()

virtual void	handleEvent (const AP_Context &ctx, const char event, const char channel)=0

Detailed Description

[DEPRECATED]
An interface class that should be implemented by event handlers which are registered via AP_CorrelatorInterface::subscribe.

Deprecated:: This class has been deprecated.

Member Typedef Documentation

◆ ptr_t

typedef std::shared_ptr<AP_EventHandlerInterface> AP_EventHandlerInterface::ptr_t

Deprecated:: A smart-pointer type for managing lifetime of event handlers.

All event handlers must be stored in an AP_EventHandlerInterface::ptr_t. A reference is held by the correlator for each subscribed event handler. When the last reference is dropped, the event handler will be deleted.

Constructor & Destructor Documentation

◆ ~AP_EventHandlerInterface()

virtual AP_EventHandlerInterface::~AP_EventHandlerInterface ( )

inlinevirtual

Deprecated:: Ensure we have a virtual destructor, so that derived class destructors can be correctly called.

Member Function Documentation

◆ handleEvent()

virtual void AP_EventHandlerInterface::handleEvent	(	const AP_Context &	ctx,
		const char *	event,
		const char *	channel
	)

pure virtual

Deprecated:: Called for each event sent to a channel to which this event handler is subscribed.

Parameters

ctx	Execution context for this invocation of the event handler.
event	the event received. The event is represented as a string using the format described in the manual.
channel	The channel on which the event was received.

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

correlator_plugin.hpp

Public Types