openDAQ
Open data acquisition platform
IEventPacket Struct Referenceabstract

As with Data packets, Event packets travel along the signal paths. They are used to notify recipients of any relevant changes to the signal sending the packet. More...

+ Inheritance diagram for IEventPacket:
+ Collaboration diagram for IEventPacket:

Detailed Description

As with Data packets, Event packets travel along the signal paths. They are used to notify recipients of any relevant changes to the signal sending the packet.

Public Member Functions

virtual ErrCode INTERFACE_FUNC getEventId (IString **id)=0
 Gets the ID of the event as a string. In example "DATA_DESCRIPTOR_CHANGED". More...
 
virtual ErrCode INTERFACE_FUNC getParameters (IDict **parameters)=0
 Dictionary containing parameters as <String, BaseObject> pairs relevant to the event signalized by the Event packet. More...
 
- Public Member Functions inherited from IPacket
virtual ErrCode INTERFACE_FUNC getType (PacketType *type)=0
 Gets the packet's type. More...
 
virtual ErrCode INTERFACE_FUNC subscribeForDestructNotification (IPacketDestructCallback *packetDestructCallback)=0
 Subscribes for notification when the packet is destroyed. More...
 
virtual ErrCode INTERFACE_FUNC getRefCount (SizeT *refCount)=0
 Gets the reference count of the packet. More...
 
- Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC borrowInterface (const IntfID &intfID, void **obj) const =0
 Returns another interface which is supported by the object without incrementing the reference count. More...
 
virtual ErrCode INTERFACE_FUNC dispose ()=0
 Disposes all references held by the object. More...
 
virtual ErrCode INTERFACE_FUNC getHashCode (SizeT *hashCode)=0
 Returns hash code of the object. More...
 
virtual ErrCode INTERFACE_FUNC equals (IBaseObject *other, Bool *equal) const =0
 Compares object to another object for equality. More...
 
virtual ErrCode INTERFACE_FUNC toString (CharPtr *str)=0
 Returns a string representation of the object. More...
 
- Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC queryInterface (const IntfID &intfID, void **obj)=0
 Returns another interface which is supported by the object and increments the reference count. More...
 
virtual int INTERFACE_FUNC addRef ()=0
 Increments the reference count for an interface on an object. More...
 
virtual int INTERFACE_FUNC releaseRef ()=0
 Decrements the reference count for an interface on an object. More...
 

Member Function Documentation

◆ getEventId()

virtual ErrCode INTERFACE_FUNC getEventId ( IString **  id)
pure virtual

Gets the ID of the event as a string. In example "DATA_DESCRIPTOR_CHANGED".

Parameters
[out]idThe ID of the event.

◆ getParameters()

virtual ErrCode INTERFACE_FUNC getParameters ( IDict **  parameters)
pure virtual

Dictionary containing parameters as <String, BaseObject> pairs relevant to the event signalized by the Event packet.

Parameters
[out]parametersThe event parameters dictionary.