com.pcbsys.nirvana.client.nEventAttributes Class Reference

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>

Public Member Functions
bool	allowMerging ()
	If this flag is true, the event will be merged with the existing event on this Channel / Data Group.
unsigned char *	getApplicationId ()
	Obtain the application id allocated to the event.
int	getApplicationIdLength ()
	Obtain the application id length allocated to the event.
unsigned char *	getCorrelationId ()
	Obtain the correlation id allocated to the event (JMS specific).
int	getCorrelationIdLength ()
	Obtain the correlation id length allocated to the event (JMS specific).
longlong	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 *	getDeadEventChannel ()
	Obtain the dead event store name allocated to the event if one exists.
unsigned char	getDeliveryMode ()
	Obtain the delivery mode used for this event.
unsigned char *	getDestination ()
	Obtain the destination allocated to the event.
unsigned char *	getEventType ()
	Obtain the arbitrary value given to this event to represent it's type.
longlong	getExpiration ()
	Obtain the expiration value allocated to the event.
unsigned char *	getJoinChannel ()
	Obtain the join channel allocated to the event if the event was originally published via a channel join.
longlong	getJoinEID ()
	Obtain the eid of the original event from the join channel.
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.
unsigned char *	getJoinRealm ()
	Obtain the realm on which the join channel exists if the event was originally published via a channel join.
unsigned char *	getMessageId ()
	Obtain the message id allocated to the event (JMS specific).
int	getMessageIdLength ()
	Obtain the message id length allocated to the event (JMS specific).
unsigned char	getMessageType ()
	Obtain the type of the event.
unsigned char	getPriority ()
	Obtain the priority allocated to the event.
unsigned char *	getPublisherHost ()
	Obtain the publisher host allocated to the event.
int	getPublisherHostLength ()
	Obtain the length of the publisher host allocated to the event.
unsigned char *	getPublisherName ()
	Obtain the publisher name allocated to the event.
int	getPublisherNameLength ()
	Obtain the length of the publisher name allocated to the event.
int	getRedeliveredCount ()
	Obtain the number of times the event has been redelivered.
unsigned char *	getReplyToName ()
	Obtain the reply to name allocated to the event.
unsigned char	getReplyType ()
	Obtain the reply type represented as a byte value.
unsigned char *	getSubscriberHost ()
	Obtain the subscriber host allocated to the event.
int	getSubscriberId ()
	Obtain the subscriber id allocated to the event.
unsigned char *	getSubscriberName ()
	Obtain the subscriber name allocated to the event.
longlong	getTimestamp ()
	Obtain the time stamp allocated to the event.
unsigned char *	getUserId ()
	Obtain the user id allocated to the event.
bool	isDelta ()
	Indicates if this event is a delta event.
bool	isRegistered ()
	Indicates if this event was created by a nRegisteredEvent.
	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.
void	setApplicationId (unsigned char *pApplicationId, int applicationIdLength)
	Set the application id given to this event.
void	setCorrelationId (unsigned char *pCorrelationId, int correlationIdLength)
	Set the event correlation id (JMS specific).
void	setDeliveryMode (unsigned char deliveryMode)
	Set the delivery mode.
void	setDestination (unsigned char *pDestination, int destinationLength)
	Set the destination given to this event.
void	setEventType (unsigned char *type, int typeLength)
	Set the arbitrary event type given to this event.
void	setExpiration (longlong expiration)
	Set the event expiration value.
void	setMessageId (unsigned char *MessageId, int messageIdLength)
	Set the event message id (JMS specific).
void	setMessageType (unsigned char messageType)
	Set the event type.
void	setPriority (unsigned char myPriority)
	Set the event priority.
void	setPublisherHost (unsigned char *pPubHost, int pubHostLength)
	Set the publisher host value given to this event.
void	setPublisherName (unsigned char *pPubName, int pubNameLength)
	Set the publisher name given to this event.
void	setReplyToName (unsigned char *replyToName, int replyToNameLength)
	Set the reply to name given to this event.
void	setReplyType (unsigned char replyType)
	Set the reply type.
void	setSubscriberHost (unsigned char *pSubHost, int subHostLength)
	Obtain the subscriber host allocated to the event.
void	setSubscriberId (int subId)
	Set the subscriber id given to this event.
void	setSubscriberName (unsigned char *pSubName, int subNameLength)
	Set the subscriber name given to this event.
void	setSubscriberNames (std::string *pSubName, int arrayLength)
	Set the array of subscriber names this event will be delivered to.
void	setUserId (unsigned char *userId, int userIdLength)
	Set the user id given to this event.

---

Detailed Description

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

Since:

4.0

---

Member Function Documentation

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.

Returns:

true if event can be merged

unsigned char* com.pcbsys.nirvana.client.nEventAttributes.getApplicationId

(

)

Obtain the application id allocated to the event.

Returns:

the application id

int com.pcbsys.nirvana.client.nEventAttributes.getApplicationIdLength

(

)

Obtain the application id length allocated to the event.

Returns:

the application id length

unsigned char* com.pcbsys.nirvana.client.nEventAttributes.getCorrelationId

(

)

Obtain the correlation id allocated to the event (JMS specific).

Returns:

the correlation id

int com.pcbsys.nirvana.client.nEventAttributes.getCorrelationIdLength

(

)

Obtain the correlation id length allocated to the event (JMS specific).

Returns:

the correlation id length

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.

Returns:

the dead event id

unsigned char* com.pcbsys.nirvana.client.nEventAttributes.getDeadEventChannel

(

)

Obtain the dead event store name allocated to the event if one exists.

Returns:

the dead event store used by the channel from which this event came represented as a byte array value

unsigned char com.pcbsys.nirvana.client.nEventAttributes.getDeliveryMode

(

)

Obtain the delivery mode used for this event.

Returns:

the byte value that represents the delivery mode

unsigned char* com.pcbsys.nirvana.client.nEventAttributes.getDestination

(

)

Obtain the destination allocated to the event.

Returns:

the destination represented as a byte array value

unsigned char* com.pcbsys.nirvana.client.nEventAttributes.getEventType

(

)

Obtain the arbitrary value given to this event to represent it's type.

Returns:

the message type represented as a byte array value

longlong com.pcbsys.nirvana.client.nEventAttributes.getExpiration

(

)

Obtain the expiration value allocated to the event.

Returns:

the expiration represented as a long value

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.

Returns:

the joined channel represented as a byte array value

longlong com.pcbsys.nirvana.client.nEventAttributes.getJoinEID

(

)

Obtain the eid of the original event from the join channel.

Returns:

the eid of the event from the joined channel represented as a long value

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.

Returns:

the join path of the event, represented as a byte array value

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.

Returns:

the joined channel's realm represented as a byte array value

unsigned char* com.pcbsys.nirvana.client.nEventAttributes.getMessageId

(

)

Obtain the message id allocated to the event (JMS specific).

Returns:

the message id

int com.pcbsys.nirvana.client.nEventAttributes.getMessageIdLength

(

)

Obtain the message id length allocated to the event (JMS specific).

Returns:

the message id length

unsigned char com.pcbsys.nirvana.client.nEventAttributes.getMessageType

(

)

Obtain the type of the event.

Returns:

the type represented as a byte value

unsigned char com.pcbsys.nirvana.client.nEventAttributes.getPriority

(

)

Obtain the priority allocated to the event.

Returns:

the priority represented as a byte value

unsigned char* com.pcbsys.nirvana.client.nEventAttributes.getPublisherHost

(

)

Obtain the publisher host allocated to the event.

Returns:

the publisher host

int com.pcbsys.nirvana.client.nEventAttributes.getPublisherHostLength

(

)

Obtain the length of the publisher host allocated to the event.

Returns:

the length of the publisher host

unsigned char* com.pcbsys.nirvana.client.nEventAttributes.getPublisherName

(

)

Obtain the publisher name allocated to the event.

Returns:

the publisher name

int com.pcbsys.nirvana.client.nEventAttributes.getPublisherNameLength

(

)

Obtain the length of the publisher name allocated to the event.

Returns:

the length of the publisher name

int com.pcbsys.nirvana.client.nEventAttributes.getRedeliveredCount

(

)

Obtain the number of times the event has been redelivered.

Only relevant for events delivered on queues

Returns:

the number of times the event has been redelivered via the queue

unsigned char* com.pcbsys.nirvana.client.nEventAttributes.getReplyToName

(

)

Obtain the reply to name allocated to the event.

Returns:

the reply to name represented as a byte array value

unsigned char com.pcbsys.nirvana.client.nEventAttributes.getReplyType

(

)

Obtain the reply type represented as a byte value.

Returns:

the reply type

unsigned char* com.pcbsys.nirvana.client.nEventAttributes.getSubscriberHost

(

)

Obtain the subscriber host allocated to the event.

Returns:

the subscriber host represented as a byte array value

int com.pcbsys.nirvana.client.nEventAttributes.getSubscriberId

(

)

Obtain the subscriber id allocated to the event.

Returns:

the subscriber id represented as an int value

unsigned char* com.pcbsys.nirvana.client.nEventAttributes.getSubscriberName

(

)

Obtain the subscriber name allocated to the event.

Returns:

the subscriber name represented as a byte array value

longlong com.pcbsys.nirvana.client.nEventAttributes.getTimestamp

(

)

Obtain the time stamp allocated to the event.

Returns:

the time stamp represented as a long value

unsigned char* com.pcbsys.nirvana.client.nEventAttributes.getUserId

(

)

Obtain the user id allocated to the event.

Returns:

the user id represented as a byte array value

bool com.pcbsys.nirvana.client.nEventAttributes.isDelta

(

)

Indicates if this event is a delta event.

Returns:

true if this event is a delta derived from a registered event update, false if the event is a full event (snapshot)

bool com.pcbsys.nirvana.client.nEventAttributes.isRegistered

(

)

Indicates if this event was created by a nRegisteredEvent.

Returns:

true if this event comes from 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.

Parameters:

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.

Parameters:

	*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).

Parameters:

	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.

Parameters:

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.

Parameters:

	*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.

Parameters:

	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.

Parameters:

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).

Parameters:

	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.

Parameters:

messageType

the byte value representing the type of the event

void com.pcbsys.nirvana.client.nEventAttributes.setPriority

(

unsigned char

myPriority

)

Set the event priority.

Parameters:

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.

Parameters:

	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.

Parameters:

	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.

Parameters:

	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.

Parameters:

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.

Parameters:

	*pSubHost	The subscriber host of the event
	subHostLength	The length of the subscriber host

Returns:

the subscriber host represented as a byte array value

void com.pcbsys.nirvana.client.nEventAttributes.setSubscriberId

(

int

subId

)

Set the subscriber id given to this event.

Parameters:

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.

Parameters:

	*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.

Parameters:

	*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.

Parameters:

	userId	the byte array value representing the user id of the event
	userIdLength	the length of the userId array