com.pcbsys.nirvana.client.nChannelAttributes

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

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

Public Properties

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

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		nChannelAttributes(channelAttributes:nChannelAttributes = null) Constructs from an instance of nChannelAttributes else just creates a new instance	nChannelAttributes
		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	nChannelAttributes
		OFF_HEAP_TYPE : int = 7 [static] Used to create a off heap channel type	nChannelAttributes
		PERSISTENT_TYPE : int = 2 [static] Used to create a persistent channel type	nChannelAttributes
		RELIABLE_TYPE : int = 1 [static] Used to create a reliable channel type	nChannelAttributes
		SIMPLE_TYPE : int = 4 [static] Used to create a simple channel type	nChannelAttributes
		TRANSIENT_TYPE : int = 5 [static] Used to create a transient channel type	nChannelAttributes

Property Detail

deadEventChannelId

property

deadEventChannelId:Long [read-only]

Gets the dead event channel ID

Implementation
public function get deadEventChannelId():Long

isClusterWide

property

isClusterWide:Boolean [read-only]

Is this channel cluster wide

Implementation
public function get isClusterWide():Boolean

maxEvents

property

maxEvents:int

Gets the maximum number of events the channel 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 channel name

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

publishKeys

property

publishKeys:Array

Returns an array of nChannelPublishKeys

Implementation
public function get publishKeys():Array
public function set publishKeys(value:Array):void

TTL

property

TTL:Long

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

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

type

property

type:int

Gets the channel 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 channel

Implementation
public function get uniqueId():Long

useJMSEngine

property

useJMSEngine:Boolean [read-only]

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

Implementation
public function get useJMSEngine():Boolean

useMergeEngine

property

useMergeEngine:Boolean

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

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

Constructor Detail

nChannelAttributes

()

Constructor

public function nChannelAttributes(channelAttributes:nChannelAttributes = null)

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

Parameters

channelAttributes:nChannelAttributes (default = null) — The attributes of a channel 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

OFF_HEAP_TYPE

Constant

public static const OFF_HEAP_TYPE:int = 7

Used to create a off heap 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