com.pcbsys.nirvana.client.nProtobufEvent Class Reference

This class represents a Google Protocol Buffer Event. More...

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

Public Member Functions

String getTypeName ()
 Returns the type name of the message in the nProtobufEvent as a String More...
 
 nProtobufEvent (byte[] data, String descriptionName)
 Constructs a new nProtobufEvent with the message type set to the type name of the message passed in. More...
 
 nProtobufEvent (String tag, byte[] data, String descriptionName)
 Constructs a new nProtobufEvent with the message type set to the type name of the message passed in. More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.client.nConsumeEvent
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...
 

Detailed Description

This class represents a Google Protocol Buffer Event.

A Google Protocol Buffer Event consists of the serialized Message and a string to identify what type of message is contained. The MessageType attribute in the event header is set to 6 to identify the message as a Protocol buffer event. Optionally a Google Protocol Buffer Event may also contain a tag.

Constructor & Destructor Documentation

com.pcbsys.nirvana.client.nProtobufEvent.nProtobufEvent ( byte[]  data,
String  descriptionName 
)

Constructs a new nProtobufEvent with the message type set to the type name of the message passed in.

Parameters
datathe constructed message.
descriptionNamethe google protocol buffer Description type name
com.pcbsys.nirvana.client.nProtobufEvent.nProtobufEvent ( String  tag,
byte[]  data,
String  descriptionName 
)

Constructs a new nProtobufEvent with the message type set to the type name of the message passed in.

Parameters
tagthe event tag
datathe google protocol buffer Description type name
descriptionName

Member Function Documentation

String com.pcbsys.nirvana.client.nProtobufEvent.getTypeName ( )

Returns the type name of the message in the nProtobufEvent as a String

Returns
the type name of the event's Message as a String