This class represents a Nirvana event, which consists of either a tag and some data or an event dictionary and some data. More...
Public Member Functions | |
| new void | ack () |
| Sends an ack for this event to the server More... | |
| nEventAttributes | getAttributes () |
| Method that returns the nEventAttributes for this event More... | |
| string | getChannelName () |
| This function will return the name of the channel / queue that the event was delivered from. More... | |
| String | getDataGroupName () |
| This function will return the data group name, if any, which this event was sent from. More... | |
| new byte[] | getEventData () |
| Gets the event data set for this event More... | |
| new long | getEventID () |
| Gets the unique (for its channel) event id value More... | |
| nConsumeEventToken | getEventIdentifier () |
| Get the identifier corresponding to the event. More... | |
| new string | getEventTag () |
| Gets the event tag set for this event More... | |
| string | getFullChannelName () |
| This function will return the fully qualified name of the channel / queue that the event was delivered from. More... | |
| new nEventProperties | getProperties () |
| Gets this event's properties More... | |
| string | getPublishHost () |
| Return the hostname from which the event was published. More... | |
| string | getPublishUser () |
| Return the id of the user that published this event. More... | |
| new byte[] | getSignature () |
| Returns the digital signature of the event if it was signed by the publisher else it returns More... | |
| long | getTimestamp () |
| Return the time stamp of this event. More... | |
| new long | getTTL () |
| Returns how long the event will be stored on disk in a mixed channel More... | |
| bool | hasAttributes () |
| Method indicating whether there is an nEventAttributes associated with this event More... | |
| bool | isEndOfChannel () |
| When you subscribe to a channel, and the channel's data contains a finite and reasonably static set of events, More... | |
| new bool | isPersistant () |
| Returns the persistent flag. More... | |
| new bool | isTransient () |
| Returns whether the event is transient. More... | |
| nConsumeEvent (byte[] tag, byte[] data) | |
| Constructs a new nConsumeEvent with the specified event tag and data More... | |
| nConsumeEvent (string tag, byte[] data) | |
| Constructs a new nConsumeEvent with the specified event tag and data More... | |
| nConsumeEvent (nEventProperties properties, byte[] data) | |
| Constructs a new nConsumeEvent with the specified event properties and data. More... | |
| nConsumeEvent (string tag, nEventProperties properties, byte[] data) | |
| Constructs a new nConsumeEvent with the specified event properties and data. More... | |
| nConsumeEvent (nEventProperties properties, string tag) | |
| Constructs a new nConsumeEvent with the specified event properties and tag. More... | |
| nConsumeEvent (byte[] tag, nEventProperties properties, byte[] data) | |
| Constructs a new nConsumeEvent with the specified event tag, properties and data. More... | |
| new void | rollback () |
| Tells the server that it does not ack this event. More... | |
| void | setAttributes (nEventAttributes attributes) |
| Method that sets the nEventAttributes for this event More... | |
| new void | setEventID (long p_id) |
| Set the eventID for this event. More... | |
| new void | setPersistant (bool flag) |
| Sets the persistent flag. More... | |
| new void | setProperties (nEventProperties newProperties) |
| Gets this event's properties More... | |
| void | setSubscriberHost (byte[] host) |
| Sets the host name or ip address representing the consumers of this event. More... | |
| void | setSubscriberName (byte[] subName) |
| Sets the session name that will be the only consumer of this event. More... | |
| void | setSubscriberNames (String[] subName) |
| Sets the session names that will be the only consumers of this event. More... | |
| new void | setTransient (bool flag) |
| Sets whether the event is transient. More... | |
| new void | setTTL (long ttl) |
| Sets the TTL for this event. More... | |
This class represents a Nirvana event, which consists of either a tag and some data or an event dictionary and some data.
| com.pcbsys.nirvana.client.nConsumeEvent.nConsumeEvent | ( | byte[] | tag, |
| byte[] | data | ||
| ) |
Constructs a new nConsumeEvent with the specified event tag and data
| 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
| 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.
| 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.
| tag | tag the event tag byte[] encoded |
| 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.
| 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.
| tag | the event tag |
| properties | the collection of key-value pairs that can be used for filter rules |
| data | the event data byte[] encoded |
| new void com.pcbsys.nirvana.client.nConsumeEvent.ack | ( | ) |
Sends an ack for this event to the server
| System.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
| string com.pcbsys.nirvana.client.nConsumeEvent.getChannelName | ( | ) |
This function will return the name of the channel / queue that the event was delivered from.
| String com.pcbsys.nirvana.client.nConsumeEvent.getDataGroupName | ( | ) |
This function will return the data group name, if any, which this event was sent from.
| new byte [] com.pcbsys.nirvana.client.nConsumeEvent.getEventData | ( | ) |
Gets the event data set for this event
| new long com.pcbsys.nirvana.client.nConsumeEvent.getEventID | ( | ) |
Gets the unique (for its channel) event id value
| nConsumeEventToken com.pcbsys.nirvana.client.nConsumeEvent.getEventIdentifier | ( | ) |
Get the identifier corresponding to the event.
| new string com.pcbsys.nirvana.client.nConsumeEvent.getEventTag | ( | ) |
Gets 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.
| nBaseClientException | If the fully qualified name is not set |
| new nEventProperties com.pcbsys.nirvana.client.nConsumeEvent.getProperties | ( | ) |
Gets this event's properties
| 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.
| 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.
| new 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.
| 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.
| new long com.pcbsys.nirvana.client.nConsumeEvent.getTTL | ( | ) |
Returns how long the event will be stored on disk in a mixed channel
| bool com.pcbsys.nirvana.client.nConsumeEvent.hasAttributes | ( | ) |
Method indicating whether there is an nEventAttributes associated with this event
| 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.
| new bool com.pcbsys.nirvana.client.nConsumeEvent.isPersistant | ( | ) |
Returns the persistent flag.
If true the event is stored to disk on the server
| new 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.
| new void com.pcbsys.nirvana.client.nConsumeEvent.rollback | ( | ) |
Tells the server that it does not ack this event.
| System.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
| attributes | nEventAttributes for this event |
| new void com.pcbsys.nirvana.client.nConsumeEvent.setEventID | ( | long | p_id | ) |
Set the eventID for this event.
This method is for internal Nirvana use only
| p_id | the eventID for this event |
| new 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
| flag | bool flag |
| new void com.pcbsys.nirvana.client.nConsumeEvent.setProperties | ( | nEventProperties | newProperties | ) |
Gets this event's properties
| 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
| 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.
| 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.
| subName | the subscriber names, equal to the session names of the designated users |
| nIllegalArgumentException | This exception is thrown if the mySubName array is larger than 32767 |
| new 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.
| flag | whether the event is transient |
| new 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
| ttl | Time in milliseconds |