Apama  10.1.0.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
com::apama::event::EventSupplier Class Referenceabstract

An EventSupplier represents the resources created by the Engine to service a connection to an external sink of events. More...

#include <engine_client_cpp.hpp>

Public Member Functions

virtual void disconnect ()=0
 Disconnect the EventSupplier from its consumer. More...
 

Friends

AP_ENGINE_CLIENT_API void deleteEventSupplier (EventSupplier *evsup)
 This function disconnects and deletes an EventSupplier object. More...
 

Detailed Description

An EventSupplier represents the resources created by the Engine to service a connection to an external sink of events.

It filters the event output of the Engine by delivering only the events emitted on a particular set of channels. An EventSupplier passes events to an EventConsumer. EventSupplier objects should be freed using the com::apama::event::deleteEventSupplier function.

EventSupplier is not copiable

Member Function Documentation

virtual void com::apama::event::EventSupplier::disconnect ( )
pure virtual

Disconnect the EventSupplier from its consumer.

Disconnection is automatically performed as part of deleteEventSupplier so in most cases there is no need to call this method explicitly.

Exceptions
EngineException

Friends And Related Function Documentation

AP_ENGINE_CLIENT_API void deleteEventSupplier ( EventSupplier evsup)
friend

This function disconnects and deletes an EventSupplier object.

It also stops the associated EventConsumer from receiving events.

Parameters
evsupA reference to an EventSupplier object.

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