com.pcbsys.nirvana.client.nConsumeEvent Class Reference

This class represents a Nirvana event, which consists of either a tag and some data or an event dictionary and some data. More...

Inheritance diagram for com.pcbsys.nirvana.client.nConsumeEvent:

com.pcbsys.nirvana.client.nProtobufEvent

Public Member Functions

void ack ()
 Sends an ack for this event to the server.
nEventAttributes getAttributes ()
 Method that returns the nEventAttributes for this event.
string getChannelName ()
 This function will return the name of the channel / queue that the event was delivered from.
byte[] getEventData ()
 Gets the event data set for this event.
long getEventID ()
 Gets the unique (for its channel) event id value.
string getEventTag ()
 Gets the event tag set for this event.
string getFullChannelName ()
 This function will return the fully qualified name of the channel / queue that the event was delivered from.
nEventProperties getProperties ()
 Gets this event's properties.
string getPublishHost ()
 Return the hostname from which the event was published.
string getPublishUser ()
 Return the id of the user that published this event.
byte[] getSignature ()
 Returns the digital signature of the event if it was signed by the publisher else it returns.
long getTimestamp ()
 Return the time stamp of this event.
long getTTL ()
 Returns how long the event will be stored on disk in a mixed channel.
bool hasAttributes ()
 Method indicating whether there is an nEventAttributes associated with this event.
bool isEndOfChannel ()
 When you subscribe to a channel, and the channel's data contains a finite and reasonably static set of events,.
bool isPersistant ()
 Returns the persistent flag.
bool isTransient ()
 Returns whether the event is transient.
 nConsumeEvent (byte[] tag, nEventProperties properties, byte[] data)
 Constructs a new nConsumeEvent with the specified event tag, properties and data.
 nConsumeEvent (nEventProperties properties, string tag)
 Constructs a new nConsumeEvent with the specified event properties and tag.
 nConsumeEvent (string tag, nEventProperties properties, byte[] data)
 Constructs a new nConsumeEvent with the specified event properties and data.
 nConsumeEvent (nEventProperties properties, byte[] data)
 Constructs a new nConsumeEvent with the specified event properties and data.
 nConsumeEvent (string tag, byte[] data)
 Constructs a new nConsumeEvent with the specified event tag and data.
 nConsumeEvent (byte[] tag, byte[] data)
 Constructs a new nConsumeEvent with the specified event tag and data.
void rollback ()
 Tells the server that it does not ack this event.
void setAttributes (nEventAttributes attributes)
 Method that sets the nEventAttributes for this event.
void setEventID (long p_id)
 Set the eventID for this event.
void setPersistant (bool flag)
 Sets the persistent flag.
void setSubscriberHost (byte[] host)
 Sets the host name or ip address representing the consumers of this event.
void setSubscriberName (byte[] subName)
 Sets the session name that will be the only consumer of this event.
void setSubscriberNames (String[] subName)
 Sets the session names that will be the only consumers of this event.
void setTransient (bool flag)
 Sets whether the event is transient.
void setTTL (long ttl)
 Sets the TTL for this event.

Detailed Description

This class represents a Nirvana event, which consists of either a tag and some data or an event dictionary and some data.

Constructor & Destructor Documentation

com.pcbsys.nirvana.client.nConsumeEvent.nConsumeEvent ( byte[]  tag,
byte[]  data 
)

Constructs a new nConsumeEvent with the specified event tag and data.

Parameters:
tag the event tag byte[] encoded
data the event data byte[] encoded

com.pcbsys.nirvana.client.nConsumeEvent.nConsumeEvent ( string  tag,
byte[]  data 
)

Constructs a new nConsumeEvent with the specified event tag and data.

Parameters:
tag the event tag as a string
data the event data byte[] encoded

com.pcbsys.nirvana.client.nConsumeEvent.nConsumeEvent ( nEventProperties  properties,
byte[]  data 
)

Constructs a new nConsumeEvent with the specified event properties and data.

The event properties can be used to create filter rules.

Parameters:
properties the collection of key-value pairs that can be used for filter rules
data the event data byte[] encoded

com.pcbsys.nirvana.client.nConsumeEvent.nConsumeEvent ( string  tag,
nEventProperties  properties,
byte[]  data 
)

Constructs a new nConsumeEvent with the specified event properties and data.

The event properties can be used to create filter rules.

Parameters:
properties the collection of key-value pairs that can be used for filter rules
data the event data byte[] encoded

com.pcbsys.nirvana.client.nConsumeEvent.nConsumeEvent ( nEventProperties  properties,
string  tag 
)

Constructs a new nConsumeEvent with the specified event properties and tag.

The event properties can be used to create filter rules.

Parameters:
properties the collection of key-value pairs that can be used for filter rules
tag the event tag

com.pcbsys.nirvana.client.nConsumeEvent.nConsumeEvent ( byte[]  tag,
nEventProperties  properties,
byte[]  data 
)

Constructs a new nConsumeEvent with the specified event tag, properties and data.

The event properties can be used to create filter rules.

Parameters:
tag the event tag
properties the collection of key-value pairs that can be used for filter rules
data the event data byte[] encoded

Member Function Documentation

void com.pcbsys.nirvana.client.nConsumeEvent.ack (  ) 

Sends an ack for this event to the server.

Exceptions:
Exception If unable to send the rollback request to the server

nEventAttributes com.pcbsys.nirvana.client.nConsumeEvent.getAttributes (  ) 

Method that returns the nEventAttributes for this event.

Returns:
the nEventAttributes for this event
nEventAttributes

string com.pcbsys.nirvana.client.nConsumeEvent.getChannelName (  ) 

This function will return the name of the channel / queue that the event was delivered from.

Returns:
the name of the channel or queue

byte [] com.pcbsys.nirvana.client.nConsumeEvent.getEventData (  ) 

Gets the event data set for this event.

Returns:
a byte[] containing the encoded event data in the form it travels on the network

long com.pcbsys.nirvana.client.nConsumeEvent.getEventID (  ) 

Gets the unique (for its channel) event id value.

Returns:
a long specifying the unique (for its channel) event id attribute

string com.pcbsys.nirvana.client.nConsumeEvent.getEventTag (  ) 

Gets the event tag set for this event.

Returns:
a string specifying the event tag set for this event

string com.pcbsys.nirvana.client.nConsumeEvent.getFullChannelName (  ) 

This function will return the fully qualified name of the channel / queue that the event was delivered from.

Returns:
the fully qualified name of the channel or queue
Exceptions:
nBaseClientException If the fully qualified name is not set

nEventProperties com.pcbsys.nirvana.client.nConsumeEvent.getProperties (  ) 

Gets this event's properties.

Returns:
the collection of key-value pairs used to create filter rules

string com.pcbsys.nirvana.client.nConsumeEvent.getPublishHost (  ) 

Return the hostname from which the event was published.

This value will be obtained from the nEventAttributes associated with this event.

Returns:
the hostname from which the event was published
nEventAttributes

string com.pcbsys.nirvana.client.nConsumeEvent.getPublishUser (  ) 

Return the id of the user that published this event.

This value will be obtained from the nEventAttributes associated with this event.

Returns:
the user who published this event
nEventAttributes

byte [] com.pcbsys.nirvana.client.nConsumeEvent.getSignature (  ) 

Returns the digital signature of the event if it was signed by the publisher else it returns.

null.

Returns:
Variable length byte[] of the signature

long com.pcbsys.nirvana.client.nConsumeEvent.getTimestamp (  ) 

Return the time stamp of this event.

This value will be obtained from the nEventAttributes associated with this event.

Returns:
the time stamp when the event was received by the server
nEventAttributes

long com.pcbsys.nirvana.client.nConsumeEvent.getTTL (  ) 

Returns how long the event will be stored on disk in a mixed channel.

Returns:
Long millisecond time to keep on the server

bool com.pcbsys.nirvana.client.nConsumeEvent.hasAttributes (  ) 

Method indicating whether there is an nEventAttributes associated with this event.

Returns:
whether the nEventAttributes exists for this event
nEventAttributes

bool com.pcbsys.nirvana.client.nConsumeEvent.isEndOfChannel (  ) 

When you subscribe to a channel, and the channel's data contains a finite and reasonably static set of events,.

the last event in the channel is sent and marked as the end of the channel.

Returns:
bool flag indicating if this is the last event in the channel

bool com.pcbsys.nirvana.client.nConsumeEvent.isPersistant (  ) 

Returns the persistent flag.

If true the event is stored to disk on the server

Returns:
bool flag

bool com.pcbsys.nirvana.client.nConsumeEvent.isTransient (  ) 

Returns whether the event is transient.

If the event itself is transient, it will never be stored either in memory or on disk by the realm server, but simply discarded once it has been delivered to any consumers. This is the equivalent of publishing events on a Transient channel, however allows the transience to be specified on a per event basis.

Returns:
whether the event is transient
nChannelAttributes

void com.pcbsys.nirvana.client.nConsumeEvent.rollback (  ) 

Tells the server that it does not ack this event.

Exceptions:
Exception If unable to send the rollback request to the server

void com.pcbsys.nirvana.client.nConsumeEvent.setAttributes ( nEventAttributes  attributes  ) 

Method that sets the nEventAttributes for this event.

Parameters:
attributes nEventAttributes for this event
nEventAttributes

void com.pcbsys.nirvana.client.nConsumeEvent.setEventID ( long  p_id  ) 

Set the eventID for this event.

This method is for internal Nirvana use only

Parameters:
p_id the eventID for this event

void com.pcbsys.nirvana.client.nConsumeEvent.setPersistant ( bool  flag  ) 

Sets the persistent flag.

On mixed channels, if set, will cause this event to be stored to disk

Parameters:
flag bool flag

void com.pcbsys.nirvana.client.nConsumeEvent.setSubscriberHost ( byte[]  host  ) 

Sets the host name or ip address representing the consumers of this event.

By setting this, only connections matching the host name or ip address will consume this event. Wildcard * are also supported, so you can have *.abc.com fore example

Parameters:
host the host name or ip address of connections that will consume this event

void com.pcbsys.nirvana.client.nConsumeEvent.setSubscriberName ( byte[]  subName  ) 

Sets the session name that will be the only consumer of this event.

By setting this, no other subscribers, either on a queue or channel will consume this event.

Parameters:
subName the subscriber name, equal to the session name of the designated user

void com.pcbsys.nirvana.client.nConsumeEvent.setSubscriberNames ( String[]  subName  ) 

Sets the session names that will be the only consumers of this event.

By setting this, no other subscribers, either on a queue or channel will consume this event.

Parameters:
subName the subscriber names, equal to the session names of the designated users

void com.pcbsys.nirvana.client.nConsumeEvent.setTransient ( bool  flag  ) 

Sets whether the event is transient.

If the event itself is transient, it will never be stored either in memory or on disk by the realm server, but simply discarded once it has been delivered to any consumers. This is the equivalent of publishing events on a Transient channel, however allows the transience to be specified on a per event basis.

Parameters:
flag whether the event is transient

void com.pcbsys.nirvana.client.nConsumeEvent.setTTL ( long  ttl  ) 

Sets the TTL for this event.

On a mixed channel this time is how long the event is kept

Parameters:
ttl Time in milliseconds