com.pcbsys.nirvana.client.nQueueAttributes

Package	com.pcbsys.nirvana.client
Class	public class nQueueAttributes
Inheritance	nQueueAttributes nStoreAttributes Object

This class is a container for the attributes necessary to create or locate a Nirvana queue

Public Properties

	Property		Defined By
		deadEventQueueId : Long [read-only] Gets the dead event queue ID	nQueueAttributes
		isClusterWide : Boolean [read-only] Is this queue cluster wide	nQueueAttributes
		maxEvents : int Gets the maximum number of events the queue can contain.	nQueueAttributes
		name : String Gets the queue name	nQueueAttributes
		TTL : Long Gets the Time To Live (TTL) value that will be applied to each event contained in the queue	nQueueAttributes
		type : int Gets the queue type	nQueueAttributes
		uniqueId : Long [read-only] Gets the Unique ID value for the queue	nQueueAttributes
		useJMSEngine : Boolean [read-only] Specifies whether this queue will use the JMS Style fanout engine.	nQueueAttributes
		useMergeEngine : Boolean [read-only] Checks whether this queue will use the Merge and Update Style fanout engine.	nQueueAttributes

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		nQueueAttributes(queueAttributes:nQueueAttributes = null) Constructs from an instance of nQueueAttributes else just creates a new instance	nQueueAttributes
		isChannel():Boolean Checks if this nStoreAttribute is a channel	nStoreAttributes
		isQueue():Boolean Checks if this nStoreAttribute is a queue	nStoreAttributes

Public Constants

	Constant		Defined By
		MIXED_TYPE : int = 3 [static] Used to create a mixed channel type	nQueueAttributes
		PERSISTENT_TYPE : int = 2 [static] Used to create a persistent channel type	nQueueAttributes
		RELIABLE_TYPE : int = 1 [static] Used to create a reliable channel type	nQueueAttributes
		SIMPLE_TYPE : int = 4 [static] Used to create a simple channel type	nQueueAttributes
		TRANSIENT_TYPE : int = 5 [static] Used to create a transient channel type	nQueueAttributes

Property Detail

deadEventQueueId

property

deadEventQueueId:Long [read-only]

Gets the dead event queue ID

Implementation
public function get deadEventQueueId():Long

isClusterWide

property

isClusterWide:Boolean [read-only]

Is this queue cluster wide

Implementation
public function get isClusterWide():Boolean

maxEvents

property

maxEvents:int

Gets the maximum number of events the queue can contain. (i.e. the capacity)

Implementation
public function get maxEvents():int
public function set maxEvents(value:int):void

name

property

name:String

Gets the queue name

Implementation
public function get name():String
public function set name(value:String):void

TTL

property

TTL:Long

Gets the Time To Live (TTL) value that will be applied to each event contained in the queue

Implementation
public function get TTL():Long
public function set TTL(value:Long):void

type

property

type:int

Gets the queue type

Implementation
public function get type():int
public function set type(value:int):void

uniqueId

property

uniqueId:Long [read-only]

Gets the Unique ID value for the queue

Implementation
public function get uniqueId():Long

useJMSEngine

property

useJMSEngine:Boolean [read-only]

Specifies whether this queue will use the JMS Style fanout engine.

Implementation
public function get useJMSEngine():Boolean

useMergeEngine

property

useMergeEngine:Boolean [read-only]

Checks whether this queue will use the Merge and Update Style fanout engine.

Implementation
public function get useMergeEngine():Boolean

Constructor Detail

nQueueAttributes

()

Constructor

public function nQueueAttributes(queueAttributes:nQueueAttributes = null)

Constructs from an instance of nQueueAttributes else just creates a new instance

Parameters

queueAttributes:nQueueAttributes (default = null) — The attributes of a queue that it uses to create this attribute

Constant Detail

MIXED_TYPE

Constant

public static const MIXED_TYPE:int = 3

Used to create a mixed channel type

PERSISTENT_TYPE

Constant

public static const PERSISTENT_TYPE:int = 2

Used to create a persistent channel type

RELIABLE_TYPE

Constant

public static const RELIABLE_TYPE:int = 1

Used to create a reliable channel type

SIMPLE_TYPE

Constant

public static const SIMPLE_TYPE:int = 4

Used to create a simple channel type

TRANSIENT_TYPE

Constant

public static const TRANSIENT_TYPE:int = 5

Used to create a transient channel type