- com
- pcbsys
- nirvana
- client
- nEventAttributes
The nEventAttributes class is used by the nConsumeEvent object in order to store standard header values associated with nirvana client, p2p and JMS events. More...
#include <nEventAttributes.h>
Inherits CountableObject.
Public Member Functions | |
bool | allowMerging () |
If this flag is true, the event will be merged with the existing event on this Channel / Data Group. More... | |
unsigned char * | getApplicationId () |
Obtain the application id allocated to the event. More... | |
int | getApplicationIdLength () |
Obtain the application id length allocated to the event. More... | |
unsigned char * | getCorrelationId () |
Obtain the correlation id allocated to the event (JMS specific) More... | |
int | getCorrelationIdLength () |
Obtain the correlation id length allocated to the event (JMS specific) More... | |
longlong | getDeadEID () |
Obtain the id associated with the dead event, if the event is consumed from a stores used as a dead event store. More... | |
unsigned char * | getDeadEventChannel () |
Obtain the dead event store name allocated to the event if one exists. More... | |
unsigned char | getDeliveryMode () |
Obtain the delivery mode used for this event. More... | |
unsigned char * | getDestination () |
Obtain the destination allocated to the event. More... | |
unsigned char * | getEventType () |
Obtain the arbitrary value given to this event to represent it's type. More... | |
longlong | getExpiration () |
Obtain the expiration value allocated to the event. More... | |
unsigned char * | getJoinChannel () |
Obtain the join channel allocated to the event if the event was originally published via a channel join. More... | |
longlong | getJoinEID () |
Obtain the eid of the original event from the join channel. More... | |
unsigned char * | getJoinPath () |
Obtain the join path allocated to the event as it travels through the joined channels if the event was originally published via a channel join. More... | |
unsigned char * | getJoinRealm () |
Obtain the realm on which the join channel exists if the event was originally published via a channel join. More... | |
unsigned char * | getMessageId () |
Obtain the message id allocated to the event (JMS specific) More... | |
int | getMessageIdLength () |
Obtain the message id length allocated to the event (JMS specific) More... | |
unsigned char | getMessageType () |
Obtain the type of the event. More... | |
unsigned char | getPriority () |
Obtain the priority allocated to the event. More... | |
unsigned char * | getPublisherHost () |
Obtain the publisher host allocated to the event. More... | |
int | getPublisherHostLength () |
Obtain the length of the publisher host allocated to the event. More... | |
unsigned char * | getPublisherName () |
Obtain the publisher name allocated to the event. More... | |
int | getPublisherNameLength () |
Obtain the length of the publisher name allocated to the event. More... | |
int | getRedeliveredCount () |
Obtain the number of times the event has been redelivered. More... | |
unsigned char * | getReplyToName () |
Obtain the reply to name allocated to the event. More... | |
unsigned char | getReplyType () |
Obtain the reply type represented as a byte value. More... | |
unsigned char * | getSubscriberHost () |
Obtain the subscriber host allocated to the event. More... | |
int | getSubscriberId () |
Obtain the subscriber id allocated to the event. More... | |
unsigned char * | getSubscriberName () |
Obtain the subscriber name allocated to the event. More... | |
longlong | getTimestamp () |
Obtain the time stamp allocated to the event. More... | |
unsigned char * | getUserId () |
Obtain the user id allocated to the event. More... | |
bool | isDelta () |
Indicates if this event is a delta event. More... | |
bool | isRegistered () |
Indicates if this event was created by a nRegisteredEvent. More... | |
nEventAttributes (void) | |
Generate a new nEventAttributes object. | |
void | setAllowMerge (bool flag) |
Sets whether this event can be merged at the server for the Channel or Data Groups. More... | |
void | setApplicationId (unsigned char *pApplicationId, int applicationIdLength) |
Set the application id given to this event. More... | |
void | setCorrelationId (unsigned char *pCorrelationId, int correlationIdLength) |
Set the event correlation id (JMS specific) More... | |
void | setDeliveryMode (unsigned char deliveryMode) |
Set the delivery mode. More... | |
void | setDestination (unsigned char *pDestination, int destinationLength) |
Set the destination given to this event. More... | |
void | setEventType (unsigned char *type, int typeLength) |
Set the arbitrary event type given to this event. More... | |
void | setExpiration (longlong expiration) |
Set the event expiration value. More... | |
void | setMessageId (unsigned char *MessageId, int messageIdLength) |
Set the event message id (JMS specific) More... | |
void | setMessageType (unsigned char messageType) |
Set the event type. More... | |
void | setPriority (unsigned char myPriority) |
Set the event priority. More... | |
void | setPublisherHost (unsigned char *pPubHost, int pubHostLength) |
Set the publisher host value given to this event. More... | |
void | setPublisherName (unsigned char *pPubName, int pubNameLength) |
Set the publisher name given to this event. More... | |
void | setReplyToName (unsigned char *replyToName, int replyToNameLength) |
Set the reply to name given to this event. More... | |
void | setReplyType (unsigned char replyType) |
Set the reply type. More... | |
void | setSubscriberHost (unsigned char *pSubHost, int subHostLength) |
Obtain the subscriber host allocated to the event. More... | |
void | setSubscriberId (int subId) |
Set the subscriber id given to this event. More... | |
void | setSubscriberName (unsigned char *pSubName, int subNameLength) |
Set the subscriber name given to this event. More... | |
void | setSubscriberNames (std::string *pSubName, int arrayLength) |
Set the array of subscriber names this event will be delivered to. More... | |
void | setUserId (unsigned char *userId, int userIdLength) |
Set the user id given to this event. More... | |
The nEventAttributes class is used by the nConsumeEvent object in order to store standard header values associated with nirvana client, p2p and JMS events.
Not all values are set all the time. Some values are only set by the realm server, whereas other values are available to be programatically set.
The majority of values are specific to JMS Message headers, and as such would not be required to be used by a standard nConsumeEvent
bool com::pcbsys::nirvana::client::nEventAttributes::allowMerging | ( | ) |
If this flag is true, the event will be merged with the existing event on this Channel / Data Group.
unsigned char* com::pcbsys::nirvana::client::nEventAttributes::getApplicationId | ( | ) |
Obtain the application id allocated to the event.
int com::pcbsys::nirvana::client::nEventAttributes::getApplicationIdLength | ( | ) |
Obtain the application id length allocated to the event.
unsigned char* com::pcbsys::nirvana::client::nEventAttributes::getCorrelationId | ( | ) |
Obtain the correlation id allocated to the event (JMS specific)
int com::pcbsys::nirvana::client::nEventAttributes::getCorrelationIdLength | ( | ) |
Obtain the correlation id length allocated to the event (JMS specific)
longlong com::pcbsys::nirvana::client::nEventAttributes::getDeadEID | ( | ) |
Obtain the id associated with the dead event, if the event is consumed from a stores used as a dead event store.
unsigned char* com::pcbsys::nirvana::client::nEventAttributes::getDeadEventChannel | ( | ) |
Obtain the dead event store name allocated to the event if one exists.
unsigned char com::pcbsys::nirvana::client::nEventAttributes::getDeliveryMode | ( | ) |
Obtain the delivery mode used for this event.
unsigned char* com::pcbsys::nirvana::client::nEventAttributes::getDestination | ( | ) |
Obtain the destination allocated to the event.
unsigned char* com::pcbsys::nirvana::client::nEventAttributes::getEventType | ( | ) |
Obtain the arbitrary value given to this event to represent it's type.
longlong com::pcbsys::nirvana::client::nEventAttributes::getExpiration | ( | ) |
Obtain the expiration value allocated to the event.
unsigned char* com::pcbsys::nirvana::client::nEventAttributes::getJoinChannel | ( | ) |
Obtain the join channel allocated to the event if the event was originally published via a channel join.
longlong com::pcbsys::nirvana::client::nEventAttributes::getJoinEID | ( | ) |
Obtain the eid of the original event from the join channel.
unsigned char* com::pcbsys::nirvana::client::nEventAttributes::getJoinPath | ( | ) |
Obtain the join path allocated to the event as it travels through the joined channels if the event was originally published via a channel join.
unsigned char* com::pcbsys::nirvana::client::nEventAttributes::getJoinRealm | ( | ) |
Obtain the realm on which the join channel exists if the event was originally published via a channel join.
unsigned char* com::pcbsys::nirvana::client::nEventAttributes::getMessageId | ( | ) |
Obtain the message id allocated to the event (JMS specific)
int com::pcbsys::nirvana::client::nEventAttributes::getMessageIdLength | ( | ) |
Obtain the message id length allocated to the event (JMS specific)
unsigned char com::pcbsys::nirvana::client::nEventAttributes::getMessageType | ( | ) |
Obtain the type of the event.
unsigned char com::pcbsys::nirvana::client::nEventAttributes::getPriority | ( | ) |
Obtain the priority allocated to the event.
unsigned char* com::pcbsys::nirvana::client::nEventAttributes::getPublisherHost | ( | ) |
Obtain the publisher host allocated to the event.
int com::pcbsys::nirvana::client::nEventAttributes::getPublisherHostLength | ( | ) |
Obtain the length of the publisher host allocated to the event.
unsigned char* com::pcbsys::nirvana::client::nEventAttributes::getPublisherName | ( | ) |
Obtain the publisher name allocated to the event.
int com::pcbsys::nirvana::client::nEventAttributes::getPublisherNameLength | ( | ) |
Obtain the length of the publisher name allocated to the event.
int com::pcbsys::nirvana::client::nEventAttributes::getRedeliveredCount | ( | ) |
Obtain the number of times the event has been redelivered.
Only relevant for events delivered on queues
unsigned char* com::pcbsys::nirvana::client::nEventAttributes::getReplyToName | ( | ) |
Obtain the reply to name allocated to the event.
unsigned char com::pcbsys::nirvana::client::nEventAttributes::getReplyType | ( | ) |
Obtain the reply type represented as a byte value.
unsigned char* com::pcbsys::nirvana::client::nEventAttributes::getSubscriberHost | ( | ) |
Obtain the subscriber host allocated to the event.
int com::pcbsys::nirvana::client::nEventAttributes::getSubscriberId | ( | ) |
Obtain the subscriber id allocated to the event.
unsigned char* com::pcbsys::nirvana::client::nEventAttributes::getSubscriberName | ( | ) |
Obtain the subscriber name allocated to the event.
longlong com::pcbsys::nirvana::client::nEventAttributes::getTimestamp | ( | ) |
Obtain the time stamp allocated to the event.
unsigned char* com::pcbsys::nirvana::client::nEventAttributes::getUserId | ( | ) |
Obtain the user id allocated to the event.
bool com::pcbsys::nirvana::client::nEventAttributes::isDelta | ( | ) |
Indicates if this event is a delta event.
bool com::pcbsys::nirvana::client::nEventAttributes::isRegistered | ( | ) |
Indicates if this event was created by a nRegisteredEvent.
void com::pcbsys::nirvana::client::nEventAttributes::setAllowMerge | ( | bool | flag | ) |
Sets whether this event can be merged at the server for the Channel or Data Groups.
flag | true to permit the merge, false if not |
void com::pcbsys::nirvana::client::nEventAttributes::setApplicationId | ( | unsigned char * | pApplicationId, |
int | applicationIdLength | ||
) |
Set the application id given to this event.
*pApplicationId | the byte array value representing the application id of the event |
applicationIdLength | the length of the pApplicationId array |
void com::pcbsys::nirvana::client::nEventAttributes::setCorrelationId | ( | unsigned char * | pCorrelationId, |
int | correlationIdLength | ||
) |
Set the event correlation id (JMS specific)
pCorrelationId | the byte array value representing the correlation id of the event |
correlationIdLength | the length of the pCorrelationId array |
void com::pcbsys::nirvana::client::nEventAttributes::setDeliveryMode | ( | unsigned char | deliveryMode | ) |
Set the delivery mode.
deliveryMode | the byte value representing the delivery mode |
void com::pcbsys::nirvana::client::nEventAttributes::setDestination | ( | unsigned char * | pDestination, |
int | destinationLength | ||
) |
Set the destination given to this event.
*pDestination | the byte array value representing the destination used by the event |
destinationLength | the length of the pDestination array |
void com::pcbsys::nirvana::client::nEventAttributes::setEventType | ( | unsigned char * | type, |
int | typeLength | ||
) |
Set the arbitrary event type given to this event.
type | the byte array value representing the type of the event |
typeLength | the length of the type array |
void com::pcbsys::nirvana::client::nEventAttributes::setExpiration | ( | longlong | expiration | ) |
Set the event expiration value.
expiration | the long value representing the expiration of the event |
void com::pcbsys::nirvana::client::nEventAttributes::setMessageId | ( | unsigned char * | MessageId, |
int | messageIdLength | ||
) |
Set the event message id (JMS specific)
MessageId | the byte array value representing the message id of the event |
messageIdLength | the length of the MessageId array |
void com::pcbsys::nirvana::client::nEventAttributes::setMessageType | ( | unsigned char | messageType | ) |
Set the event type.
messageType | the byte value representing the type of the event |
void com::pcbsys::nirvana::client::nEventAttributes::setPriority | ( | unsigned char | myPriority | ) |
Set the event priority.
myPriority | the byte value representing the priority |
void com::pcbsys::nirvana::client::nEventAttributes::setPublisherHost | ( | unsigned char * | pPubHost, |
int | pubHostLength | ||
) |
Set the publisher host value given to this event.
pPubHost | the byte array value representing the publisher host of the event |
pubHostLength | the length of the pPubHost array |
void com::pcbsys::nirvana::client::nEventAttributes::setPublisherName | ( | unsigned char * | pPubName, |
int | pubNameLength | ||
) |
Set the publisher name given to this event.
pPubName | the byte array value representing the publisher name of the event |
pubNameLength | the length of the pPubName array |
void com::pcbsys::nirvana::client::nEventAttributes::setReplyToName | ( | unsigned char * | replyToName, |
int | replyToNameLength | ||
) |
Set the reply to name given to this event.
replyToName | the byte array value representing the reply to name of the event |
replyToNameLength | the length of the replyToName array |
void com::pcbsys::nirvana::client::nEventAttributes::setReplyType | ( | unsigned char | replyType | ) |
Set the reply type.
replyType | the byte representation of the reply type |
void com::pcbsys::nirvana::client::nEventAttributes::setSubscriberHost | ( | unsigned char * | pSubHost, |
int | subHostLength | ||
) |
Obtain the subscriber host allocated to the event.
*pSubHost | The subscriber host of the event |
subHostLength | The length of the subscriber host |
void com::pcbsys::nirvana::client::nEventAttributes::setSubscriberId | ( | int | subId | ) |
Set the subscriber id given to this event.
subId | the byte array value representing the subscriber id of the event |
void com::pcbsys::nirvana::client::nEventAttributes::setSubscriberName | ( | unsigned char * | pSubName, |
int | subNameLength | ||
) |
Set the subscriber name given to this event.
*pSubName | the subscriber name of the event |
subNameLength | the length of the subscriber name |
void com::pcbsys::nirvana::client::nEventAttributes::setSubscriberNames | ( | std::string * | pSubName, |
int | arrayLength | ||
) |
Set the array of subscriber names this event will be delivered to.
*pSubName | the subscriber name of the event |
arrayLength | the number of subscriber names in the array |
void com::pcbsys::nirvana::client::nEventAttributes::setUserId | ( | unsigned char * | userId, |
int | userIdLength | ||
) |
Set the user id given to this event.
userId | the byte array value representing the user id of the event |
userIdLength | the length of the userId array |