| Package | com.pcbsys.nirvana.client |
| Class | public class nProtobufEvent |
| Inheritance | nProtobufEvent  nConsumeEvent Object |
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | attributes : nEventAttributes
Method that returns the nEventAttributes for this event
| nConsumeEvent | |
| channelName : String [read-only]
This function will return the name of the channel that the event was delivered from. | nConsumeEvent | |
| dataGroupName : String [read-only]
Get the name of the nDataGroup that this event was published to
| nConsumeEvent | |
| eventData : ByteArray
Gets the event data set for this event
| nConsumeEvent | |
| eventID : Long
Gets the unique (for its channel) event id value
| nConsumeEvent | |
| eventTag : String
Gets the event tag set for this event
| nConsumeEvent | |
| isPersistent : Boolean
Returns the persistent flag. | nConsumeEvent | |
| isTransient : Boolean
Returns whether the event is transient. | nConsumeEvent | |
| properties : nEventProperties
Gets this event's properties
| nConsumeEvent | |
| ttl : Long
Returns time to live for the event, how long will it be stored on disk in a mixed channel
| nConsumeEvent | |
| typeName : String [read-only]
Returns the type name of the message in the nProtocolBufferEvent as a String
| nProtobufEvent | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
nProtobufEvent(data:ByteArray, descriptionName:ByteArray, tag:String)
Constructs a new nProtocolBufferEvent
| nProtobufEvent | ||
| ack(ackCB:Function = null):void
Sends an ack for this event to the server
| nConsumeEvent | |
| hasAttributes():Boolean
Method indicating whether there is an nEventAttributes associated with this event
| nConsumeEvent | |
| hasData():Boolean
Checks whether the event has data
| nConsumeEvent | |
| hasProperties():Boolean
Checks whether the event has a dictionary
| nConsumeEvent | |
| rollback(rollbackCB:Function = null):void
Tells the server that it does not ack this event. | nConsumeEvent | |
Property Detail
| typeName | property |
typeName:String [read-only] Returns the type name of the message in the nProtocolBufferEvent as a String
Implementation
public function get typeName():StringConstructor Detail
| nProtobufEvent | () | Constructor |
public function nProtobufEvent(data:ByteArray, descriptionName:ByteArray, tag:String)Constructs a new nProtocolBufferEvent
Parametersdata:ByteArray — a ByteArray of the protocol buffer description type name
| |
descriptionName:ByteArray — a ByteArray of the constructed message
| |
tag:String — the event tag in a ByteArray
|