This class is a container for the attributes necessary to create or locate a Nirvana channel or queue. More...
Public Member Functions | |
| bool | Equals (object obj) |
| For Internal Use Only (Supporting automatic sorting in supporting data structures | |
| bool | Equals (long aLong) |
| For Internal Use Only (Supporting automatic sorting in supporting data structures | |
| int | getChannelMode () |
| Returns the either channel (CHANNEL_MODE) or queue (QUEUE_MODE) More... | |
| string | getFullName () |
| Gets the full name of a channel, including the realm path if set. More... | |
| int | getMaxEvents () |
| Gets the maximum number of events the channel can contain. More... | |
| string | getName () |
| Gets the channel name More... | |
| nStoreProperties | getProperties () |
| Returns the nStoreProperties objec. More... | |
| byte[][] | getProtobufDescriptors () |
| Returns an array of the descruptors associated with this channel in byte[] form. More... | |
| nChannelPublishKeys[] | getPublishKeys () |
| Gets the channel keys for this channel More... | |
| nRealm | getRealm () |
| Gets the realm this channel exists within. More... | |
| long | getTTL () |
| Gets the Time To Live (TTL) value that will be applied to each event contained in the channel More... | |
| int | getType () |
| Gets the channel type, which will be equal to one of : More... | |
| long | getUniqueId () |
| Gets the Unique ID value for the channel More... | |
| bool | isClusterWide () |
| Is this channel cluster wide More... | |
| bool | isExternal () |
| Gets the isExternal flag to find out if the channel is marked as external. More... | |
| bool | isJMSEngine () |
| Specifies whether this channel will use the JMS Style fanout engine. More... | |
| bool | isMergeEngine () |
| Specifies whether this channel will use the Merge and Update Style fanout engine. More... | |
| bool | lessThan (object obj) |
| For Internal Use Only (Supporting automatic sorting in supporting data structures | |
| bool | lessThan (long aLong) |
| For Internal Use Only (Supporting automatic sorting in supporting data structures | |
| nChannelAttributes () | |
| Default constructor | |
| nChannelAttributes (string name) | |
| Takes a channel or queue name More... | |
| nChannelAttributes (string _name, int _maxEvents, long _ttl, int _type) | |
| Constructs a nChannelAttributes object with the values specified. More... | |
| nChannelAttributes (string _name, int _maxEvents, long _ttl, int _type, nRealm _realm) | |
| Constructs a nChannelAttributes object with the values specified. More... | |
| void | setChannelMode (int mode) |
| Sets the channel mode as either a queue or a channel. More... | |
| void | setClusterWide (bool flag) |
| Specifies whether this channel is a cluster channel, where it will exist in all member nodes within the cluster. More... | |
| void | setDeadEventHandler (nAbstractChannel store) |
| Set the dead event handler store for this channel / queue. More... | |
| void | setDeadEventHandler (nChannelAttributes store) |
| Set the dead event handler store for this channel / queue. More... | |
| void | setMaxEvents (int value) |
| Sets the maximum number of events the channel can contain. More... | |
| void | setName (string channelName) |
| Set the channel name for this channel attribute object. More... | |
| void | setProtobufDescriptors (byte[][] descriptors) |
| Sets the protobuf descriptors for this channel. More... | |
| void | setPublishKeys (nChannelPublishKeys[] keys) |
| Sets the channel keys for this channel More... | |
| void | setRealm (nRealm _realm) |
| Sets the realm the channel exists within, marking the channel as external. More... | |
| void | setTTL (long value) |
| Sets the Time To Live (TTL) value for each event contained in the channel More... | |
| void | setType (int aType) |
| Sets the type of channel. More... | |
| void | setUniqueId (long id) |
| Sets the Unique ID value for the channel More... | |
| void | useJMSEngine (bool useJMSEngine) |
| Sets whether to use the JMS style fanout engine. More... | |
| void | useMergeEngine (bool useMergeEngine) |
| Sets whether to use the Merge fanout engine More... | |
Data Fields | |
| const int | CHANNEL_MODE = com.pcbsys.nirvana.nbase.nConstants.CHAN_MODE_NORMAL |
| Specifies a channel (or topic) mode for the pub/sub model | |
| const int | DICTIONARY_STAMPING_DEFAULT = com.pcbsys.nirvana.nbase.nConstants.DICTIONARY_STAMPING_DEFAULT |
| Dictionary stamping state - DEFAULT; by default the engine will fall back to the server-wide configuration setting | |
| const int | DICTIONARY_STAMPING_DISABLED = com.pcbsys.nirvana.nbase.nConstants.DICTIONARY_STAMPING_DISABLED |
| Dictionary stamping state - DISABLED | |
| const int | DICTIONARY_STAMPING_ENABLED = com.pcbsys.nirvana.nbase.nConstants.DICTIONARY_STAMPING_ENABLED |
| Dictionary stamping state - ENABLED | |
| const int | MIXED_TYPE = com.pcbsys.nirvana.nbase.nConstants.CHAN_MIXED |
| Specifies a mixed (persistence and ttl set on a per event basis) channel type | |
| const int | OFF_HEAP_TYPE = com.pcbsys.nirvana.nbase.nConstants.CHAN_OFFHEAP |
| Specifies a store where events are kept in off heap memory. More... | |
| const int | PAGE_TYPE = com.pcbsys.nirvana.nbase.nConstants.CHAN_PAGE |
| Specifies an Paged Off Heap store, so the Server utilises memory outside of the JVM heap | |
| const int | PERSISTENT_TYPE = com.pcbsys.nirvana.nbase.nConstants.CHAN_PERSISTENT |
| Specifies a persistent (on disk) channel type | |
| const int | QUEUE_MODE = com.pcbsys.nirvana.nbase.nConstants.CHAN_MODE_QUEUE |
| Specifies a queue (point 2 point) mode for the queue model | |
| const int | RELIABLE_TYPE = com.pcbsys.nirvana.nbase.nConstants.CHAN_RELIABLE |
| Specifies a reliable (in memory but with EIDs retained) channel type | |
| const long | sAllowFullAccess = 8 |
| Allow everyone to do everything on the channel / queue (Use with extreme caution since it bypasses any security checks for this channel / queue ) | |
| const long | sAllowLastEIDAccess = 512 |
| Get the last known Event ID on the channel / queue | |
| const long | sAllowManageACLAccess = 2 + 1 |
| Allow everyone to add / remove acl entries on the channel / queue | |
| const long | sAllowNamedAccess = 2048 |
| Allow everyone to create a named object on this channel | |
| const long | sAllowPublishAccess = 32 |
| Allow everyone to write events to the channel / queue | |
| const long | sAllowPurgeAccess = 128 |
| Allow everyone to purge events from the channel ( Only valid on channels ) | |
| const long | sAllowQueuePopAccess = 1024 |
| Allow everyone to pop events from the queue, (Only valid on Queues) | |
| const long | sAllowReadACLAccess = 4 |
| Allow everyone to read the ACL lists | |
| const long | sAllowSubscribeAccess = 64 |
| Allow everyone to subscribe to the channel ( Only valid on channels ) | |
| const int | SIMPLE_TYPE = com.pcbsys.nirvana.nbase.nConstants.CHAN_SIMPLE |
| Specifies a simple (in memory, no EIDs retained) channel type | |
| const int | TRANSIENT_TYPE = com.pcbsys.nirvana.nbase.nConstants.CHAN_TRANSIENT |
| Specifies a relay (no events are stored) channel type | |
This class is a container for the attributes necessary to create or locate a Nirvana channel or queue.
| com.pcbsys.nirvana.client.nChannelAttributes.nChannelAttributes | ( | string | name | ) |
Takes a channel or queue name
| name | name of the channel |
| com.pcbsys.nirvana.client.nChannelAttributes.nChannelAttributes | ( | string | _name, |
| int | _maxEvents, | ||
| long | _ttl, | ||
| int | _type | ||
| ) |
Constructs a nChannelAttributes object with the values specified.
| _name | A string specifying the channel name |
| _maxEvents | An int specifying the maximum number of events this channel can contain (i.e. the capacity) |
| _ttl | An int specifying the Time To Live (TTL) for events published in this channel (i.e. the age) |
| _type | An int specifying the channel type. Valid values are nConstants.CHAN_RELIABLE or nConstants.CHAN_PERSISTENT |
| nIllegalArgumentException | is thrown if an incorrect parameter is passed to the constructor |
| com.pcbsys.nirvana.client.nChannelAttributes.nChannelAttributes | ( | string | _name, |
| int | _maxEvents, | ||
| long | _ttl, | ||
| int | _type, | ||
| nRealm | _realm | ||
| ) |
Constructs a nChannelAttributes object with the values specified.
| _name | A string specifying the channel name |
| _maxEvents | An int specifying the maximum number of events this channel can contain (i.e. the capacity) |
| _ttl | An int specifying the Time To Live (TTL) for events published in this channel (i.e. the age) |
| _type | An int specifying the channel type. Valid values are nConstants.CHAN_RELIABLE or nConstants.CHAN_PERSISTENT |
| _realm | A nRealm object specifying the realm this channel exists within |
| nIllegalArgumentException | is thrown if an incorrect parameter is passed to the constructor |
| int com.pcbsys.nirvana.client.nChannelAttributes.getChannelMode | ( | ) |
Returns the either channel (CHANNEL_MODE) or queue (QUEUE_MODE)
| string com.pcbsys.nirvana.client.nChannelAttributes.getFullName | ( | ) |
Gets the full name of a channel, including the realm path if set.
| nBaseClientException | is thrown if the name value is not set |
| int com.pcbsys.nirvana.client.nChannelAttributes.getMaxEvents | ( | ) |
Gets the maximum number of events the channel can contain.
(i.e. the capacity)
| string com.pcbsys.nirvana.client.nChannelAttributes.getName | ( | ) |
Gets the channel name
| nStoreProperties com.pcbsys.nirvana.client.nChannelAttributes.getProperties | ( | ) |
Returns the nStoreProperties objec.
| byte [][] com.pcbsys.nirvana.client.nChannelAttributes.getProtobufDescriptors | ( | ) |
Returns an array of the descruptors associated with this channel in byte[] form.
| nChannelPublishKeys [] com.pcbsys.nirvana.client.nChannelAttributes.getPublishKeys | ( | ) |
Gets the channel keys for this channel
| nRealm com.pcbsys.nirvana.client.nChannelAttributes.getRealm | ( | ) |
Gets the realm this channel exists within.
| long com.pcbsys.nirvana.client.nChannelAttributes.getTTL | ( | ) |
Gets the Time To Live (TTL) value that will be applied to each event contained in the channel
| int com.pcbsys.nirvana.client.nChannelAttributes.getType | ( | ) |
Gets the channel type, which will be equal to one of :
nChanneAttributes.MIXED_TYPE nChanneAttributes.SIMPLE_TYPE nChanneAttributes.PERSISTENT_TYPE nChanneAttributes.RELIABLE_TYPE nChanneAttributes.TRANSIENT_TYPE nChanneAttributes.OFF_HEAP_TYPE nChanneAttributes.PAGE_TYPE
| long com.pcbsys.nirvana.client.nChannelAttributes.getUniqueId | ( | ) |
Gets the Unique ID value for the channel
| bool com.pcbsys.nirvana.client.nChannelAttributes.isClusterWide | ( | ) |
Is this channel cluster wide
| bool com.pcbsys.nirvana.client.nChannelAttributes.isExternal | ( | ) |
Gets the isExternal flag to find out if the channel is marked as external.
| bool com.pcbsys.nirvana.client.nChannelAttributes.isJMSEngine | ( | ) |
Specifies whether this channel will use the JMS Style fanout engine.
For more information on this, please see the version 4.0 documentation.
| bool com.pcbsys.nirvana.client.nChannelAttributes.isMergeEngine | ( | ) |
Specifies whether this channel will use the Merge and Update Style fanout engine.
For more information on this, please see the version 5.0 documentation.
| void com.pcbsys.nirvana.client.nChannelAttributes.setChannelMode | ( | int | mode | ) |
Sets the channel mode as either a queue or a channel.
These are specified as : nChannelAttributes.QUEUE_MODE & nChannelAttributes.CHANNEL_MODE
| mode | - one of the supported modes, either queue or channel |
| nIllegalArgumentException | if the specified channel mode not one of the support modes |
| void com.pcbsys.nirvana.client.nChannelAttributes.setClusterWide | ( | bool | flag | ) |
Specifies whether this channel is a cluster channel, where it will exist in all member nodes within the cluster.
| flag | is this channel to exist across all cluster realms |
| void com.pcbsys.nirvana.client.nChannelAttributes.setDeadEventHandler | ( | nAbstractChannel | store | ) |
Set the dead event handler store for this channel / queue.
When events reach there ttl or the channel hits its ttl, but have not been consumed, they can be placed in a dead event store. Setting the dead event store to be another valid channel or queue will enable this functionality and allow you to keep track of events that have died in this manner.
| store | the channel or queue to be set as the dead event store |
| void com.pcbsys.nirvana.client.nChannelAttributes.setDeadEventHandler | ( | nChannelAttributes | store | ) |
Set the dead event handler store for this channel / queue.
When events reach there ttl or the channel hits its ttl, but have not been consumed, they can be placed in a dead event store. Setting the dead event store to be another valid channel or queue will enable this functionality and allow you to keep track of events that have died in this manner.
| store | the attributes of the channel or queue to be set as the dead event store |
| void com.pcbsys.nirvana.client.nChannelAttributes.setMaxEvents | ( | int | value | ) |
Sets the maximum number of events the channel can contain.
(i.e. the capacity)
| value | An int specifying the max number of events |
| nIllegalArgumentException | is thrown if an incorrect value is passed |
| void com.pcbsys.nirvana.client.nChannelAttributes.setName | ( | string | channelName | ) |
Set the channel name for this channel attribute object.
If the channel begins with '/', a realm path is also created and the channel is marked as external.
| channelName | A string specifying the name of the channel for this channel attribute object. |
| nIllegalArgumentException | is thrown if an incorrect value is passed |
| void com.pcbsys.nirvana.client.nChannelAttributes.setProtobufDescriptors | ( | byte | descriptors[][] | ) |
Sets the protobuf descriptors for this channel.
| descriptors | an array of the descriptors in byte[] form. |
| void com.pcbsys.nirvana.client.nChannelAttributes.setPublishKeys | ( | nChannelPublishKeys[] | keys | ) |
Sets the channel keys for this channel
| keys | An array of nChannelPublishKeys to be assigned to this channel |
| void com.pcbsys.nirvana.client.nChannelAttributes.setRealm | ( | nRealm | _realm | ) |
Sets the realm the channel exists within, marking the channel as external.
If the realm is not set, it is implied that the channel exists within the realm you have a session to and use this object.
| _realm | An nRealm object specifying the realm the channel exists within |
| void com.pcbsys.nirvana.client.nChannelAttributes.setTTL | ( | long | value | ) |
Sets the Time To Live (TTL) value for each event contained in the channel
| value | A long specifying the new TTL value |
| nIllegalArgumentException | is thrown if an invalid TTL value is specified |
| void com.pcbsys.nirvana.client.nChannelAttributes.setType | ( | int | aType | ) |
Sets the type of channel.
| aType | An int specifying the channel type. |
| nIllegalArgumentException | is thrown if an illegal channel type is specified |
| void com.pcbsys.nirvana.client.nChannelAttributes.setUniqueId | ( | long | id | ) |
Sets the Unique ID value for the channel
| id | A long specifying the new unique id value |
| void com.pcbsys.nirvana.client.nChannelAttributes.useJMSEngine | ( | bool | useJMSEngine | ) |
Sets whether to use the JMS style fanout engine.
Not applicable to queues.
| useJMSEngine | use the JMS fanout engine |
| void com.pcbsys.nirvana.client.nChannelAttributes.useMergeEngine | ( | bool | useMergeEngine | ) |
Sets whether to use the Merge fanout engine
| useMergeEngine | use the Update and Merge fanout engine |
| const int com.pcbsys.nirvana.client.nChannelAttributes.OFF_HEAP_TYPE = com.pcbsys.nirvana.nbase.nConstants.CHAN_OFFHEAP |
Specifies a store where events are kept in off heap memory.
This store is similar to reliable, in that all events are in memory with no file backing.