com::apama::epl::EventHandlerSubscription Class Reference

This type is returned from CorrelatorInterface::registerEventHandler and can be used to add and remove channels to the subscription for this event handler. More...

#include <epl_plugin.hpp>

Public Member Functions
	EventHandlerSubscription ()
	Create a dummy EventHandlerSubscription. More...
	EventHandlerSubscription (EventHandlerSubscription &&other)
	Move an EventHandlerSubscription. More...
EventHandlerSubscription &	operator= (EventHandlerSubscription &&other)
	Move an EventHandlerSubscription into this one. More...
void	addChannel (const char *channel)
	Add a channel subscription to this event handler. More...
bool	removeChannel (const char *channel)
	Remove a channel subscription from this event handler. More...
void	removeAllChannels ()
	Remove all channels from this handler and delete it. More...

Detailed Description

This type is returned from CorrelatorInterface::registerEventHandler and can be used to add and remove channels to the subscription for this event handler.

Constructor & Destructor Documentation

EventHandlerSubscription() [1/2]

com::apama::epl::EventHandlerSubscription::EventHandlerSubscription ( )

inline

Create a dummy EventHandlerSubscription.

EventHandlerSubscription() [2/2]

com::apama::epl::EventHandlerSubscription::EventHandlerSubscription ( EventHandlerSubscription &&  other )

inline

Move an EventHandlerSubscription.

Member Function Documentation

addChannel()

void com::apama::epl::EventHandlerSubscription::addChannel

(

const char *

channel

)

Add a channel subscription to this event handler.

operator=()

EventHandlerSubscription& com::apama::epl::EventHandlerSubscription::operator= ( EventHandlerSubscription &&  other )

inline

Move an EventHandlerSubscription into this one.

removeAllChannels()

void com::apama::epl::EventHandlerSubscription::removeAllChannels

(

)

Remove all channels from this handler and delete it.

Must not be called from within this class.

removeChannel()

bool com::apama::epl::EventHandlerSubscription::removeChannel

(

const char *

channel

)

Remove a channel subscription from this event handler.

If the number of subscriptions is reduced to 0 this handler will be deleted. Must not be called from within this class.

Returns

true if the last channel was removed, otherwise false

---

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

• epl_plugin.hpp