Apama  10.15.3.4
com::apama::event Namespace Reference

Contains classes for handling events passed over the client API. More...

Classes

class  DisconnectableEventConsumer
 Derived class from EventConsumer which implements the disconnect API. More...
 
class  Event
 An Event object represents an event instance. More...
 
class  EventConsumer
 An EventConsumer can connect to the Engine through an EventSupplier and register to receive events. More...
 
class  EventSupplier
 An EventSupplier represents the resources created by the Engine to service a connection to an external sink of events. More...
 

Functions

AP_ENGINE_CLIENT_API EventcreateEvent (const char *eventString, const char *channelString)
 This function allows creation of an Event object. More...
 
AP_ENGINE_CLIENT_API void deleteEvent (Event *ev)
 This function allows deletion of an Event object. More...
 
AP_ENGINE_CLIENT_API void deleteEventSupplier (EventSupplier *evsup)
 This function disconnects and deletes an EventSupplier object. More...
 

Detailed Description

Contains classes for handling events passed over the client API.

Function Documentation

◆ createEvent()

AP_ENGINE_CLIENT_API Event* com::apama::event::createEvent ( const char *  eventString,
const char *  channelString 
)

This function allows creation of an Event object.

Parameters
eventStringC style string representing the event instance in EPL. Note that this string should be encoded in UTF-8.
channelStringC style string representing the channel
Returns
A reference to an Event object.

◆ deleteEvent()

AP_ENGINE_CLIENT_API void com::apama::event::deleteEvent ( Event ev)

This function allows deletion of an Event object.

Parameters
evA reference to an Event object.

◆ deleteEventSupplier()

AP_ENGINE_CLIENT_API void com::apama::event::deleteEventSupplier ( EventSupplier evsup)

This function disconnects and deletes an EventSupplier object.

It also stops the associated EventConsumer from receiving events.

Parameters
evsupA reference to an EventSupplier object.