Function Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
B
 base64Decode, Nirvana.Utils
 base64Encode, Nirvana.Utils
C
 checkCommitStatus, Transaction
 commit, TransactionalQueue
 commitAll, TransactionalQueue
 createDictionary, Nirvana
 createEvent, Nirvana
 createSession, Nirvana
 createTransaction
G
 get, EventDictionary
 getAllowMerge, EventAttributes
 getApplicationID, EventAttributes
 getArrayType, EventDictionary
 getAttribute, EventAttributes
 getAttributeNames, EventAttributes
 getChannel, Session
 getConfig, Session
 getCorrelationID, EventAttributes
 getCurrentDriver, Session
 getCurrentEID, Channel
 getCurrentRealm, Session
 getData, Event
 getDataStreamID, Session
 getDeadEID, EventAttributes
 getDeadEventStore, EventAttributes
 getDeliveryMode, EventAttributes
 getDestination, EventAttributes
 getDictionary, Event
 getEID, Event
 getEventAttributes, Event
 getExpiration, EventAttributes
 getFilter
 getJoinChannel, EventAttributes
 getJoinEID, EventAttributes
 getJoinPath, EventAttributes
 getJoinRealm, EventAttributes
 getKeys, EventDictionary
 getMessageID, EventAttributes
 getMessageType, EventAttributes
 getName
 getPriority, EventAttributes
 getPublisherHost, EventAttributes
 getPublisherName, EventAttributes
 getQueue, Session
 getRedeliveredCount, EventAttributes
 getReplyToName, EventAttributes
 getReplyType, EventAttributes
 getResource, Event
 getResourceName, Event
 getResourceType
 getSession, Event
 getSessionID, Session
 getStartEID, Channel
 getStatus, Session
 getSubscriberHost, EventAttributes
 getSubscriberID, EventAttributes
 getSubscriberName, EventAttributes
 getTag, Event
 getTimeStamp, EventAttributes
 getTTL, Event
 getType
 getUserID, EventAttributes
 getUsername, Session
 getWindowSize, TransactionalQueue
H
 hasData, Event
 hasDictionary, Event
 hasTag, Event
I
 isDataStreamEnabled, Session
 isDelta, EventAttributes
 isLoggingEnabled, Nirvana.Utils
 isRedelivered, EventAttributes
 isRegistered, EventAttributes
 isSubscribed
L
 log, Nirvana.Utils.Logger
 logException, Nirvana.Utils.Logger
O
 on
P
 publish
 publishAndCommit, Transaction
 putArray, EventDictionary
 putBoolean, EventDictionary
 putByte, EventDictionary
 putChar, EventDictionary
 putDictionary, EventDictionary
 putDouble, EventDictionary
 putFloat, EventDictionary
 putInteger, EventDictionary
 putLong, EventDictionary
 putString, EventDictionary
R
 removeListener
 rollback, TransactionalQueue
S
 setAllowMerge, EventAttributes
 setApplicationID, EventAttributes
 setAttribute, EventAttributes
 setCorrelationID, EventAttributes
 setData, Event
 setDeliveryMode, EventAttributes
 setDestination, EventAttributes
 setEvent, Transaction
 setExpiration, EventAttributes
 setFilter
 setLogger, Nirvana.Utils.Logger
 setMessageID, EventAttributes
 setMessageType, EventAttributes
 setPriority, EventAttributes
 setPublisherHost, EventAttributes
 setPublisherName, EventAttributes
 setReplyToName, EventAttributes
 setReplyType, EventAttributes
 setStartEID, Channel
 setSubscriberHost, EventAttributes
 setSubscriberID, EventAttributes
 setSubscriberName, EventAttributes
 setTag, Event
 setTTL, Event
 setType, EventAttributes
 setUserID, EventAttributes
 setWindowSize, TransactionalQueue
 start, Session
 stop, Session
 subscribe
U
 unsubscribe
Takes a base64-encoded string and returns the base64 decoded value.
Takes a string and returns a base64 encoded representation of it.
this.checkCommitStatus = function (queryServer)
this.commit = function (event)
Commits the read of the supplied Event on the TransactionalQueue.
this.commitAll = function ()
Commits the read of all received Events on the TransactionalQueue.
function createDictionary()
Factory method to create a new, empty EventDictionary (typically for subsequent addition to an existing EventDictionary using EventDictionary.putDictionary()).
function createEvent()
Factory method to create a new, empty Universal Messaging Event (typically for subsequent publishing to a resource such as a Channel or Queue).
function createSession(config)
Creates and initializes (but does not start) a session object for communication with a Universal Messaging Realm Server.
this.createTransaction = function ()
Factory method to create a new Transaction for use on the Channel.
this.createTransaction = function ()
Factory method to create a new Transaction for use on the Queue.
this.createTransaction = function ()
Factory method to create a new Transaction for use on the TransactionalQueue.
EventDictionary.prototype.get = function (key)
Returns the value to which the EventDictionary maps the specified key.
EventAttributes.prototype.getAllowMerge = function ()
Returns true if the Event can be merged, or false otherwise.
EventAttributes.prototype.getApplicationID = function ()
Returns the application ID allocated to the Event.
EventDictionary.prototype.getArrayType = function (key)
Returns the type of the entries in the array value to which the EventDictionary maps the specified key.
EventAttributes.prototype.getAttribute = function (name)
Returns the value to which the EventAttributes maps the specified name.
EventAttributes.prototype.getAttributeNames = function ()
Returns an array of an attribute names in this EventAttributes object.
this.getChannel = function (channelName)
Returns the Channel object for the supplied channel name.
this.getConfig = function ()
Returns the configuration object for the Session.
EventAttributes.prototype.getCorrelationID = function ()
Returns the correlation ID allocated to the Event.
this.getCurrentDriver = function ()
Returns the name of the Session’s current transport driver.
this.getCurrentEID = function ()
Returns the Event ID (the “EID”) which an existing subscription to the Channel is at.
this.getCurrentRealm = function ()
Returns the RNAME (in protocol://host:port format) of the realm server to which the Session is currently connected.
Event.prototype.getData = function getData(dataFormat)
Returns the Event’s raw data, or undefined if it has no data.
this.getDataStreamID = function ()
Returns the Session’s current DataStream ID.
EventAttributes.prototype.getDeadEID = function ()
Returns an integer representing the EID of the Dead Event (assuming it was consumed from a dead event store).
EventAttributes.prototype.getDeadEventStore = function ()
Returns a string representing the name of the Dead Event’s dead event store (assuming it was consumed from a dead event store).
EventAttributes.prototype.getDeliveryMode = function ()
Returns the delivery mode used for the Event.
EventAttributes.prototype.getDestination = function ()
Returns the destination allocated to the Event.
Event.prototype.getDictionary = function getDictionary()
Returns the Event’s EventDictionary.
Event.prototype.getEID = function getEID()
Returns the Event’s ID (the EID).
Event.prototype.getEventAttributes = function getEventAttributes()
Returns the Event’s EventAttributes.
EventAttributes.prototype.getExpiration = function ()
Returns the expiration value allocated to the Event.
this.getFilter = function ()
Returns the SQL-style filter applied to an existing or subsequent subscription to the Channel.
this.getFilter = function ()
Returns the SQL-style filter applied to an existing or subsequent subscription to the Queue.
this.getFilter = function ()
Returns the SQL-style filter applied to an existing or subsequent subscription to the TransactionalQueue.
EventAttributes.prototype.getJoinChannel = function ()
Returns a string representing the name of the Channel from which the Event originated.
EventAttributes.prototype.getJoinEID = function ()
Returns an integer representing the EID of the original Event on the joined Channel.
EventAttributes.prototype.getJoinPath = function ()
Returns the names of all the Channels in the join path for the Event.
EventAttributes.prototype.getJoinRealm = function ()
Returns a string representing the details of the realm on which the joined Channel exists.
EventDictionary.prototype.getKeys = function ()
Returns an array of the keys contained in the EventDictionary.
EventAttributes.prototype.getMessageID = function ()
Returns the message ID allocated to the Event.
EventAttributes.prototype.getMessageType = function ()
Returns an integer representing the message type of the Event.
this.getName = function ()
Returns the Channel’s fully qualified name (e.g.
this.getName = function ()
Returns the Queue’s fully qualified name (e.g.
this.getName = function ()
Returns the TransactionalQueue’s fully qualified name (e.g.
EventAttributes.prototype.getPriority = function ()
Returns an integer representing the Event priority.
EventAttributes.prototype.getPublisherHost = function ()
Returns a string representing the publisher host.
EventAttributes.prototype.getPublisherName = function ()
Returns a string representing the publisher name.
this.getQueue = function (queueName,
isTransactionalReader)
Returns the Queue or TransactionalQueue object for the supplied queue name.
EventAttributes.prototype.getRedeliveredCount = function ()
Returns an integer representing the number of times the Event has been redelivered.
EventAttributes.prototype.getReplyToName = function ()
Returns the “reply to” name allocated to the Event.
EventAttributes.prototype.getReplyType = function ()
Returns an integer representing the reply type of the Event.
Event.prototype.getResource = function getResource()
Returns the resource object from which the Event was received, or null if this is a new client-created Event.
Event.prototype.getResourceName = function getResourceName()
Returns the name of the resource with which the Event is associated, or null if this is a new client-created Event.
this.getResourceType = function ()
Returns the constant Nirvana.CHANNEL_RESOURCE, which identifies this resource as a Channel.
this.getResourceType = function ()
Returns the constant Nirvana.QUEUE_RESOURCE, which identifies this resource as a Queue.
this.getResourceType = function ()
Returns the constant Nirvana.TRANSACTIONAL_QUEUE_RESOURCE, which identifies this resource as a TransactionalQueue.
Event.prototype.getSession = function getSession()
Returns the Session with which this Event is associated, or null if this is a new client-created Event.
this.getSessionID = function ()
Returns the Session’s current session ID.
this.getStartEID = function ()
Returns the Event ID (the “EID”) from which an existing subscription to the Channel started, or from which a subsequent subscription to the Channel will start.
this.getStatus = function ()
Returns the Session’s current status, which describes whether it is, for example, not yet started, connected, disconnected, or stopped.
EventAttributes.prototype.getSubscriberHost = function ()
Returns a string representing the subscriber host.
EventAttributes.prototype.getSubscriberID = function ()
Returns a string representing the subscriber ID.
EventAttributes.prototype.getSubscriberName = function ()
Returns a string representing the subscriber name.
Event.prototype.getTag = function getTag()
Returns the Event’s tag, or undefined if it has no data.
EventAttributes.prototype.getTimeStamp = function ()
Returns the Event’s publication timestamp as an integer value representing the number of milliseconds since 1 January 1970 00:00:00 UTC (Unix Epoch).
Event.prototype.getTTL = function getTTL()
Returns the Event’s TTL (Time-to-live) in milliseconds.
EventAttributes.prototype.getType = function ()
Returns the arbitrary type of the Event.
EventDictionary.prototype.getType = function (key)
Returns the type of the value to which the EventDictionary maps the specified key.
EventAttributes.prototype.getUserID = function ()
Returns the user ID given to the Event.
this.getUsername = function ()
Returns the username used in this Session.
this.getWindowSize = function ()
Returns the window size for transactional reading on the TransactionalQueue.
Event.prototype.hasData = function hasData()
Returns true if the Event has data, or false otherwise.
Event.prototype.hasDictionary = function hasDictionary()
Returns true if the Event has an EventDictionary, or false otherwise.
Event.prototype.hasTag = function hasTag()
Returns true if the Event has a tag, or false otherwise.
this.isDataStreamEnabled = function ()
Returns true or false, depending on whether the Session was configured to be DataStream-enabled (via setting of the dataStreamEnabled key in the configuration object passed as an optional parameter to Nirvana.createSession().
EventAttributes.prototype.isDelta = function ()
Returns true if the Event is a delta.
Returns true or false, depending on the value of a debugLevel key in the configuration object passed as an optional parameter to Nirvana.createSession().
EventAttributes.prototype.isRedelivered = function ()
Returns true if the Event is redelivered.
EventAttributes.prototype.isRegistered = function ()
Returns true if the Event is a “registered event”, or false otherwise.
this.isSubscribed = function ()
Returns true or false, depending on whether a subscription exists for the Channel.
this.isSubscribed = function ()
Returns true or false, depending on whether a subscription exists for the Queue.
this.isSubscribed = function ()
Returns true or false, depending on whether a subscription exists for the TransactionalQueue.
Log a message to the debug log.
Log an exception to the debug log.
this.on = function (observable,
listener)
Registers a single event listener on the Channel for observable events of the specified type (see Nirvana.Observe for applicable observables).
function on(observable,
listener)
Registers a single event listener on the Nirvana object for observable events of the specified type (see Nirvana.Observe for a list of applicable observables).
this.on = function (observable,
listener)
Registers a single event listener on the Queue for observable events of the specified type (see Nirvana.Observe for applicable observables).
this.on = function (observable,
listener)
Registers a single event listener on the Session for observable events of the specified type (see Nirvana.Observe for a list of applicable observables).
this.on = function (observable,
listener)
Registers a single event listener on the Transaction for observable events of the specified type (see Nirvana.Observe for applicable observables).
this.on = function (observable,
listener)
Registers a single event listener on the TransactionalQueue for observable events of the specified type (see Nirvana.Observe for applicable observables).
this.publish = function (event)
Publishes a Universal Messaging Event to the Channel.
this.publish = function (event)
Publishes a Universal Messaging Event to the Queue.
this.publish = function (event)
Publishes a Universal Messaging Event to the TransactionalQueue.
this.publishAndCommit = function ()
EventDictionary.prototype.putArray = function (key,
value,
arrType)
Associates the specified EventDictionary.ARRAY value with the specified key in this EventDictionary.
EventDictionary.prototype.putBoolean = function (key,
value)
Associates the specified EventDictionary.BOOLEAN value with the specified key in this EventDictionary.
EventDictionary.prototype.putByte = function (key,
value)
Associates the specified EventDictionary.BYTE value with the specified key in this EventDictionary.
EventDictionary.prototype.putChar = function (key,
value)
Associates the specified EventDictionary.CHARACTER value with the specified key in this EventDictionary.
EventDictionary.prototype.putDictionary = function (key,
value)
Associates the specified EventDictionary value with the specified key in this EventDictionary.
EventDictionary.prototype.putDouble = function (key,
value)
Associates the specified EventDictionary.DOUBLE value with the specified key in this EventDictionary.
EventDictionary.prototype.putFloat = function (key,
value)
Associates the specified EventDictionary.FLOAT value with the specified key in this EventDictionary.
EventDictionary.prototype.putInteger = function (key,
value)
Associates the specified EventDictionary.INTEGER value with the specified key in this EventDictionary.
EventDictionary.prototype.putLong = function (key,
value)
Associates the specified String value with the specified key in this EventDictionary.
EventDictionary.prototype.putString = function (key,
value)
Associates the specified String value with the specified key in this EventDictionary.
this.removeListener = function (observable,
listener)
Removes a specific listener for observable events of the specified type (see Nirvana.Observe for applicable observables).
function removeListener(observable,
listener)
Removes a specific listener for observable events of the specified type (see Nirvana.Observe for a list of applicable observables).
this.removeListener = function (observable,
listener)
Removes a specific listener for observable events of the specified type (see Nirvana.Observe for applicable observables).
this.removeListener = function (observable,
listener)
Removes a specific listener for observable events of the specified type (see Nirvana.Observe for a list of applicable observables).
this.removeListener = function (observable,
listener)
Removes a specific listener for observable events of the specified type (see Nirvana.Observe for applicable observables).
this.removeListener = function (observable,
listener)
Removes a specific listener for observable events of the specified type (see Nirvana.Observe for applicable observables).
this.rollback = function (event)
Performs a Roll back of the TransactionalQueue to the supplied Event.
EventAttributes.prototype.setAllowMerge = function (mergeValue)
EventAttributes.prototype.setApplicationID = function (applicationID)
EventAttributes.prototype.setAttribute = function (attributeName,
attributeValue)
Associates the specified value with the specified attribute name in this EventAttributes object.
EventAttributes.prototype.setCorrelationID = function (correlationID)
Event.prototype.setData = function setData(data,
dataFormat)
Sets the Event’s raw data.
EventAttributes.prototype.setDeliveryMode = function (deliveryMode)
EventAttributes.prototype.setDestination = function (destination)
this.setEvent = function (newEvent)
EventAttributes.prototype.setExpiration = function (expiration)
this.setFilter = function (newFilter)
Sets the SQL-style filter to be applied to a subsequent subscription to the Channel.
this.setFilter = function (newFilter)
Sets the SQL-style filter to be applied to a subsequent subscription to the Queue.
this.setFilter = function (newFilter)
Sets the SQL-style filter to be applied to a subsequent subscription to the TransactionalQueue.
Assigns a user-defined function as the default log function which is invoked as appropriate, depending on the value of a debugLevel key in the configuration object passed as an optional parameter to Nirvana.createSession().
EventAttributes.prototype.setMessageID = function (messageID)
EventAttributes.prototype.setMessageType = function (messageType)
EventAttributes.prototype.setPriority = function (priority)
EventAttributes.prototype.setPublisherHost = function (publisherHost)
Sets the publisher host.
EventAttributes.prototype.setPublisherName = function (publisherName)
Sets the publisher name.
EventAttributes.prototype.setReplyToName = function (replyToName)
EventAttributes.prototype.setReplyType = function (replyType)
this.setStartEID = function (eid)
Sets the Event ID (the “EID”) from which a subsequent subscription to the Channel shall start.
EventAttributes.prototype.setSubscriberHost = function (subscriberHost)
Sets the subscriber host.
EventAttributes.prototype.setSubscriberID = function (subscriberID)
EventAttributes.prototype.setSubscriberName = function (subscriberName)
Sets the subscriber name.
Event.prototype.setTag = function setTag(newTag)
Sets the Event’s tag.
Event.prototype.setTTL = function setTTL(newTTL)
Sets the Event’s TTL (Time-to-live) in milliseconds.
EventAttributes.prototype.setType = function (type)
EventAttributes.prototype.setUserID = function (userID)
this.setWindowSize = function (newWindowSize)
Sets the window size for transactional reading on the TransactionalQueue.
this.start = function ()
Starts the Session.
this.stop = function (forceClose)
Stops the Session.
this.subscribe = function ()
Subscribes to the Channel, and begins receiving events.
this.subscribe = function ()
Subscribes to the Queue, and begins receiving events.
this.subscribe = function (resourceArray)
Batch-subscribes to multiple Channel, Queue and/or TransactionalQueue resources with a single call to the server.
this.subscribe = function ()
Subscribes to the TransactionalQueue, and begins receiving events.
this.unsubscribe = function ()
Unsubscribes from the Channel, and stops receiving events.
this.unsubscribe = function ()
Unsubscribes from the Queue, and stops receiving events.
this.unsubscribe = function ()
Unsubscribes from the TransactionalQueue, and stops receiving events.