Apama  10.2.0.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
com::apama::event::EventConsumer Class Referenceabstract

An EventConsumer can connect to the Engine through an EventSupplier and register to receive events. More...

#include <engine_client_cpp.hpp>

Inheritance diagram for com::apama::event::EventConsumer:
com::apama::engine::EngineManagement com::apama::event::DisconnectableEventConsumer

Public Member Functions

virtual void sendEvents (const Event *const *events)=0
 This method must be defined in inherited classes to enable receiving of events. More...
 

Detailed Description

An EventConsumer can connect to the Engine through an EventSupplier and register to receive events.

In order to receive events from the Engine, a developer must inherit from this class and define its sendEvents method. This method is called by the EventSupplier when events are emitted from the Engine.

EventConsumers are not copiable

Member Function Documentation

virtual void com::apama::event::EventConsumer::sendEvents ( const Event *const *  events)
pure virtual

This method must be defined in inherited classes to enable receiving of events.

This method is called by an EventSupplier.

Note that EventSuppliers are not reentrant so calling the disconnect method on the calling EventSupplier is not permitted from within the sendEvents implementation.

Parameters
eventsA null-terminated array of pointers to Event objects.

Implemented in com::apama::engine::EngineManagement.

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