  com | |
 pcbsys | |
| nirvana | |
 client | Documentation for the Nirvana C# Client API |
   IObserver | A class can implement the |
| nAbstractChannel | This is the base class for all nirvana channel types, including queues and normal pub/sub channels and as such has no public methods |
| nAsyncExceptionListener | This interface should be implemented by classes wishing to register to receive asynchronous errors from the nirvana server |
| nBaseClientException | This exception forms the base for all client exceptions |
| nBaseTopicDurable | Abstract base class for the durable implementation on a topic |
| nChannelAlreadyExistsException | This exception is thrown if a user tries to make a channel that already exists |
| nChannelAlreadySubscribedException | The user has tried to subscribe to the channel more than once |
| nChannelAttributes | This class is a container for the attributes necessary to create or locate a Nirvana channel or queue |
| nChannelConnectionListener | This interface should be implemented by classes wishing to register to receive callbacks when connections are added or removed to a nirvana channel |
| nChannelIterator | This class iterates synchronously over a Nirvana Realm channel |
| nChannelNotFoundException | The specified channel could not be located on the server |
| nChannelPublishKeys | This class contains the information about a single channel key |
| nChannelWatcher | This interface extends the nEventListener interface and also provides the ability to receive callbacks for purged events as well as events published on a specific channel or queue |
| nConflationAttributes | This class represents the conflation attributes that can be used when creating resources which allow conflation |
| nConnectionQueueListener | This interface should be implemented by classes wishing to register to receive asynchronous notifications from the internal connection queue |
| nConstants | This class is a container for the various constants that affect the behaviour of various Nirvana Client API calls |
| nConsumeEvent | This class represents a Nirvana event, which consists of either a tag and some data or an event dictionary and some data |
| nConsumeEventFactory | This class is used to facilitate creation of nConsumeEvent objects |
| nConsumeEventFragmentReader | Provides an nEventListener implementation that can be used as an interceptor to server callbacks so that event fragments can be combined and only reconstructed events are passed to the user callback method |
| nConsumeEventFragmentWriter | Provides a channel / queue wrapper as well as an nEventPublisher implementation that automatically fragments published events larger than a specified byte size into smaller event fragments |
| nConsumeEventToken | Class representing the nConsumeEvent identifier |
 Builder | Builder for constructing the nConsumeEventToken identifier with all of the set properties |
| nCreateResult | This class represents the results of the nSession.create(nChannelAttributes[]) call |
| nDataGroup | This class represents a individual data group object |
| nDataGroupDeletedException | Class representing an exception generated when an operation is performed on an nDataGroup that has been deleted |
| nDataGroupIsReadOnlyException | Class representing an exception generated when an operation is performed on an nDataGroup that is read only |
| nDataGroupListener | Listener interface used to manage changes to membership of data groups |
| nDataGroupPumpImpl | This class is for internal use only |
| nDataStream | Represents the stream used to deliver data |
| nDataStreamListener | Interface used to asynchronously receive events written to the data stream or a data group that the stream is a member of |
| nDeleteResult | This class represents the results of the nSession.delete(nChannelAttributes[]) call |
| nDuplicateJoinException | The user has requested a join be created but the server already has this join configured in the database |
| nDurable | Abstract representation of a durable subscription |
| nDurableAttributes | Container which holds the attributes required for describing a durable object on a channel |
| nDurableManager | Class responsible for managing durable subscriptions on a channel |
| nDurableViewer | Abstract implementation for browsing the content of a durable object |
| nEventAttributes | The nEventAttributes class is used by the nConsumeEvent object in order to store standard header values associated with nirvana client, and JMS events |
| nEventListener | This interface should be implemented by any object that wishes to register itself as an asynchronous subscriber to a nirvana channel or queue |
| nEventProperties | This class contains a collection of key-value pairs, defining event meta data which can be used to create filter rules |
| nEventPropertiesIterator | This class allows you to iterate through the nEventProperties to examine the key,value pairs |
| nEventPropertyChangeListener | Listener interface enabling callbacks to be received when dictionary keys from events |
| nEventPublisher | This interface defines the functionality that should be offered by a generic Nirvana event publisher |
| nExceededLimitException | The number of events in the current transaction has exceeded the server configuration |
| nExclusiveDurable | The Exclusive Durable Implementation |
| nFindResult | This class represents the results of the nSession.find(nChannelAttributes[]) call |
| nIllegalArgumentException | This class defines the error that can be thrown by passing an illegal argument to any method of any class in the nirvana client API |
| nIllegalChannelMode | This exception is thrown if a user tries calls queue specific functionality on a channel object or channel specific functionality on a queue object |
| nIllegalStateException | This exception is thrown if a Channel or Queue is in an illegal state for specific functionality to be offered |
| nIndexedDurable | The Indexed Durable implementation |
| nJoinInformation | This class is a container for all the information that defines a channel join |
| nLogListener | Classes that implement this interface can register with the nRealmNode.addLogListener() to receive the realms log events |
| nMessageValidator | This interface defines the generic functionality that all Message Validators need to implement |
| nMulticastReceiver | This class is for internal use only |
| nNameAlreadyBoundException | This exception is thrown if a user attempts to create a named client context on a channel or queue that is already in use |
| nNamedObject | This class represents a client context on a RealmServer |
| nNameDoesNotExistException | This exception is thrown if a user attempts to delete a named client context on a channel or queue that does not exist |
| nNamedPriorityListener | This interface should be implemented by any object that requires a callback when the subscription to a channel with a named object and priority enabled reaches the top of the queue and becomes active |
| nNameSpaceConflictException | There is a conflict in the name space and the attempted operation failed |
| nPriorityDurable | This class represent a Priority Durable implementation |
| nProtobufEvent | This class represents a Google Protocol Buffer Event |
| nProtobufEventFactory | This class is used to facilitate creation of nProtobufEvent objects |
| nPublishedPausedException | This exception is thrown if a user attempts to publish events when the configuration property PauseServerPublishing is set to true |
| nQueue | This class provides a Queue mechanism |
| nQueueAsyncReader | This Reader enables the client to receive all events asynchronous |
| nQueueAsyncTransactionReader | This Reader enables the client to receive all events asynchronous |
| nQueueDetails | Container class, containing statistics on the queue |
| nQueuePeekContext | Provides a context when peeking on the queue |
| nQueueReader | This class is the base class for all Queue Readers and provides a generic reader interface |
| nQueueReaderContext | This class is used to construct a Queue Reader |
| nQueueSyncFragmentReader | This class provides the client with an synchronous interface into a Nirvana Queue that understands and reconstructs event fragments |
| nQueueSyncReader | This class provides the client with an synchronous interface into a Nirvana Queue |
| nQueueSyncTransactionFragmentReader | This reader provides a synchronous queue reader model |
| nQueueSyncTransactionReader | This reader provides a synchronous queue reader model |
| nQueueTransactionReader | Provides the basic interface for transactional queue operations, used by the synchronous and asynchronous transactional queue readers |
| nRealm | This class represents a nirvana Realm |
| nRealmAlreadyBoundException | You have tried to bind a realm that the server already has been bound |
| nRealmInUseException | This exception is thrown when an attempt is made to remove a realm from another realm when the realm is part of a cluster or has channels that are joined in the requesting realm |
| nRealmNotFoundException | The specified realm was not found on the server |
| nRealmUnreachableException | Was unable to reach the specified realm |
| nReconnectHandler | This interface should be implemented by classes wishing to register to receive callbacks when sessions are disconnected or to take control over the reconnect logic |
| nRegisteredEvent | This class enables a client to maintain a copy of an event, make changes to the properties and then when commit is called only the changes are published to the server |
| nRegisteredEventListener | This interface should be implemented by any object that wishes to register itself as an asynchronous subscriber and receive update events and complete merged events from a registered event |
| nRegisteredEventUpdateListener | This interface should be implemented by any object that wishes to register itself as an asynchronous subscriber and only receive update events only from a registered event |
| nRequestTimedOutException | When the maximum time the client API will wait for a response to a specific request from the Nirvana realm, this exception is thrown |
| nResult | This class is the base class that represents the results of a batched find, create or delete call for channels or queues |
| nSecurityException | This class defines the security errors that can be thrown by using the nirvana client API |
| nSelectorParserException | The supplied message filter string failed to be parsed |
| nSerialDurable | The Serial Durable implementation |
| nServerExtensionCallback | This interface is for internal use only |
| nSession | This class represents a Nirvana session, the logical connection between the client API and the Nirvana realm |
| nSessionAlreadyInitialisedException | The current nSession has already been initialised |
| nSessionAttributes | This class is a container for the attributes necessary to create a Nirvana session |
| nSessionFactory | This class is used with a nSessionAttributes object to create a Nirvana session |
| nSessionNotConnectedException | The current nSession is not currently connected |
| nSessionPausedException | This exception is thrown when an attempt is made by the client to make a request to the server, while the session is paused |
| nSharedDurable | The Shared Durable implementation |
| nStoreProperties | Class that contains additional properties that can be set on the channel or queue |
| nSubject | This class contains information about the user identification used by Nirvana |
| nSubscriptionAttributes | This class represents the attributes used for channel subscriptions |
| nTransaction | This class enables the client to perform transactional publishing, representing a nirvana transaction |
| nTransactionAlreadyAbortedException | The transaction has already been aborted and as such is closed |
| nTransactionAlreadyCommittedException | The transaction has already been committed and as such is closed and completed |
| nTransactionAttributes | This class is a container for the attributes necessary to create a Nirvana transaction |
| nTransactionException | This class defines the errors that can be thrown by using the nirvana transactional publish API |
| nTransactionFactory | This class is used with a nTransactionAttributes object to create a Nirvana transaction |
| nTransactionIncompleteException | This exception will be thrown if abort or commit is called on a transaction that has not sent any events to the server |
| nTransactionNoEventsException | This exception is thrown if Commit is called on a transaction without any events added in its context |
| nTransactionNoSuchTXIDException | The supplied transaction ID could not be located on server |
| nTransactionNotCommittedException | The transaction has not been committed so the status of the event can not be returned, such as getStartEID or getEndEID |
| nTransactionNotStartedException | The transaction has not been started as such the transaction is not yet established |
| nUnackedEventsManager | This class is a container for tracking ids of the events to be acknowledged |
| nUnexpectedResponseException | The server responded with an event that the client did not expect |
| nUnknownRemoteRealmException | The server does not know of the realm that was supplied |
| nUnknownTransactionIdException | This exception is thrown when an attempt is made to perform an operation on a transaction where the id of the transaction is not known by the server |
| nUserNotSubscribedException | The user is not currently subscribed to the channel/ |
| Observable | This class represents an observable object, or "data" in the model-view paradigm |
 nAdminAPI | Nirvana Administration (nAdminAPI) Package, incorporating all the tools necessary to monitor, configure and manage one or more Nirvana realms and / or clusters of realms |
| xml | |
| ChannelACLEntry | |
| ChannelAttributesEntry | |
| ChannelEntry | |
| ChannelGroupACLEntry | |
| ChannelJoinEntry | |
| ChannelJoinSet | |
| ChannelKeyEntry | |
| ChannelKeySet | |
| ChannelPermissionSet | |
| ChannelSet | |
| ClusterEntry | |
| ClusterMember | |
| ClusterSet | |
| ClusterSite | |
| ConfigGroup | |
| ConfigItem | |
| ConflationAttributesEntry | |
| CustomHeadersConfigEntryType | |
| DataGroupAttributesEntry | |
| DataGroupEntry | |
| DataGroupPublisherEntry | |
| DataGroupSet | |
| InterfaceACLEntry | |
| InterfaceGroupACLEntry | |
| InterfacePermissionSet | |
| JavascriptConfigEntryType | |
| NestedGroupEntry | |
| NirvanaRealm | |
| PluginConfigEntryType | |
| QueueACLEntry | |
| QueueEntry | |
| QueueGroupACLEntry | |
| QueuePermissionSet | |
| QueueSet | |
| RealmACLEntry | |
| RealmConfiguration | |
| RealmEntry | |
| RealmGroupACLEntry | |
| RealmInterfaceEntry | |
| RealmInterfacePluginEntry | |
| RealmInterfaceSet | |
| RealmInterfaceSSLConfig | |
| RealmInterfaceSupportedCipher | |
| RealmInterfaceSupportedCipherSet | |
| RealmMulticastAdvancedConfigurationEntry | |
| RealmMulticastBasicConfigurationEntry | |
| RealmMulticastConfigurationEntry | |
| RealmMulticastSecurityConfigurationEntry | |
| RealmNHPInterfaceEntry | |
| RealmNHPSInterfaceEntry | |
| RealmNSPInterfaceEntry | |
| RealmNSPSInterfaceEntry | |
| RealmPermissionSet | |
| RealmSchedulerSet | |
| RealmSecurityGroup | |
| RealmSecurityGroupEntry | |
| RealmSecurityGroupSet | |
| RealmSet | |
| RealmSHMConfigurationEntry | |
| Scheduler | |
| SecurityGroupReferenceEntry | |
| SecurityGroupSubjectEntry | |
| SiteMember | |
| StorePropertiesEntry | |
| nACL | represents a list of nACLEntry classes used by the Nirvana Realm server to control access to secured objects such as Realms, Channels and Queues |
| nACLEntry | * Contains the mapping between a subject User and the priviliges they can perform |
| nACLEntryNotFoundException | represents the exception class that is thrown when an acl entry is not found when an operation is attempted on it |
| nAdminIllegalArgumentException | represents the exception class that is thrown when an illegal argument is passed into a method |
| nAdminSecurityException | represents the exception class that is thrown when attempted operations are not permitted |
| nAuditEvent | This class contains information for realm auditing |
| nAuditListener | Classes that implement this interface can register with the nRealmNode.addAuditListener() to receive the realm's audit events |
| nBaseAdminException | represents the base class for all admin API exceptions |
| nBaseInterface | This class is for internal use only |
| nChannelACLEntry | Extends the nACLEntry class to supply Channel/Queue specific security settings |
| nChannelConnectionDetails | This class contains additional information about a channel connection |
| nClusterConnectionListener | Any class that implements this interface can be registered against a Nirvana Cluster node to receive notification when remote connections are made or dropped on any of the cluster realm node objects |
| nClusterConversionStatus | Call to report the current status of a cluster conversion |
| nClusterEventListener | Interface allowing client applications to receive cluster specific callbacks |
| nClusterMemberConfiguration | This object is used to create/modify clusters |
| nClusterNode | Contains the status and configuration of a Nirvana cluster |
| nClusterSite | This class defines a collection of realms within a cluster into a physical site / location |
| nClusterStatus | This class contains the status of the of a realm within the cluster, What state it has, which node is the elected master etc |
| nClusterStatusEntry | This class contains online/offline status a realm within a cluster |
| nCommandStatus | Any class implementing this interface can be used to find the current status of a request, for example a copy operation of a nLeafNode |
| nConfigEntry | This class contains all the information about a configuration parameter, including the name, the current value, a description of it and a warning or constrant string |
| nConfigGroup | This class manages a group of nConfigEntry objects that are related |
| nConfigurationException | represents the exception thrown when configuration operations fail |
| nConnectionDetails | This class contains the details about an individual connection |
| nConnectionListener | Any class that implements this interface can be registered against a Nirvana Realm, Channel or Queue to receive notification when remote connections are made or dropped |
| nContainer | This represents a node within the Nirvana Realm namespace which contains other nodes, such as a directory or another Realm |
| nCopyable | All classes that can be copied from one part of the namespace to another implement this interface |
| nCustomHeader | This Class represent a single custom header field which will be used by javascript |
| nDataGroupNode | This class is an Admin API wrapper for a Data Group object (nDataGroup) |
| nDataGroupsContainer | This class is an Admin API wrapper for all configured Data Group objects (nDataGroup) This class also can also be used to obtain all known nDataStream objects, that have been added to the default data group |
| nDataStreamNode | This class is an Admin API wrapper for a Data Stream object (nDataStream) |
| nDuplicateACLEntryException | represents the exception class that is thrown when a duplicate acl entry is attempted to be added |
| nHTTPInterface | This class contains all the configuration required by the Nirvana Realm server to start and control the HTTP interface |
| nHTTPSInterface | This class contains all the configuration required by the Nirvana Realm server to start and control the HTTPS interface |
| nInsufficientPrivilegesException | represents the exception class that is thrown when an operation is performed and there are insufficient privillages to complete it |
| nInterface | Abstract Class nInterface |
| nInterfaceManager | This class exposes the Realm Servers interface management API so that the control and management of the interfaces can be performed by an authorised Administrator |
| nInterfacePluginConfiguration | This class contains the plugin static information used by the plugin instances |
| nInterfaceStatus | Contains the status of a Nirvana Realm server interface |
| nInterfaceViaEntry | This contains the user parameters which are bound to an Interface |
| nJoinable | All classes that can be joined from one part of the namespace to another implement this interface |
| nJoinDetails | This class contains information about a join between two channels |
| nLeafNode | This class represents the Nirvana Channel or Queue on the Nirvana Realm |
| nLinkNode | Since the Nirvana namespace can contain multiple links to Nirvan Realm servers at different parts of the namespace, including namespace loops, this node represents a RealmServer which has been mounted elseware in the namespace |
| nLogListener | Classes that implement this interface can register with the nRealmNode.addLogListener() to receive the realms log events |
| nNode | All classes that exist in the Nirvana Realm NameSpace extend this object |
| nNodeException | represents the exception class that is thrown when errors occur constructing the nodes to be administered |
| nPluginConfigEntry | Contains information for a plugin configuration entry |
| nPluginConfiguration | This class contains the configuration context for a single plugin on a single HTTP type interface |
| nRealmACLEntry | Extends the nACLEntry class to expose the Realm specific permissions |
| nRealmAdmin | This class provides basic Administration functionality for security based operations |
| nRealmNode | This class represents a Realm within the Nirvana namespace |
| nRemovable | All classes that can be removed from the namespace implement this interface |
| nSecurityGroup | * This class represents a "Security Group" that contains entries for nSubject objects, and other nSecurityGroup objects |
| nServiceACLEntry | Allows the ability to programmatically allow or deny access to a service |
| nSocketInterface | Socket Interface class |
| nSSLInterface | This class contains all the configuration required by the Nirvana Realm server to start and control the SSL interface |
| nSSLInterfaceAPI | This interface is used to expose the SSL attributes for all interfaces that are SSL enabled |
| nThreadEntry | This class is used to represent instances of tasks within a thread pool running within a Nirvana realm |
| nThreadPool | This class is used to represent an instance of a thread pool beign used within a Nirvana realm |
| nUnsupportedCopyException | represents the exception class that is thrown when a copy operation is attempted but cannot be completed |
| nUnsupportedJoinException | represents the exception class that is thrown when a join operation is attempted but cannot be completed |
| nUnsupportedRemoveException | represents the exception class that is thrown when a remove operation is attempted but cannot be completed |
| nZone | Represents a Zone |
| nZoneManager | Represents a Zone manager |
