com.pcbsys.nirvana.client.nSession

Package	com.pcbsys.nirvana.client
Class	public class nSession
Inheritance	nSession flash.events.EventDispatcher

This class represents a Nirvana session, the logical connection between the client API and the Nirvana realm. A Nirvana session is defined through a set of session attributes that is represented by the nSessionAttributes class in the same package. This set of attributes is then passed to the session factory object which creates the session. A session object needs to be initialised in order for the physical connection to be opened to the server. Note: Any callback function may raise a nSecurityError with the realm server and so that should be checked for on all callbacks. A nSelectorParserError could be raised with any function that sends a selector to the server this should also be checked for on those functions. Finally If a error is raised with the realm server on an asynchronous function then the error will be passed to the generic error callback set when the nSessionFactory.create() function is called. If this is not set or you want events to be dispatched then a nErrorEvent will be dispatched with either a nSecurityEventString or a nErrorEventString.

Public Properties

	Property		Defined By
		channelMultiplexing : Boolean Returns true if channel multiplexing has been enabled	nSession
		errorCB : Function the error function that is called if a failure occurs with Nirvana that has no current outstanding requests	nSession
		eventReceivedCount : Number [read-only] Return the number of events received by this session	nSession
		eventSentCount : Number [read-only] Return the number of events sent by this session	nSession
		id : Long [read-only] Returns the unique session Id for this session	nSession
		inputByteCount : Number [read-only] Returns the number of bytes received from the server on this session object	nSession
		oldRegisteredEventMerge : Boolean A check to see if the old merge has been enabled because as of version 6.0 the registered event merge has change and updates are only received on the client	nSession
		outputByteCount : Number [read-only] Returns the number of bytes sent to the server using this session object	nSession
		realmName : String [read-only] Returns the sessions server realm name	nSession
		remoteId : String [read-only] Returns the rName that this session has used	nSession
		sessionConnectionId : Long [read-only] Returns the unique connection id associated with this session by the server.	nSession
		streamId : String [read-only] Returns the unique stream id associated with this session by the server.	nSession
		subject : String [read-only] Gets the subject associated with this nirvana session	nSession

Public Methods

	Method		Defined By
		close():void Closes this session, disconnecting from the server	nSession
		closeInt(noWait:Boolean = false):void	nSession
		connectionList():String Returns a comma separated list of RNAMEs which can be used to access the realm or cluster namespace.	nSession
		createDataGroup(dataGroupName:String, callback:Function = null, listener:nDataGroupListener = null, conflationAttributes:nConflationAttributes = null):void Create a new data group on the server	nSession
		createDataGroups(dataGroupNames:Array, callback:Function = null, conflationAttributes:nConflationAttributes = null):void Create a new data group on the server	nSession
		createStore(attributes:nStoreAttributes, channelCreatedCB:Function = null, initialEID:Long = null):void Creates a new store on the realm this session is connected too.	nSession
		deleteDataGroup(group:nDataGroup):void Deletes the specified data group from the server	nSession
		deleteDataGroupArray(groups:Array):void Deletes the specified data group from the server	nSession
		deleteDataGroupByString(dataGroupName:String):void Deletes the specified data group from the server	nSession
		deleteStore(attributes:nStoreAttributes, storeDeletedCB:Function = null):void Deletes the specified store that exists on the realm this session is connected to, or a joined realm.	nSession
		find(attributes:Array, callback:Function = null):void Finds and returns an array of nFindResult objects that correspond to the results of the find operations on each nChannelAttributes.	nSession
		findStore(storeName:String, storeFoundCB:Function = null):void Finds and returns a nirvana channel that exists on the realm this session is connected to, or a joined realm.	nSession
		getAttributes():nSessionAttributes Gets the session attribute object associated with this session	nSession
		getDataGroups(callback:Function = null, listener:nDataGroupListener = null):void Retrieves the global data group containing all known data groups on the server	nSession
		getDefaultDataGroup(callback:Function = null, listener:nDataGroupListener = null):void Retrieves the default data group from Nirvana	nSession
		getGroupsContaining(group:nDataGroup):Array Locate the groups that currently contain this group	nSession
		getKnownGroupCount():int Get the size of the known data groups list	nSession
		getSessionId():Long Returns the unique connection id associated with this session by the server.	nSession
		getStores(storesCB:Function = null, folder:String = /):void Returns an array of all known channels and queues	nSession
		init(postInitCB:Function = null, connectionListener:nConnectionListener = null, disconnectIfClusterFails:Boolean = false, streamListener:nDataStreamListener = null):void Initialises a session object, opening the physical connection to the server	nSession
		isConnected():Boolean Returns true if this session is still connected with the remote realm	nSession
		isMember():Long Returns the unique connection id associated with this session by the server.	nSession
		manyToManyBatchWrite(events:Vector.<nConsumeEvent>, destinations:Vector.<nStore>, callback:Function = null, notifyOfComplete:Boolean = false):void Sends all of the events to all of the specified channels/queues	nSession
		oneToOneBatchWrite(events:Vector.<nConsumeEvent>, destinations:Vector.<nStore>, callback:Function = null, registeredEvent:Boolean = false, notifyOfComplete:Boolean = false):void Sends event x to destination x	nSession
		pauseStream():void Pause the events being received by the Data Group Listener.	nSession
		resumeStream():void Resumes the events being received by the Data Group Listener.	nSession
		subscribe(attributes:Array, callback:Function = null):void Subscribe to the channels specified within the nSubscriptionAttributes array	nSession
		updateConnectionListWithServerList():void Update the current session attributes with the rNames retrieved from the server.	nSession
		writeDataGroup(eventArray:Array, dataGroupArray:Array, registeredEvent:Boolean = false):void Sends the event to the specified data group	nSession
		writeDataStream(eventArray:Array, streams:Array):void Sends the event to the specified stream	nSession
		writeOneToOneDataGroup(events:Vector.<nConsumeEvent>, destinations:Vector.<nDataGroup>, callback:Function = null, registeredEvent:Boolean = false):void Sends event x to destination x	nSession

Public Constants

	Constant		Defined By
		nConnectedEventString : String = nConnectedEventString [static] String used for nConnectedEvent to be dispatched	nSession
		nDataGroupCreatedEventString : String = nDataGroupCreatedEventString [static] String used for nDataGroupCreatedEvent to be dispatched	nSession
		nDataGroupGetDefaultEventString : String = nDataGroupGetDefaultEventString [static] String used for nDataGroupGetDefaultEvent to be dispatched	nSession
		nDataGroupGetGroupsEventString : String = nDataGroupGetGroupsEventString [static] String used for nDataGroupGetGroupsEvent to be dispatched	nSession
		nDataGroupsCreatedEventString : String = nDataGroupsCreatedEventString [static] String used for nDataGroupsCreatedEvent to be dispatched	nSession
		nDisconnectedEventString : String = nDisconnectedEventString [static] String used for nDisconnectedEvent to be dispatched	nSession
		nErrorEventString : String = nErrorEventString [static] String used for nErrorEvent to be dispatched	nSession
		nFindResultEventString : String = nFindResultEventString [static] String used for nFindResultEvent to be dispatched	nSession
		nGetStoresEventString : String = nGetStoresEventString [static] String used for nGetStoresEvent to be dispatched	nSession
		nManyToManyBatchCompleteEventString : String = nManyToManyBatchCompleteEventString [static] String used for nManyToManyBatchCompleteEvent to be dispatched	nSession
		nOneToOneBatchCompleteEventString : String = nOneToOneBatchCompleteEventString [static] String used for nOneToOneBatchCompleteEvent to be dispatched	nSession
		nReconnectedEventString : String = nReconnectedEventString [static] String used for nReconnectedEvent to be dispatched	nSession
		nSecurityEventString : String = nSecurityEventString [static] String used for nSecurityEvent to be dispatched	nSession
		nStoreCreatedEventString : String = nStoreCreatedEventString [static] String used for nStoreCreatedEvent to be dispatched	nSession
		nStoreDeletedEventString : String = nStoreDeletedEventString [static] String used for nStoreDeletedEvent to be dispatched	nSession
		nStoreFoundEventString : String = nStoreFoundEventString [static] String used for nStoreFoundEvent to be dispatched	nSession
		nSubscribeResultEventString : String = nSubscribeResultEventString [static] String used for nSubscribeResultEvent to be dispatched	nSession

Property Detail

channelMultiplexing

property

channelMultiplexing:Boolean

Returns true if channel multiplexing has been enabled

Implementation
public function get channelMultiplexing():Boolean
public function set channelMultiplexing(value:Boolean):void

errorCB

property

errorCB:Function

the error function that is called if a failure occurs with Nirvana that has no current outstanding requests

Implementation
public function get errorCB():Function
public function set errorCB(value:Function):void

eventReceivedCount

property

eventReceivedCount:Number [read-only]

Return the number of events received by this session

Implementation
public function get eventReceivedCount():Number

eventSentCount

property

eventSentCount:Number [read-only]

Return the number of events sent by this session

Implementation
public function get eventSentCount():Number

property

id:Long [read-only]

Returns the unique session Id for this session

Implementation
public function get id():Long

Throws

nSessionNotConnectedError — if session has not been initialised

inputByteCount

property

inputByteCount:Number [read-only]

Returns the number of bytes received from the server on this session object

Implementation
public function get inputByteCount():Number

oldRegisteredEventMerge

property

oldRegisteredEventMerge:Boolean

A check to see if the old merge has been enabled because as of version 6.0 the registered event merge has change and updates are only received on the client

Implementation
public function get oldRegisteredEventMerge():Boolean
public function set oldRegisteredEventMerge(value:Boolean):void

outputByteCount

property

outputByteCount:Number [read-only]

Returns the number of bytes sent to the server using this session object

Implementation
public function get outputByteCount():Number

realmName

property

realmName:String [read-only]

Returns the sessions server realm name

Implementation
public function get realmName():String

remoteId

property

remoteId:String [read-only]

Returns the rName that this session has used

Implementation
public function get remoteId():String

sessionConnectionId

property

sessionConnectionId:Long [read-only]

Returns the unique connection id associated with this session by the server.

Implementation
public function get sessionConnectionId():Long

Throws

nSessionNotConnectedError — If the nSession has not been initiated

streamId

property

streamId:String [read-only]

Returns the unique stream id associated with this session by the server.

Implementation
public function get streamId():String

subject

property

subject:String [read-only]

Gets the subject associated with this nirvana session

Implementation
public function get subject():String

Throws

nSessionNotConnectedError — If the session is not connected

Method Detail

()

method

public function close():void

Closes this session, disconnecting from the server

Throws

	`nSessionNotConnectedError` — if you have been disconnected from the server

	`nSessionNotInitialisedError` — if you have not initialised the session

closeInt

()

method

public function closeInt(noWait:Boolean = false):void

Parameters
noWait:Boolean (default = false)

connectionList

()

method

public function connectionList():String

Returns a comma separated list of RNAMEs which can be used to access the realm or cluster namespace. This value is calculated and updated by the server which this session is currently connected to.

Returns

String — String of comma separated list of rNames which can be used to construct a nSessionAttributes.

createDataGroup

()

method

 public function createDataGroup(dataGroupName:String, callback:Function = null, listener:nDataGroupListener = null, conflationAttributes:nConflationAttributes = null):void

Since :

6.0

Create a new data group on the server

Parameters
dataGroupName:String — The name of the data group to create

callback:Function (default = null) — the function to call once creation is complete it will return either a nDataGroup or a nSecurityError. Set this to null if you want to use events and then a nDataGroupEvent wil be dispatched, the listener string is nDataGroupCreatedEventString

listener:nDataGroupListener (default = null) — the nDataGroupListener to be registered for this new data group

conflationAttributes:nConflationAttributes (default = null) — the Conflation attributes for this group

Throws

	`com.pcbsys.nirvana.client.error:nSessionNotConnectedError` —

	`nSessionNotInitialisedError` — if you have not initialised the session

createDataGroups

()

method

 public function createDataGroups(dataGroupNames:Array, callback:Function = null, conflationAttributes:nConflationAttributes = null):void

Since :

6.0

Create a new data group on the server

Parameters
dataGroupNames:Array — An array of DataGroup names as strings to create

callback:Function (default = null) — the function to call once creation is complete it will return either an Array of nDataGroup or a nSecurityError. If you wish to use events set this to null, the event returned will be a nDataGroupsEvent the listener string is nDataGroupsCreatedEventString

conflationAttributes:nConflationAttributes (default = null)

Throws

	`com.pcbsys.nirvana.client.error:nSessionNotConnectedError` —

	`nSessionNotInitialisedError` — if you have not initialised the session

createStore

()

method

public function createStore(attributes:nStoreAttributes, channelCreatedCB:Function = null, initialEID:Long = null):void

Creates a new store on the realm this session is connected too.

Parameters
attributes:nStoreAttributes — The store attributes object containing the parameters for the new store to be created

channelCreatedCB:Function (default = null) — this is a function callback that takes as an argument a nStore, it is called when the store has been created. Can return a nChannelAlreadyExistsError if the channel exists or a nNameSpaceConflictError. If you wish to use events then set this to null and a nStoreEvent will be dispatched, the listener string is nStoreCreatedEventString.

initialEID:Long (default = null) — a long specifying the initial EID if required.

Throws

	`nStoreNullError` — If a null attribute is passed

	`nSessionNotConnectedError` — if you have been disconnected from the server

	`nSessionNotInitialisedError` — if you have not initialised the session

deleteDataGroup

()

method

public function deleteDataGroup(group:nDataGroup):void

Since :

6.0

Deletes the specified data group from the server

Parameters
group:nDataGroup — the dataGroup to delete

Throws

	`com.pcbsys.nirvana.client.error:nSessionNotConnectedError` —

	`nSessionNotInitialisedError` — if you have not initialised the session

deleteDataGroupArray

()

method

public function deleteDataGroupArray(groups:Array):void

Since :

6.0

Deletes the specified data group from the server

Parameters
groups:Array — Array of nDataGroup to delete

Throws

	`com.pcbsys.nirvana.client.error:nSessionNotConnectedError` —

	`nSessionNotInitialisedError` — if you have not initialised the session

deleteDataGroupByString

()

method

public function deleteDataGroupByString(dataGroupName:String):void

Since :

6.0

Deletes the specified data group from the server

Parameters
dataGroupName:String — the Name of the data group to delete

Throws

com.pcbsys.nirvana.client.error:nSessionNotConnectedError —

deleteStore

()

method

public function deleteStore(attributes:nStoreAttributes, storeDeletedCB:Function = null):void

Deletes the specified store that exists on the realm this session is connected to, or a joined realm. Note: all events in the store will be deleted too and are not recoverable.

Parameters
attributes:nStoreAttributes — The channel attributes of the channel to be deleted

storeDeletedCB:Function (default = null) — The callback when the channel has been deleted, if you wish to use events set this to null and a nStoreDeletedEvent will be dispatched, the listener string is nStoreDeletedEventString

Throws

	`nStoreNullError` — if a null attributes is passed in

	`nSessionNotConnectedError` — if you have been disconnected from the server

	`nSessionNotInitialisedError` — if you have not initialised the session

find

()

method

public function find(attributes:Array, callback:Function = null):void

Finds and returns an array of nFindResult objects that correspond to the results of the find operations on each nChannelAttributes.

Parameters
attributes:Array — An array of nChannelAttributes and/or nQueueAttributes to find.

callback:Function (default = null) — will be passed a nFindResult array that represents the result of the find call, if you would like a event then do not set this value and a nFindResultEvent will be dispatched the listener string is nFindResultEventString

Throws

	`nSecurityError` — User is not authorised for the function

	`nSessionNotConnectedError` — Current session is not connected

	`nIllegalArgumentError` — Illegal parameter, check the message for more information

	`nSessionNotInitialisedError` — if you have not initialised the session

findStore

()

method

public function findStore(storeName:String, storeFoundCB:Function = null):void

Finds and returns a nirvana channel that exists on the realm this session is connected to, or a joined realm.

Parameters
storeName:String — The channel name of the channel to be found

storeFoundCB:Function (default = null) — The callback when the channel is found returns one argument either a nChannel or a nQueue as a nStore that can then be cast either type by checking the attributes isChannel or isQueue functions. A error that could be raised is nStoreNotFoundError. If you want to use events do not set this value and a nStoreEvent will be dispatched the listener string is nFindStoreEventString

Throws

	`nSessionNotConnectedError` — if you have been disconnected from the server

	`nSessionNotInitialisedError` — if you have not initialised the session

getAttributes

()

method

public function getAttributes():nSessionAttributes

Gets the session attribute object associated with this session

Returns

nSessionAttributes — nSessionAttributes object associated with this session

getDataGroups

()

method

public function getDataGroups(callback:Function = null, listener:nDataGroupListener = null):void

Since :

6.0

Retrieves the global data group containing all known data groups on the server

Parameters
callback:Function (default = null) — the function to call with an array of nDataGroups or null if there is none. If you wish to use

listener:nDataGroupListener (default = null) — the nDataGroupListener

Throws

	`com.pcbsys.nirvana.client.error:nSessionNotConnectedError` —

	`nSessionNotInitialisedError` — if you have not initialised the session

getDefaultDataGroup

()

method

public function getDefaultDataGroup(callback:Function = null, listener:nDataGroupListener = null):void

Retrieves the default data group from Nirvana

Parameters
callback:Function (default = null) — the function to call once we have our default nDataGroup from Nirvana. If you want to use events set this to null then a nDataGroupEvent will be dispatched with a listener string of nDataGroupGetDefaultEventString

listener:nDataGroupListener (default = null) — the listener to place on the nDataGroup from nirvana

Throws

	`com.pcbsys.nirvana.client.error:nSessionNotConnectedError` —

	`nSessionNotInitialisedError` — if you have not initialised the session

getGroupsContaining

()

method

public function getGroupsContaining(group:nDataGroup):Array

Locate the groups that currently contain this group

Parameters
group:nDataGroup — the group to check

Returns

Array

getKnownGroupCount

()

method

public function getKnownGroupCount():int

Get the size of the known data groups list

Returns

int — the current size of the data groups list

getSessionId

()

method

public function getSessionId():Long

Returns the unique connection id associated with this session by the server.

Returns

Long — long the session id

getStores

()

method

public function getStores(storesCB:Function = null, folder:String = /):void

Returns an array of all known channels and queues

Parameters
storesCB:Function (default = null) — this is a function callback that takes as a parameter a Array which contains nStoreAttributes or a Error. If you wish to use events set this to null and a nGetStoresEvent will be dispatched, the listener string is nGetStoresEventString

folder:String (default = /) — folder specify the starting point in the namespace within which to retrieve the channels. Can be left empty

Throws

	`nSessionNotConnectedError` — if you have been disconnected from the server

	`nSessionNotInitialisedError` — if you have not initialised the session

init

()

method

 public function init(postInitCB:Function = null, connectionListener:nConnectionListener = null, disconnectIfClusterFails:Boolean = false, streamListener:nDataStreamListener = null):void

Initialises a session object, opening the physical connection to the server

Parameters
postInitCB:Function (default = null) — The function to call after initiating the connection, can return a nClusterNotReady or a nDataStream. If you wish to be notified by a event then set this to null, the event will be a nConnectedEvent

connectionListener:nConnectionListener (default = null) — the object containing all the connection listeners

disconnectIfClusterFails:Boolean (default = false) — the stream listener for data groups

streamListener:nDataStreamListener (default = null) — set this if you wish to be disconnected when a cluster is not formed else server exceptions will be raised if a publish is tried whilst the cluster is not formed.

isConnected

()

method

public function isConnected():Boolean

Returns true if this session is still connected with the remote realm

Returns

Boolean — Boolean result of the test

isMember

()

method

public function isMember():Long

Returns the unique connection id associated with this session by the server.

Returns

Long — long the session id

manyToManyBatchWrite

()

method

 public function manyToManyBatchWrite(events:Vector.<nConsumeEvent>, destinations:Vector.<nStore>, callback:Function = null, notifyOfComplete:Boolean = false):void

Sends all of the events to all of the specified channels/queues

Parameters
events:Vector.<nConsumeEvent> — the vector of at least one event to send

destinations:Vector.<nStore> — the vector of stores (channels and queues)must contain at least one

callback:Function (default = null) — the function to call if you wish to know when completed. Set to null if you want a event to be dispatched, the event will be a nBatchCompleteEvent the listener string is nManyToManyBatchCompleteEvent

notifyOfComplete:Boolean (default = false) — set to true when you wish for a event to be dispatched, requires callback to be null.

Throws

	`nIllegalArgumentError` — if values are passed in without minimum size

	`nSessionNotInitialisedError` — if you have not initialised the session

oneToOneBatchWrite

()

method

 public function oneToOneBatchWrite(events:Vector.<nConsumeEvent>, destinations:Vector.<nStore>, callback:Function = null, registeredEvent:Boolean = false, notifyOfComplete:Boolean = false):void

Sends event x to destination x

Parameters
events:Vector.<nConsumeEvent> — the vector of at least one event to send

destinations:Vector.<nStore> — the vector of stores (channels and queues)must contain at least one

callback:Function (default = null) — the function to call if you wish to know about the reply. Set to null if you want a event to be dispatched, the event will be a nBatchCompleteEvent the listener string is nOneToOneBatchCompleteEvent

registeredEvent:Boolean (default = false) — set to true when you wish for a event to be dispatched, requires callback to be null.

notifyOfComplete:Boolean (default = false)

Throws

	`nIllegalArgumentError` — if values are passed in without minimum size

	`nSessionNotInitialisedError` — if you have not initialised the session

pauseStream

()

method

public function pauseStream():void

Since :

6.0

Pause the events being received by the Data Group Listener. This is not currently implemented

Throws

Error —

resumeStream

()

method

public function resumeStream():void

Since :

6.0

Resumes the events being received by the Data Group Listener. This is not curently implemented

Throws

Error —

()

method

public function subscribe(attributes:Array, callback:Function = null):void

Subscribe to the channels specified within the nSubscriptionAttributes array

Parameters
attributes:Array — - Array of nSubscriptionAttributes of each store subscription

callback:Function (default = null) — will be called with an Array full of nSubscriptionAttributes, if you would like events do not set this value and a nSubscribeResultEvent will be dispatched the listener string is nSubscribeResultEventString

Throws

	`nIllegalArgumentError` — If an illegal value is passed in

	`nSessionNotInitialisedError` — if you have not initialised the session

updateConnectionListWithServerList

()

method

public function updateConnectionListWithServerList():void

Update the current session attributes with the rNames retrieved from the server.

writeDataGroup

()

method

public function writeDataGroup(eventArray:Array, dataGroupArray:Array, registeredEvent:Boolean = false):void

Since :

6.0

Sends the event to the specified data group

Parameters
eventArray:Array — an array of nConsumeEvents

dataGroupArray:Array — An array of nDataGroup

registeredEvent:Boolean (default = false)

Throws

com.pcbsys.nirvana.client.error:nSessionNotConnectedError —

writeDataStream

()

method

public function writeDataStream(eventArray:Array, streams:Array):void

Since :

6.0

Sends the event to the specified stream

Parameters
eventArray:Array — an array of nConsumeEvents

streams:Array — An array of nDataStream

Throws

com.pcbsys.nirvana.client.error:nSessionNotConnectedError —

writeOneToOneDataGroup

()

method

 public function writeOneToOneDataGroup(events:Vector.<nConsumeEvent>, destinations:Vector.<nDataGroup>, callback:Function = null, registeredEvent:Boolean = false):void

Sends event x to destination x

Parameters
events:Vector.<nConsumeEvent> — the vector of at least one event to send

destinations:Vector.<nDataGroup> — the vector of stores (channels and queues)must contain at least one

callback:Function (default = null) — the function to call if you wish to know about the reply

registeredEvent:Boolean (default = false)

Throws

	`nIllegalArgumentError` — if values are passed in without minimum size

	`nSessionNotInitialisedError` — if you have not initialised the session

Constant Detail

nConnectedEventString

Constant

public static const nConnectedEventString:String = nConnectedEventString

String used for nConnectedEvent to be dispatched

nDataGroupCreatedEventString

Constant

public static const nDataGroupCreatedEventString:String = nDataGroupCreatedEventString

String used for nDataGroupCreatedEvent to be dispatched

nDataGroupGetDefaultEventString

Constant

public static const nDataGroupGetDefaultEventString:String = nDataGroupGetDefaultEventString

String used for nDataGroupGetDefaultEvent to be dispatched

nDataGroupGetGroupsEventString

Constant

public static const nDataGroupGetGroupsEventString:String = nDataGroupGetGroupsEventString

String used for nDataGroupGetGroupsEvent to be dispatched

nDataGroupsCreatedEventString

Constant

public static const nDataGroupsCreatedEventString:String = nDataGroupsCreatedEventString

String used for nDataGroupsCreatedEvent to be dispatched

nDisconnectedEventString

Constant

public static const nDisconnectedEventString:String = nDisconnectedEventString

String used for nDisconnectedEvent to be dispatched

nErrorEventString

Constant

public static const nErrorEventString:String = nErrorEventString

String used for nErrorEvent to be dispatched

nFindResultEventString

Constant

public static const nFindResultEventString:String = nFindResultEventString

String used for nFindResultEvent to be dispatched

nGetStoresEventString

Constant

public static const nGetStoresEventString:String = nGetStoresEventString

String used for nGetStoresEvent to be dispatched

nManyToManyBatchCompleteEventString

Constant

public static const nManyToManyBatchCompleteEventString:String = nManyToManyBatchCompleteEventString

String used for nManyToManyBatchCompleteEvent to be dispatched

nOneToOneBatchCompleteEventString

Constant

public static const nOneToOneBatchCompleteEventString:String = nOneToOneBatchCompleteEventString

String used for nOneToOneBatchCompleteEvent to be dispatched

nReconnectedEventString

Constant

public static const nReconnectedEventString:String = nReconnectedEventString

String used for nReconnectedEvent to be dispatched

nSecurityEventString

Constant

public static const nSecurityEventString:String = nSecurityEventString

String used for nSecurityEvent to be dispatched

nStoreCreatedEventString

Constant

public static const nStoreCreatedEventString:String = nStoreCreatedEventString

String used for nStoreCreatedEvent to be dispatched

nStoreDeletedEventString

Constant

public static const nStoreDeletedEventString:String = nStoreDeletedEventString

String used for nStoreDeletedEvent to be dispatched

nStoreFoundEventString

Constant

public static const nStoreFoundEventString:String = nStoreFoundEventString

String used for nStoreFoundEvent to be dispatched

nSubscribeResultEventString

Constant

public static const nSubscribeResultEventString:String = nSubscribeResultEventString

String used for nSubscribeResultEvent to be dispatched

	`dataGroupName:String` — The name of the data group to create

	`callback:Function` (default = `null`) — the function to call once creation is complete it will return either a nDataGroup or a nSecurityError. Set this to null if you want to use events and then a nDataGroupEvent wil be dispatched, the listener string is nDataGroupCreatedEventString

	`listener:nDataGroupListener` (default = `null`) — the nDataGroupListener to be registered for this new data group

	`conflationAttributes:nConflationAttributes` (default = `null`) — the Conflation attributes for this group

	`dataGroupNames:Array` — An array of DataGroup names as strings to create

	`callback:Function` (default = `null`) — the function to call once creation is complete it will return either an Array of nDataGroup or a nSecurityError. If you wish to use events set this to null, the event returned will be a nDataGroupsEvent the listener string is nDataGroupsCreatedEventString

	`conflationAttributes:nConflationAttributes` (default = `null`)

	`attributes:nStoreAttributes` — The store attributes object containing the parameters for the new store to be created

	`channelCreatedCB:Function` (default = `null`) — this is a function callback that takes as an argument a nStore, it is called when the store has been created. Can return a nChannelAlreadyExistsError if the channel exists or a nNameSpaceConflictError. If you wish to use events then set this to null and a nStoreEvent will be dispatched, the listener string is nStoreCreatedEventString.

	`initialEID:Long` (default = `null`) — a long specifying the initial EID if required.

	`attributes:nStoreAttributes` — The channel attributes of the channel to be deleted

	`storeDeletedCB:Function` (default = `null`) — The callback when the channel has been deleted, if you wish to use events set this to null and a nStoreDeletedEvent will be dispatched, the listener string is nStoreDeletedEventString

	`attributes:Array` — An array of nChannelAttributes and/or nQueueAttributes to find.

	`callback:Function` (default = `null`) — will be passed a nFindResult array that represents the result of the find call, if you would like a event then do not set this value and a nFindResultEvent will be dispatched the listener string is nFindResultEventString

	`storeName:String` — The channel name of the channel to be found

	`storeFoundCB:Function` (default = `null`) — The callback when the channel is found returns one argument either a nChannel or a nQueue as a nStore that can then be cast either type by checking the attributes isChannel or isQueue functions. A error that could be raised is nStoreNotFoundError. If you want to use events do not set this value and a nStoreEvent will be dispatched the listener string is nFindStoreEventString

	`storesCB:Function` (default = `null`) — this is a function callback that takes as a parameter a Array which contains nStoreAttributes or a Error. If you wish to use events set this to null and a nGetStoresEvent will be dispatched, the listener string is nGetStoresEventString

	`folder:String` (default = `/`) — folder specify the starting point in the namespace within which to retrieve the channels. Can be left empty

	`postInitCB:Function` (default = `null`) — The function to call after initiating the connection, can return a nClusterNotReady or a nDataStream. If you wish to be notified by a event then set this to null, the event will be a nConnectedEvent

	`connectionListener:nConnectionListener` (default = `null`) — the object containing all the connection listeners

	`disconnectIfClusterFails:Boolean` (default = `false`) — the stream listener for data groups

	`streamListener:nDataStreamListener` (default = `null`) — set this if you wish to be disconnected when a cluster is not formed else server exceptions will be raised if a publish is tried whilst the cluster is not formed.

	`events:Vector.<nConsumeEvent>` — the vector of at least one event to send

	`destinations:Vector.<nStore>` — the vector of stores (channels and queues)must contain at least one

	`callback:Function` (default = `null`) — the function to call if you wish to know when completed. Set to null if you want a event to be dispatched, the event will be a nBatchCompleteEvent the listener string is nManyToManyBatchCompleteEvent

	`notifyOfComplete:Boolean` (default = `false`) — set to true when you wish for a event to be dispatched, requires callback to be null.

	`attributes:Array` — - Array of nSubscriptionAttributes of each store subscription

	`callback:Function` (default = `null`) — will be called with an Array full of nSubscriptionAttributes, if you would like events do not set this value and a nSubscribeResultEvent will be dispatched the listener string is nSubscribeResultEventString

	`eventArray:Array` — an array of nConsumeEvents

	`dataGroupArray:Array` — An array of nDataGroup

	`registeredEvent:Boolean` (default = `false`)

	`eventArray:Array` — an array of nConsumeEvents

	`streams:Array` — An array of nDataStream

	`events:Vector.<nConsumeEvent>` — the vector of at least one event to send

	`destinations:Vector.<nDataGroup>` — the vector of stores (channels and queues)must contain at least one

	`callback:Function` (default = `null`) — the function to call if you wish to know about the reply

	`registeredEvent:Boolean` (default = `false`)