This class represents a Nirvana session, the logical connection between the client API and the Nirvana realm. More...
Public Member Functions | |
| void | addAsyncExceptionListener (nAsyncExceptionListener listener) throws nIllegalArgumentException |
| Adds a new asynchronous exception listener, which will be notified when an exception occurs while performing an asynchronous operation. More... | |
| void | addConnectionQueueListener (nConnectionQueueListener listener) throws nIllegalArgumentException |
| Adds a new connection queue listener, which will be notified when the internal outbound queue reaches defined limits, such as Reaching high water mark Reaching low water mark Exceeding the time it should take to access the queue object Exceeding the time it should take to push an event onto the queue Exceeding the time for a queue to be blocked due to reaching its high water mark Unless you have explicitly called nConstants.setWriteHandlerType(nConstants.sQueuedWriteHandler), and are therefore using an outbound queue, you will not receive any notifications from this listener. More... | |
| void | addConnectionQueueListener (nConnectionQueueListener listener, boolean hwm, boolean lwm, boolean access, boolean push, boolean block, boolean unblock) throws nIllegalArgumentException |
| Adds a new connection queue listener, which will be notified when the internal outbound queue reaches defined limits, such as Reaching high water mark Reaching low water mark Exceeding the time it should take to access the queue object Exceeding the time it should take to push an event onto the queue Exceeding the time for a queue to be blocked due to reaching its high water mark Unless you have explicitly called nConstants.setWriteHandlerType(nConstants.sQueuedWriteHandler), and are therefore using an outbound queue, you will not receive any notifications from this listener. More... | |
| void | addRealm (com.pcbsys.nirvana.client.nRealm newRealm) throws nRealmAlreadyBoundException, nRealmUnreachableException, nSecurityException, nSessionNotConnectedException, nIllegalArgumentException, nRealmNotFoundException, nUnexpectedResponseException, nSessionPausedException, nRequestTimedOutException, nNameSpaceConflictException |
| Adds (Joins) another realm to the realm this session is connected to. More... | |
| void | addRealm (com.pcbsys.nirvana.client.nRealm newRealm, nSession session) throws nRealmAlreadyBoundException, nRealmUnreachableException, nSecurityException, nSessionNotConnectedException, nIllegalArgumentException, nRealmNotFoundException, nUnexpectedResponseException, nSessionPausedException, nRequestTimedOutException, nNameSpaceConflictException |
| Adds (Joins) another realm to the realm this session is connected to. More... | |
| void | addReconnectHandler (nReconnectHandler handler) |
| Add a session reconnect handler to the session. More... | |
| void | close () |
| Closes this session, disconnecting from the server and killing all threads. | |
| void | commitRegisteredEventsToDataGroups (nRegisteredEvent[] events) throws nSecurityException, nSessionPausedException, nIllegalArgumentException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nMaxBufferSizeExceededException |
| Commit all registered event changes in a single call to the server. More... | |
| void | commitRegisteredEventsToDataGroups (nRegisteredEvent[] events, boolean replace) throws nSecurityException, nSessionPausedException, nIllegalArgumentException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nMaxBufferSizeExceededException |
| Commit all registered event changes in a single call to the server. More... | |
| nCreateResult[] | create (com.pcbsys.nirvana.client.nChannelAttributes[] attr) throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException, nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
| Creates new channels on the realm this session is connected. More... | |
| nChannel | createChannel (com.pcbsys.nirvana.client.nChannelAttributes attr) throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException, nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
| Creates a new channel on the realm this session is connected. More... | |
| nChannel | createChannel (com.pcbsys.nirvana.client.nChannelAttributes attr, long p_initialEID) throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException, nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
| Creates a new channel on the realm this session is connected. More... | |
| nChannel | createChannel (com.pcbsys.nirvana.client.nChannelAttributes attr, long p_initialEID, long privMask) throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
| Creates a new channel on the realm this session is connected. More... | |
| nDataGroup | createDataGroup (String dataGroupName) throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Create a new data group on the server. More... | |
| nDataGroup | createDataGroup (String dataGroupName, nDataGroupListener listener) throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Create a new data group on the server. More... | |
| nDataGroup | createDataGroup (String dataGroupName, nDataGroupListener listener, nConflationAttributes conflationAttributes) throws nRequestTimedOutException, nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Create a new data group on the server. More... | |
| nDataGroup | createDataGroup (String dataGroupName, boolean enableMulticast) throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Create a new data group on the server. More... | |
| nDataGroup | createDataGroup (String dataGroupName, nDataGroupListener listener, boolean enableMulticast) throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Create a new data group on the server. More... | |
| nDataGroup | createDataGroup (String dataGroupName, nDataGroupListener listener, nConflationAttributes conflationAttributes, boolean enableMulticast, boolean dropExpiredEvents) throws nRequestTimedOutException, nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Create a new data group on the server. More... | |
| nDataGroup | createDataGroup (String dataGroupName, nDataGroupListener listener, nConflationAttributes conflationAttributes, boolean enableMulticast, boolean dropExpiredEvents, int groupPriority) throws nRequestTimedOutException, nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Create a new data group on the server. More... | |
| nDataGroup[] | createDataGroups (String[] dataGroupNames) throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Create new data groups on the server if they don't exist, or return them from the local list if found. More... | |
| nDataGroup[] | createDataGroups (String[] dataGroupNames, boolean enableMulticast) throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Create new data groups on the server if they don't exist, or return them from the local list if found. More... | |
| nDataGroup[] | createDataGroups (String[] dataGroupNames, nConflationAttributes conflationAttributes) throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Create new data groups on the server if they don't exist, or return them from the local list if found. More... | |
| nDataGroup[] | createDataGroups (String[] dataGroupNames, nConflationAttributes conflationAttributes, boolean enableMulticast) throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Create new data groups on the server if they don't exist, or return them from the local list if found. More... | |
| nQueue | createQueue (com.pcbsys.nirvana.client.nChannelAttributes attr, long privMask) throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
| Creates a new queue on the realm this session is connected. More... | |
| nQueue | createQueue (com.pcbsys.nirvana.client.nChannelAttributes attr) throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
| Creates a new queue on the realm this session is connected. More... | |
| nDeleteResult[] | delete (com.pcbsys.nirvana.client.nChannelAttributes[] attr) throws nUnknownRemoteRealmException, nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
| Deletes all channels in the array of nChannelAttributes array. More... | |
| void | deleteChannel (com.pcbsys.nirvana.client.nChannelAttributes attr) throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
| Deletes a nirvana channel that exists on the realm this session is connected to, or a joined realm. More... | |
| void | deleteDataGroup (String[] dataGroupNames) throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Deletes the specified data group from the server. More... | |
| void | deleteDataGroup (String dataGroupName) throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Deletes the specified data group from the server. More... | |
| void | deleteDataGroup (nDataGroup group) throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Deletes the specified data group from the server. More... | |
| void | deleteDataGroup (nDataGroup[] groups) throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Deletes the specified data group from the server. More... | |
| void | deleteQueue (com.pcbsys.nirvana.client.nChannelAttributes attr) throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
| Deletes a nirvana queue that exists on the realm this session is connected to, or a joined realm. More... | |
| void | deleteRealm (nRealm aRealm) throws nRealmNotFoundException, nSessionPausedException, nRealmUnreachableException, nSecurityException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException, nRealmInUseException |
| Deletes (unjoins) another realm from the realm this session is connected to. More... | |
| synchronized void | enableThreading (int poolSize) |
| Enables thread pooling for this session. More... | |
| synchronized void | enableThreading () |
| Calling this function starts the internal thread pools. More... | |
| synchronized void | enableThreading (boolean enabled) |
| Calling this function starts the internal thread pools. More... | |
| nFindResult[] | find (nChannelAttributes[] attr) throws nSessionPausedException, nUnknownRemoteRealmException, nSecurityException, nSessionNotConnectedException, nIllegalArgumentException, nUnexpectedResponseException, nRequestTimedOutException |
| Finds and returns an array of nFindResult objects that correspond to the results of the find operations on each nChannelAttributes. More... | |
| nChannel | findChannel (com.pcbsys.nirvana.client.nChannelAttributes attr) throws nChannelNotFoundException, nSessionPausedException, nUnknownRemoteRealmException, nSecurityException, nSessionNotConnectedException, nIllegalArgumentException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalChannelMode |
| Finds and returns a nirvana channel that exists on the realm this session is connected to, or a joined realm. More... | |
| nQueue | findQueue (com.pcbsys.nirvana.client.nChannelAttributes attr) throws nChannelNotFoundException, nSessionPausedException, nUnknownRemoteRealmException, nSecurityException, nSessionNotConnectedException, nIllegalArgumentException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalChannelMode |
| Finds and returns a nirvana queue that exists on the realm this session is connected to, or a joined realm. More... | |
| String | get3rdPartyCookie () throws nSessionNotConnectedException |
| Returns any 3rd party cookies that may have been honoured. More... | |
| nSessionAttributes | getAttrib () |
| Gets the session attribute object associated with this session. More... | |
| nSessionAttributes | getAttributes () |
| Gets the session attribute object associated with this session. More... | |
| boolean | getChannelMultiplexing () |
| Returns true if channel multiplexing has been enabled or not. More... | |
| com.pcbsys.nirvana.client.nChannelAttributes[] | getChannels () throws nSecurityException, nSessionNotConnectedException, nSessionPausedException, nUnexpectedResponseException, nRequestTimedOutException |
| Returns a list of all known channels and queues. More... | |
| com.pcbsys.nirvana.client.nChannelAttributes[] | getChannels (String folder) throws nSecurityException, nSessionNotConnectedException, nSessionPausedException, nUnexpectedResponseException, nRequestTimedOutException |
| Returns a list of all known channels and queues. More... | |
| String | getConnectionList () |
| Returns a comma seperated list of RNAMEs which can be used to access the realm or cluster namespace. More... | |
| int | getCurrentLatency () |
| Returns the round trip time of the last synchronous request that was made. More... | |
| nDataGroup[] | getDataGroups () throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Return the array of nDataGroup objects excluding the default data group. More... | |
| nDataGroup[] | getDataGroups (String prefix) throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Return the array of nDataGroup objects excluding the default data group that match a specific prefix. More... | |
| nDataGroup[] | getDataGroups (nDataGroupListener listener) throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Get all known data groups on the server (excluding the default data group) and register a listener. More... | |
| nDataGroup[] | getDataGroups (String prefix, nDataGroupListener listener) throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Get all known data groups on the server (excluding the default data group) that match a specific prefix, and register a listener against them. More... | |
| nDataGroup | getDefaultDataGroup () throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Return the default data group object. More... | |
| nDataGroup | getDefaultDataGroup (nDataGroupListener listener) throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
| Return the default nDataGroup object, and provide a listener that will receive callbacks when new streams or groups are added or removed. More... | |
| String | getId () throws nSessionNotConnectedException |
| Returns the unique session Id for this session. More... | |
| long | getInputByteCount () |
| Returns the number of bytes received from the server on this session object. More... | |
| int | getKnownGroupCount () |
| Get the size of the known data groups list. More... | |
| long | getOutputByteCount () |
| Returns the number of bytes sent to the server using this session object. More... | |
| long | getQueueSize () |
| Returns the outbound connection queue size. More... | |
| com.pcbsys.nirvana.client.nRealm | getRealm (String name) throws nRealmNotFoundException, nSessionPausedException, nSecurityException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
| Gets a reference to a realm that is already joined. More... | |
| com.pcbsys.nirvana.client.nRealm[] | getRealms () throws nSecurityException, nSessionNotConnectedException, nSessionPausedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
| Returns a list of all known realms on the connected realm. More... | |
| com.pcbsys.nirvana.client.nRealm[] | getRealms (boolean zoneRealms) throws nSecurityException, nSessionNotConnectedException, nSessionPausedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
| Returns a list of all known realms on the connected realm. More... | |
| long | getReceivedEventCount () |
| Return the number of events received by this session. More... | |
| String | getRemoteId () throws nSessionNotConnectedException |
| Returns the rname that this session has used. More... | |
| long | getSentEventCount () |
| Return the number of events sent by this session. More... | |
| int | getServerMaxBufferSize () |
| Gets the maximum client buffer size. More... | |
| String | getServerRealmName () throws nSessionNotConnectedException |
| Returns the sessions server realm name. More... | |
| long | getServerTime () throws nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nSessionPausedException, nSecurityException |
| Gets the current time on the server. More... | |
| long | getSessionConnectionId () |
| Returns the unique connection id associated with this session by the server. More... | |
| String | getStreamId () |
| Get the stream Id for this session if initialised with an nDataStreamListener. More... | |
| nSubject[] | getSubject () throws nSessionNotConnectedException |
| Gets the subject associated with this nirvana session. More... | |
| nSubject | getSubjectObject () throws nSessionNotConnectedException |
| Gets the subject associated with this nirvana session. More... | |
| int | getThreadPoolSize () |
| Returns the current configured thread pool size. More... | |
| String | getUsername () |
| Gets the username associated with this nirvana session. More... | |
| boolean | hasQuorum () throws nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nSessionPausedException, nSecurityException |
| If the realm this session is connected to is part of a cluster then this function will return whether the cluster has Quorum according to the connected realm. More... | |
| void | init () throws nRealmUnreachableException, nSecurityException, nSessionNotConnectedException, nSessionAlreadyInitialisedException |
| Initialises a session object, opening the physical connection to the server. More... | |
| void | init (boolean disconnectIfClusterFails) throws nRealmUnreachableException, nSecurityException, nSessionNotConnectedException, nSessionAlreadyInitialisedException |
| Initialises a session object, opening the physical connection to the server. More... | |
| nDataStream | init (nDataStreamListener streamListener) throws nRealmUnreachableException, nSecurityException, nSessionNotConnectedException, nSessionAlreadyInitialisedException |
| Initialises a session object, opening the physical connection to the server and supplies a nDataStreamListener to receive asynchronous direct events. More... | |
| nDataStream | init (boolean disconnectIfClusterFails, nDataStreamListener streamListener) throws nRealmUnreachableException, nSecurityException, nSessionNotConnectedException, nSessionAlreadyInitialisedException |
| Initialises a session object, opening the physical connection to the server and supplies a nDataStreamListener to receive asynchronous direct events. More... | |
| boolean | isConnected () |
| Returns true if this session is still connected with the remote realm. More... | |
| boolean | isConnectionVirtual () |
| Queries the underlying connection of this session to establish if it is a virtual connection or not. More... | |
| boolean | isMaxBufferSizeClientCheck () |
| Returns whether the elements of the events being sent should be checked against the max buffer size. More... | |
| boolean | isMemberOfCluster () |
| If the realm this session is connected to is part of a cluster then this function will return true. More... | |
| boolean | isPaused () |
| Returns true if this session is paused. More... | |
| synchronized void | pause (boolean releaseRequests) |
| This function pauses delivery of new events to all subscribed nEventListeners until resume is called. More... | |
| synchronized void | pauseStream () throws Exception |
| Pause the events being received by the Data Group Listener. More... | |
| void | removeAsyncExceptionListener (nAsyncExceptionListener listener) throws nIllegalArgumentException |
| Removes an already added asynchronous exception listener, which will not be notified of asynchronous exceptions anymore. More... | |
| void | removeConnectionQueueListener (nConnectionQueueListener listener) throws nIllegalArgumentException |
| Removes an already added connection queue listener, which will not be notified of queue state changes anymore. More... | |
| void | removeReconnectHandler (nReconnectHandler handler) |
| Remove the reconnect handler from the session. More... | |
| synchronized void | resume () |
| Resumes delivery of events to nEventListeners. | |
| synchronized void | resumeStream () throws Exception |
| Resumes the events being received by the Data Group Listener. More... | |
| void | setAdditionalPrincipals (String[] principals) |
| Enable the nSession subject to contain multiple principals which can be used for subject based filtering. More... | |
| void | setChannelMultiplexing (boolean flag) throws nSessionAlreadyInitialisedException |
| Enables or disables the ability to add multiple subscriptions on a channel, by default it is enabled. More... | |
| void | setHTTPURLParameter (String param) |
| Allows the HTTP communication between the client and the realm to include an optional parameter that can be analysed by load balance servers or proxies. More... | |
| void | setReadThreadAsDaemon (boolean isDaemon) |
| Each Nirvana nSession has a dedicated thread used to synchronously read from the underlying transport. More... | |
| void | setThreadPoolSize (int size) |
| Changes the current size of the thread pool to the size passed. More... | |
| nSubscriptionAttributes[] | subscribe (nSubscriptionAttributes[] attributes) throws Exception |
| Subscribe to the channels specified within the nSubscriptionAttributes array. More... | |
| void | unblockThread (String name) |
| Unblocks the thread of the given name that my be in a synchronous call. More... | |
| void | updateConnectionListWithServerList () |
| Update the current session attributes with the RNAMEs retrieved from the server. | |
| void | write (nConsumeEvent event, nAbstractChannel[] destinations) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the event to the specified channel / queue. More... | |
| void | write (nConsumeEvent[] events, nAbstractChannel destination) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the events to the specified channel / queue. More... | |
| void | write (nConsumeEvent[] events, nAbstractChannel[] destinations) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the events to the specified channels / queues. More... | |
| void | write (nConsumeEvent[] evts, nAbstractChannel[] destinations, boolean waitForReply) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the events to the specified channels / queues. More... | |
| void | write (nConsumeEvent evts, nAbstractChannel[] destinations, boolean waitForReply) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the event to the specified channels / queues. More... | |
| void | write (nConsumeEvent[] evts, nAbstractChannel destination, boolean waitForReply) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the events to the specified channels / queues. More... | |
| void | write (nConsumeEvent evt, nAbstractChannel destination, boolean waitForReply) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the event to the specified channel / queue. More... | |
| void | write (Map< nConsumeEvent, nAbstractChannel > list, boolean waitForResponse) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends each event in the list to its corresponding channel / queue. More... | |
| void | writeDataGroup (nConsumeEvent evt, nDataGroup dataGroup) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the event to the specified data group. More... | |
| void | writeDataGroup (nConsumeEvent evt, nDataGroup[] dataGroups) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the event to all of the specified data groups. More... | |
| void | writeDataGroup (nConsumeEvent[] evts, nDataGroup dataGroup) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the list of events to the specified data group. More... | |
| void | writeDataGroup (Map< nConsumeEvent, nDataGroup > list) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends each event in the list to its corresponding data group. More... | |
| void | writeDataGroup (nConsumeEvent[] evts, nDataGroup[] dataGroups) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the list of events to all of the specified data groups. More... | |
| void | writeDataGroup (nConsumeEvent evt, nDataGroup dataGroup, boolean waitForReply) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the event to the specified data group. More... | |
| void | writeDataGroup (nConsumeEvent evt, nDataGroup[] dataGroups, boolean waitForReply) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the event to all of the specified data groups. More... | |
| void | writeDataGroup (nConsumeEvent[] evts, nDataGroup dataGroup, boolean waitForReply) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the list of events to the specified data group. More... | |
| void | writeDataGroup (nConsumeEvent[] evts, nDataGroup[] dataGroups, boolean waitForReply) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the list of events to all of the specified data groups. More... | |
| void | writeDataGroup (Map< nConsumeEvent, nDataGroup > list, boolean waitForResponse) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends each event in the list to its corresponding data group. More... | |
| void | writeDataStream (nConsumeEvent evt, nDataStream stream) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the event to the specified stream. More... | |
| void | writeDataStream (nConsumeEvent evt, nDataStream[] streams) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the event to the specified streams. More... | |
| void | writeDataStream (nConsumeEvent[] evts, nDataStream stream) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the events to the specified stream. More... | |
| void | writeDataStream (nConsumeEvent[] evts, nDataStream[] streams) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the events to the specified streams. More... | |
| void | writeDataStream (Map< nConsumeEvent, nDataStream > list) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends each event in the list to its corresponding data stream. More... | |
| void | writeDataStream (Map< nConsumeEvent, nDataStream > list, boolean waitForResponse) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends each event in the list to its corresponding data stream. More... | |
| void | writeDataStream (nConsumeEvent evt, nDataStream stream, boolean waitForReply) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the event to the specified stream. More... | |
| void | writeDataStream (nConsumeEvent evt, nDataStream[] streams, boolean waitForReply) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the event to the specified streams. More... | |
| void | writeDataStream (nConsumeEvent[] evts, nDataStream stream, boolean waitForReply) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the event to the specified stream. More... | |
| void | writeDataStream (nConsumeEvent[] evts, nDataStream[] streams, boolean waitForReply) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends the event to the specified streams. More... | |
Static Public Member Functions | |
| static int | getMaxBufferSize () |
| Gets the maximum client buffer size. More... | |
| static void | setMaxBufferSize (int size) throws nIllegalArgumentException |
| Sets the maximum client buffer size. More... | |
Protected Member Functions | |
| synchronized void | clearConnection () |
| Close and clear the current fConnection This must not throw. | |
| void | createFactory (nSessionAttributes attrib) |
| Used to make a driver factory with the given session attributes including things like ssl. | |
| nDataGroup[] | getGroupsContaining (nDataGroup group) |
| Locate the groups that currently contain this group. More... | |
| int | getLocalPort () |
| Return the current port this session is connected to. More... | |
| void | registerExtensionCallback (nServerExtensionCallback callback) |
| Used to register for listening to embedded API events. More... | |
| nChannel | returnCachedChannelOrConstruct (com.pcbsys.nirvana.base.nChannelAttributes ca) throws nIllegalChannelMode, nIllegalArgumentException |
| This function is only used by nAdminSession and could be refactored there with some careful thought. More... | |
| nQueue | returnCachedQueueOrConstruct (com.pcbsys.nirvana.base.nChannelAttributes ca) throws nIllegalChannelMode, nIllegalArgumentException |
| This function is only used by nAdminSession and could be refactored there with some careful thought. More... | |
| void | sendExtensionData (long id, byte[] data, nEventProperties props) throws nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException |
| Used to send embedded API events to the server. | |
| void | write (Map< nConsumeEvent, nAbstractChannel > list, boolean waitForResponse, boolean isRegisteredEvent) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends each event in the list to its corresponding channel / queue. More... | |
| void | writeDataGroup (Map< nConsumeEvent, nDataGroup > list, boolean waitForResponse, boolean isRegisteredEvent) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends each event in the list to its corresponding data group. More... | |
| void | writeDataStream (Map< nConsumeEvent, nDataStream > list, boolean waitForResponse, boolean isRegisteredEvent) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
| Sends each event in the list to its corresponding data stream. More... | |
| nEvent | writeEvent (nEvent e) throws nSessionNotConnectedException, nRequestTimedOutException, nSessionPausedException |
| Writes a synchronous or asynchronous event to the associated connection. More... | |
| nEvent | writeEvent (nEvent e, long timeout) throws nSessionNotConnectedException, nRequestTimedOutException, nSessionPausedException |
| nEvent to be written by the connection to the server and depending on the event will receive a sync response More... | |
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. Please note that when using a session to retrieve events from a channel or queue, you can only have 1 listener specifying a set filter per session object. For example if you have a selector set as CCY='USD' you can use that filter by only one object implementing the nEventListener interface per session, otherwise a nUserAlreadySubscribedException will be thrown.
| void com.pcbsys.nirvana.client.nSession.addAsyncExceptionListener | ( | nAsyncExceptionListener | listener | ) | throws nIllegalArgumentException |
Adds a new asynchronous exception listener, which will be notified when an exception occurs while performing an asynchronous operation.
| listener | The asynchronous exception listener to be added |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| void com.pcbsys.nirvana.client.nSession.addConnectionQueueListener | ( | nConnectionQueueListener | listener | ) | throws nIllegalArgumentException |
Adds a new connection queue listener, which will be notified when the internal outbound queue reaches defined limits, such as Reaching high water mark Reaching low water mark Exceeding the time it should take to access the queue object Exceeding the time it should take to push an event onto the queue Exceeding the time for a queue to be blocked due to reaching its high water mark Unless you have explicitly called nConstants.setWriteHandlerType(nConstants.sQueuedWriteHandler), and are therefore using an outbound queue, you will not receive any notifications from this listener.
| listener | The asynchronous exception listener to be added |
| nIllegalArgumentException | if the listener is Null of if already has a listener registered |
| void com.pcbsys.nirvana.client.nSession.addConnectionQueueListener | ( | nConnectionQueueListener | listener, |
| boolean | hwm, | ||
| boolean | lwm, | ||
| boolean | access, | ||
| boolean | push, | ||
| boolean | block, | ||
| boolean | unblock | ||
| ) | throws nIllegalArgumentException |
Adds a new connection queue listener, which will be notified when the internal outbound queue reaches defined limits, such as Reaching high water mark Reaching low water mark Exceeding the time it should take to access the queue object Exceeding the time it should take to push an event onto the queue Exceeding the time for a queue to be blocked due to reaching its high water mark Unless you have explicitly called nConstants.setWriteHandlerType(nConstants.sQueuedWriteHandler), and are therefore using an outbound queue, you will not receive any notifications from this listener.
| listener | The asynchronous exception listener to be added |
| hwm | true to receive notifications of reaching queue high water mark |
| lwm | true to receive notifications of reaching queue low water mark |
| access | true to receive notification of exceeeding queue access time |
| push | true to receive notification of exceeeding queue access and push time |
| block | true to receive notification of exceeeding queue block time |
| nIllegalArgumentException | if the listener is Null of if already has a listener registered |
| void com.pcbsys.nirvana.client.nSession.addRealm | ( | com.pcbsys.nirvana.client.nRealm | newRealm | ) | throws nRealmAlreadyBoundException, nRealmUnreachableException, nSecurityException, nSessionNotConnectedException, nIllegalArgumentException, nRealmNotFoundException, nUnexpectedResponseException, nSessionPausedException, nRequestTimedOutException, nNameSpaceConflictException |
Adds (Joins) another realm to the realm this session is connected to.
| newRealm | The realm to join as an nRealm object |
| nRealmAlreadyBoundException | The realm is known by the server |
| nRealmNotFoundException | The realm is not known by the server |
| nRealmUnreachableException | The specified realm is already configured |
| nSecurityException | User is not authorised for the function |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nNameSpaceConflictException | The realm conflicts with the existing namespace |
| nSessionPausedException | The session is currently paused, please resume |
| void com.pcbsys.nirvana.client.nSession.addRealm | ( | com.pcbsys.nirvana.client.nRealm | newRealm, |
| nSession | session | ||
| ) | throws nRealmAlreadyBoundException, nRealmUnreachableException, nSecurityException, nSessionNotConnectedException, nIllegalArgumentException, nRealmNotFoundException, nUnexpectedResponseException, nSessionPausedException, nRequestTimedOutException, nNameSpaceConflictException |
Adds (Joins) another realm to the realm this session is connected to.
| newRealm | The realm to join as an nRealm object |
| session | A session to the realm we want to add to |
| nRealmAlreadyBoundException | The realm is known by the server |
| nRealmUnreachableException | The specified realm is already configured |
| nRealmNotFoundException | The realm is not known by the server |
| nSecurityException | User is not authorised for the function |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nNameSpaceConflictException | The realm conflicts with the existing namespace |
| nSessionPausedException | The session is currently paused, please resume |
| void com.pcbsys.nirvana.client.nSession.addReconnectHandler | ( | nReconnectHandler | handler | ) |
Add a session reconnect handler to the session.
Usually the handler is passed in when the session is constructed from the nSessionFactory, however this method allows you to pass in a handler once a session has been constructed.
| handler | - the nReconnectHandler object for this session |
| void com.pcbsys.nirvana.client.nSession.commitRegisteredEventsToDataGroups | ( | nRegisteredEvent[] | events | ) | throws nSecurityException, nSessionPausedException, nIllegalArgumentException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nMaxBufferSizeExceededException |
Commit all registered event changes in a single call to the server.
| events | the registered events that have changed |
| nSecurityException | |
| nSessionPausedException | |
| nIllegalArgumentException | |
| nSessionNotConnectedException | |
| nRequestTimedOutException | |
| nUnexpectedResponseException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.commitRegisteredEventsToDataGroups | ( | nRegisteredEvent[] | events, |
| boolean | replace | ||
| ) | throws nSecurityException, nSessionPausedException, nIllegalArgumentException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nMaxBufferSizeExceededException |
Commit all registered event changes in a single call to the server.
| events | the registered events that have changed |
| replace | override the event on the server |
| nSecurityException | |
| nSessionPausedException | |
| nIllegalArgumentException | |
| nSessionNotConnectedException | |
| nRequestTimedOutException | |
| nUnexpectedResponseException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| nCreateResult [] com.pcbsys.nirvana.client.nSession.create | ( | com.pcbsys.nirvana.client.nChannelAttributes[] | attr | ) | throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException, nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
Creates new channels on the realm this session is connected.
| attr | The channel attributes array containing the new channel or queue attributes |
| nUnknownRemoteRealmException | The remote realm responded with an unknown exception |
| nSecurityException | User is not authorised for the function |
| nChannelAlreadyExistsException | The channel already exists |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
| nChannel com.pcbsys.nirvana.client.nSession.createChannel | ( | com.pcbsys.nirvana.client.nChannelAttributes | attr | ) | throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException, nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
Creates a new channel on the realm this session is connected.
If the channel attributes specify a realm different than the one this session is connected to, a transparent redirection will occur and the channel will be created on that realm.
| attr | The channel attributes object containing the parameters for the new channel to be created |
| nUnknownRemoteRealmException | The remote node responded with an unknown exception |
| nSecurityException | User is not authorised for the function |
| nChannelAlreadyExistsException | The requested channel already exists |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
| nChannel com.pcbsys.nirvana.client.nSession.createChannel | ( | com.pcbsys.nirvana.client.nChannelAttributes | attr, |
| long | p_initialEID | ||
| ) | throws nUnknownRemoteRealmException, nSecurityException, nChannelAlreadyExistsException, nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
Creates a new channel on the realm this session is connected.
If the channel attributes specify a realm different than the one this session is connected to, a transparent redirection will occur and the channel will be created on that realm.
| attr | The channel attributes object containing the parameters for the new channel to be created @ param initialEID The channel will be created with the first eid being set to this value by default it is set to 0 but the user can set it to any positive value |
| p_initialEID | The value to start the event id at |
| nUnknownRemoteRealmException | The remote realm responded with an unknown exception |
| nSecurityException | User is not authorised for the function |
| nChannelAlreadyExistsException | The channel already exists |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
| nChannel com.pcbsys.nirvana.client.nSession.createChannel | ( | com.pcbsys.nirvana.client.nChannelAttributes | attr, |
| long | p_initialEID, | ||
| long | privMask | ||
| ) | throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
Creates a new channel on the realm this session is connected.
If the channel attributes specify a realm different than the one this session is connected to, a transparent redirection will occur and the channel will be created on that realm.
| attr | The channel attributes object containing the parameters for the new channel to be created @ param initialEID The channel will be created with the first eid being set to this value by default it is set to 0 but the user can set it to any positive value |
| p_initialEID | The value to start the event id at |
| privMask | Privilege mask to apply to the "everyone" subject for this channel |
| nUnknownRemoteRealmException | The remote realm responded with an unknown exception |
| nSecurityException | User is not authorised for the function |
| nChannelAlreadyExistsException | The channel already exists |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
| nDataGroup com.pcbsys.nirvana.client.nSession.createDataGroup | ( | String | dataGroupName | ) | throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Create a new data group on the server.
If the data group exists already, and the groups have already been retrieved by this nSession the nDataGroup will be returned from the local list of data groups. Otherwise this method will send an event to the server.
| dataGroupName | the name of the data group to create |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nSecurityException | |
| nIllegalArgumentException | |
| nUnexpectedResponseException |
| nDataGroup com.pcbsys.nirvana.client.nSession.createDataGroup | ( | String | dataGroupName, |
| nDataGroupListener | listener | ||
| ) | throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Create a new data group on the server.
If the data group exists already, and the groups have already been retrieved by this nSession the nDataGroup will be returned from the local list of data groups. Otherwise this method will send an event to the server.
| dataGroupName | the name of the data group to create |
| listener | the instance of the nDataGroupListener that will receive the callbacks for this group |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nSecurityException | |
| nUnexpectedResponseException | |
| nIllegalArgumentException |
| nDataGroup com.pcbsys.nirvana.client.nSession.createDataGroup | ( | String | dataGroupName, |
| nDataGroupListener | listener, | ||
| nConflationAttributes | conflationAttributes | ||
| ) | throws nRequestTimedOutException, nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Create a new data group on the server.
If the data group exists already, and the groups have already been retrieved by this nSession the nDataGroup will be returned from the local list of data groups. Otherwise this method will send an event to the server.
| dataGroupName | the name of the data group to create |
| listener | the instance of the nDataGroupListener that will receive the callbacks for this group |
| conflationAttributes | the conflation strategy to use on the data group |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nSecurityException | |
| nUnexpectedResponseException | |
| nIllegalArgumentException |
| nDataGroup com.pcbsys.nirvana.client.nSession.createDataGroup | ( | String | dataGroupName, |
| boolean | enableMulticast | ||
| ) | throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Create a new data group on the server.
If the data group exists already, and the groups have already been retrieved by this nSession the nDataGroup will be returned from the local list of data groups. Otherwise this method will send an event to the server.
| dataGroupName | the name of the data group to create |
| enableMulticast | if set then this datagroup will use the servers multicast configuration to deliver events to clients which can receive events via multicast |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nSecurityException | |
| nIllegalArgumentException | |
| nUnexpectedResponseException |
| nDataGroup com.pcbsys.nirvana.client.nSession.createDataGroup | ( | String | dataGroupName, |
| nDataGroupListener | listener, | ||
| boolean | enableMulticast | ||
| ) | throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Create a new data group on the server.
If the data group exists already, and the groups have already been retrieved by this nSession the nDataGroup will be returned from the local list of data groups. Otherwise this method will send an event to the server.
| dataGroupName | the name of the data group to create |
| listener | the instance of the nDataGroupListener that will receive the callbacks for this group |
| enableMulticast | if set then this datagroup will use the servers multicast configuration to deliver events to clients which can receive events via multicast |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nSecurityException | |
| nUnexpectedResponseException | |
| nIllegalArgumentException |
| nDataGroup com.pcbsys.nirvana.client.nSession.createDataGroup | ( | String | dataGroupName, |
| nDataGroupListener | listener, | ||
| nConflationAttributes | conflationAttributes, | ||
| boolean | enableMulticast, | ||
| boolean | dropExpiredEvents | ||
| ) | throws nRequestTimedOutException, nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Create a new data group on the server.
If the data group exists already, and the groups have already been retrieved by this nSession the nDataGroup will be returned from the local list of data groups. Otherwise this method will send an event to the server.
| dataGroupName | the name of the data group to create |
| listener | the instance of the nDataGroupListener that will receive the callbacks for this group |
| conflationAttributes | the conflation strategy to use on the data group |
| enableMulticast | if set then this datagroup will use the servers multicast configuration to deliver events to clients which can receive events via multicast |
| dropExpiredEvents | Id the client has events queued on the server and these events are replaced then they will not be sent to the client. |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nSecurityException | |
| nUnexpectedResponseException | |
| nIllegalArgumentException |
| nDataGroup com.pcbsys.nirvana.client.nSession.createDataGroup | ( | String | dataGroupName, |
| nDataGroupListener | listener, | ||
| nConflationAttributes | conflationAttributes, | ||
| boolean | enableMulticast, | ||
| boolean | dropExpiredEvents, | ||
| int | groupPriority | ||
| ) | throws nRequestTimedOutException, nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Create a new data group on the server.
If the data group exists already, and the groups have already been retrieved by this nSession the nDataGroup will be returned from the local list of data groups. Otherwise this method will send an event to the server.
| dataGroupName | the name of the data group to create |
| listener | the instance of the nDataGroupListener that will receive the callbacks for this group |
| conflationAttributes | the conflation strategy to use on the data group |
| enableMulticast | if set then this datagroup will use the servers multicast configuration to deliver events to clients which can receive events via multicast |
| dropExpiredEvents | Id the client has events queued on the server and these events are replaced then they will not be sent to the client. |
| groupPriority | a priority to assign to messages delivered through this data group. This value is between 1 and 10, with 10 having the highest priority. |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nSecurityException | |
| nUnexpectedResponseException | |
| nIllegalArgumentException |
| nDataGroup [] com.pcbsys.nirvana.client.nSession.createDataGroups | ( | String[] | dataGroupNames | ) | throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Create new data groups on the server if they don't exist, or return them from the local list if found.
| dataGroupNames | the names of the data groups to create |
| nDataGroup [] com.pcbsys.nirvana.client.nSession.createDataGroups | ( | String[] | dataGroupNames, |
| boolean | enableMulticast | ||
| ) | throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Create new data groups on the server if they don't exist, or return them from the local list if found.
| dataGroupNames | the names of the data groups to create |
| enableMulticast | enable multicast delivery on the Data Groups created |
| nDataGroup [] com.pcbsys.nirvana.client.nSession.createDataGroups | ( | String[] | dataGroupNames, |
| nConflationAttributes | conflationAttributes | ||
| ) | throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Create new data groups on the server if they don't exist, or return them from the local list if found.
| dataGroupNames | the names of the data groups to create |
| conflationAttributes | the conflation strategy to be applied to the data groups |
| nDataGroup [] com.pcbsys.nirvana.client.nSession.createDataGroups | ( | String[] | dataGroupNames, |
| nConflationAttributes | conflationAttributes, | ||
| boolean | enableMulticast | ||
| ) | throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Create new data groups on the server if they don't exist, or return them from the local list if found.
| dataGroupNames | the names of the data groups to create |
| conflationAttributes | the conflation strategy to be applied to the data groups |
| enableMulticast | enable multicast delivery on the Data Groups created |
| nQueue com.pcbsys.nirvana.client.nSession.createQueue | ( | com.pcbsys.nirvana.client.nChannelAttributes | attr, |
| long | privMask | ||
| ) | throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
Creates a new queue on the realm this session is connected.
If the channel attributes specify a realm different than the one this session is connected to, a transparent redirection will occur and the queue will be created on that realm.
| attr | The channel attributes object containing the parameters for the new queue to be created |
| privMask | Privilege mask to apply to the "everyone" subject for this queue |
| nUnknownRemoteRealmException | The remote realm responded with an unknown exception |
| nSecurityException | User is not authorised for the function |
| nChannelAlreadyExistsException | The channel already exists |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
| nQueue com.pcbsys.nirvana.client.nSession.createQueue | ( | com.pcbsys.nirvana.client.nChannelAttributes | attr | ) | throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelAlreadyExistsException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
Creates a new queue on the realm this session is connected.
If the channel attributes specify a realm different than the one this session is connected to, a transparent redirection will occur and the queue will be created on that realm.
| attr | The channel attributes object containing the parameters for the new queue to be created |
| nUnknownRemoteRealmException | The remote realm responded with an unknown exception |
| nSecurityException | User is not authorised for the function |
| nChannelAlreadyExistsException | The channel already exists |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
| nDeleteResult [] com.pcbsys.nirvana.client.nSession.delete | ( | com.pcbsys.nirvana.client.nChannelAttributes[] | attr | ) | throws nUnknownRemoteRealmException, nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
Deletes all channels in the array of nChannelAttributes array.
| attr | The channel attributes array to delete |
| nUnknownRemoteRealmException | The remote realm responded with an unknown exception |
| nSecurityException | User is not authorised for the function |
| nChannelNotFoundException | The channel doesn't exist |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occurred, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
| void com.pcbsys.nirvana.client.nSession.deleteChannel | ( | com.pcbsys.nirvana.client.nChannelAttributes | attr | ) | throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
Deletes a nirvana channel that exists on the realm this session is connected to, or a joined realm.
Note: all events in that channel will be deleted too and are not recoverable.
| attr | The channel attributes of the channel to be deleted |
| nUnknownRemoteRealmException | The remote realm responded with an unknown exception |
| nSecurityException | User is not authorised for the function |
| nChannelNotFoundException | The specified channel could not be found |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
| void com.pcbsys.nirvana.client.nSession.deleteDataGroup | ( | String[] | dataGroupNames | ) | throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Deletes the specified data group from the server.
| dataGroupNames | array of data group names to be deleted |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nSecurityException | |
| nIllegalArgumentException | |
| nUnexpectedResponseException |
| void com.pcbsys.nirvana.client.nSession.deleteDataGroup | ( | String | dataGroupName | ) | throws nIllegalArgumentException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Deletes the specified data group from the server.
| dataGroupName | the name of the data group to delete |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nSecurityException | |
| nIllegalArgumentException | |
| nUnexpectedResponseException |
| void com.pcbsys.nirvana.client.nSession.deleteDataGroup | ( | nDataGroup | group | ) | throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Deletes the specified data group from the server.
| group | the data group to delete |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nSecurityException | |
| nUnexpectedResponseException |
| void com.pcbsys.nirvana.client.nSession.deleteDataGroup | ( | nDataGroup[] | groups | ) | throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Deletes the specified data group from the server.
| groups | the data groups to delete |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nSecurityException | |
| nUnexpectedResponseException |
| void com.pcbsys.nirvana.client.nSession.deleteQueue | ( | com.pcbsys.nirvana.client.nChannelAttributes | attr | ) | throws nUnknownRemoteRealmException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
Deletes a nirvana queue that exists on the realm this session is connected to, or a joined realm.
Note: all events in that queue will be deleted too and are not recoverable.
| attr | The channel attributes of the queue to be deleted |
| nUnknownRemoteRealmException | The remote realm responded with an unknown exception |
| nSecurityException | User is not authorised for the function |
| nChannelNotFoundException | The specified channel could not be found |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
| void com.pcbsys.nirvana.client.nSession.deleteRealm | ( | nRealm | aRealm | ) | throws nRealmNotFoundException, nSessionPausedException, nRealmUnreachableException, nSecurityException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException, nRealmInUseException |
Deletes (unjoins) another realm from the realm this session is connected to.
| aRealm | The realm to unjoin as an nRealm object |
| nRealmNotFoundException | The supplied realm could not be found on the server |
| nSecurityException | User is not authorised for the function |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
| synchronized void com.pcbsys.nirvana.client.nSession.enableThreading | ( | int | poolSize | ) |
Enables thread pooling for this session.
By default the session is configured with only one thread which performs all tasks for this session including event callbacks. If in the user logic of the nEventListener.go() a method is called on the session the session will automatically enable thread pooling.
| poolSize | Number of threads to use within the pool. By default it is 1 |
| synchronized void com.pcbsys.nirvana.client.nSession.enableThreading | ( | ) |
Calling this function starts the internal thread pools.
These pools handle the asynchronous events received as part of a subscribed channel or other such events.
| synchronized void com.pcbsys.nirvana.client.nSession.enableThreading | ( | boolean | enabled | ) |
Calling this function starts the internal thread pools.
These pools handle the asynchronous events received as part of a subscribed channel or other such events.
| enabled | specifies if callbacks should use a thread pool or not |
| nFindResult [] com.pcbsys.nirvana.client.nSession.find | ( | nChannelAttributes[] | attr | ) | throws nSessionPausedException, nUnknownRemoteRealmException, nSecurityException, nSessionNotConnectedException, nIllegalArgumentException, nUnexpectedResponseException, nRequestTimedOutException |
Finds and returns an array of nFindResult objects that correspond to the results of the find operations on each nChannelAttributes.
| attr | The channel attributes of the channels / queues to be found |
| nUnknownRemoteRealmException | The remote realm responded with an unknown exception |
| nSecurityException | User is not authorised for the function |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
| nChannel com.pcbsys.nirvana.client.nSession.findChannel | ( | com.pcbsys.nirvana.client.nChannelAttributes | attr | ) | throws nChannelNotFoundException, nSessionPausedException, nUnknownRemoteRealmException, nSecurityException, nSessionNotConnectedException, nIllegalArgumentException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalChannelMode |
Finds and returns a nirvana channel that exists on the realm this session is connected to, or a joined realm.
| attr | The channel attributes of the channel to be found |
| nChannelNotFoundException | The channel specified could not be found |
| nUnknownRemoteRealmException | The remote realm responded with an unknown exception |
| nSecurityException | User is not authorised for the function |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nIllegalChannelMode | The channel referenced is a queue |
| nSessionPausedException | The session is currently paused, please resume |
| nQueue com.pcbsys.nirvana.client.nSession.findQueue | ( | com.pcbsys.nirvana.client.nChannelAttributes | attr | ) | throws nChannelNotFoundException, nSessionPausedException, nUnknownRemoteRealmException, nSecurityException, nSessionNotConnectedException, nIllegalArgumentException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalChannelMode |
Finds and returns a nirvana queue that exists on the realm this session is connected to, or a joined realm.
| attr | The channel attributes of the queue to be found |
| nChannelNotFoundException | The specified queue could not be found |
| nUnknownRemoteRealmException | The remote realm responded with an unknown exception |
| nSecurityException | User is not authorised for the function |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nIllegalChannelMode | The queue referenced is a channel |
| nSessionPausedException | The session is currently paused, please resume |
| String com.pcbsys.nirvana.client.nSession.get3rdPartyCookie | ( | ) | throws nSessionNotConnectedException |
Returns any 3rd party cookies that may have been honoured.
| nSessionNotConnectedException | Current session is not connected |
| nSessionAttributes com.pcbsys.nirvana.client.nSession.getAttrib | ( | ) |
Gets the session attribute object associated with this session.
| nSessionAttributes com.pcbsys.nirvana.client.nSession.getAttributes | ( | ) |
Gets the session attribute object associated with this session.
| boolean com.pcbsys.nirvana.client.nSession.getChannelMultiplexing | ( | ) |
Returns true if channel multiplexing has been enabled or not.
| com.pcbsys.nirvana.client.nChannelAttributes [] com.pcbsys.nirvana.client.nSession.getChannels | ( | ) | throws nSecurityException, nSessionNotConnectedException, nSessionPausedException, nUnexpectedResponseException, nRequestTimedOutException |
Returns a list of all known channels and queues.
| nSecurityException | User is not authorised for the function |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nSessionPausedException | The session is currently paused, please resume |
| com.pcbsys.nirvana.client.nChannelAttributes [] com.pcbsys.nirvana.client.nSession.getChannels | ( | String | folder | ) | throws nSecurityException, nSessionNotConnectedException, nSessionPausedException, nUnexpectedResponseException, nRequestTimedOutException |
Returns a list of all known channels and queues.
| folder | specify the starting point in the namespace within which to retrieve the channels |
| nSecurityException | User is not authorised for the function |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nSessionPausedException | The session is currently paused, please resume |
| String com.pcbsys.nirvana.client.nSession.getConnectionList | ( | ) |
Returns a comma seperated 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.
| int com.pcbsys.nirvana.client.nSession.getCurrentLatency | ( | ) |
Returns the round trip time of the last synchronous request that was made.
| nDataGroup [] com.pcbsys.nirvana.client.nSession.getDataGroups | ( | ) | throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Return the array of nDataGroup objects excluding the default data group.
| nDataGroup [] com.pcbsys.nirvana.client.nSession.getDataGroups | ( | String | prefix | ) | throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Return the array of nDataGroup objects excluding the default data group that match a specific prefix.
| prefix | a string prefix to match against existing data groups, only those matching will be returned |
| nDataGroup [] com.pcbsys.nirvana.client.nSession.getDataGroups | ( | nDataGroupListener | listener | ) | throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Get all known data groups on the server (excluding the default data group) and register a listener.
The listener will receive callbacks whenever a stream or group is created/deleted or added/removed from a group.
| listener | the instance of the nDataGroupListener that will receive callbacks for all known data groups including the default |
| nDataGroup [] com.pcbsys.nirvana.client.nSession.getDataGroups | ( | String | prefix, |
| nDataGroupListener | listener | ||
| ) | throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Get all known data groups on the server (excluding the default data group) that match a specific prefix, and register a listener against them.
The listener will receive callbacks whenever a stream or group is created/deleted or added/removed from a group.
| listener | the instance of the nDataGroupListener that will receive callbacks for all known data groups including the default |
| prefix | a string prefix to match against existing data groups, only those matching will be returned |
| nDataGroup com.pcbsys.nirvana.client.nSession.getDefaultDataGroup | ( | ) | throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Return the default data group object.
| nDataGroup com.pcbsys.nirvana.client.nSession.getDefaultDataGroup | ( | nDataGroupListener | listener | ) | throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nSecurityException, nUnexpectedResponseException |
Return the default nDataGroup object, and provide a listener that will receive callbacks when new streams or groups are added or removed.
| listener | the instance of the nDataGroupListener that will receive the callbacks to the default group |
|
protected |
Locate the groups that currently contain this group.
| group | the group to check |
| String com.pcbsys.nirvana.client.nSession.getId | ( | ) | throws nSessionNotConnectedException |
Returns the unique session Id for this session.
| nSessionNotConnectedException | Current session is not connected |
| long com.pcbsys.nirvana.client.nSession.getInputByteCount | ( | ) |
Returns the number of bytes received from the server on this session object.
| int com.pcbsys.nirvana.client.nSession.getKnownGroupCount | ( | ) |
Get the size of the known data groups list.
|
protected |
Return the current port this session is connected to.
|
static |
Gets the maximum client buffer size.
The default value is 1 MB
| long com.pcbsys.nirvana.client.nSession.getOutputByteCount | ( | ) |
Returns the number of bytes sent to the server using this session object.
| long com.pcbsys.nirvana.client.nSession.getQueueSize | ( | ) |
Returns the outbound connection queue size.
| com.pcbsys.nirvana.client.nRealm com.pcbsys.nirvana.client.nSession.getRealm | ( | String | name | ) | throws nRealmNotFoundException, nSessionPausedException, nSecurityException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
Gets a reference to a realm that is already joined.
| name | A string specifying the name of the realm to be returned |
| nRealmNotFoundException | The realm name supplied could not be found on the server |
| nSecurityException | User is not authorised for the function |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
| com.pcbsys.nirvana.client.nRealm [] com.pcbsys.nirvana.client.nSession.getRealms | ( | ) | throws nSecurityException, nSessionNotConnectedException, nSessionPausedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
Returns a list of all known realms on the connected realm.
| nSecurityException | User is not authorised for the function |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
| com.pcbsys.nirvana.client.nRealm [] com.pcbsys.nirvana.client.nSession.getRealms | ( | boolean | zoneRealms | ) | throws nSecurityException, nSessionNotConnectedException, nSessionPausedException, nUnexpectedResponseException, nRequestTimedOutException, nIllegalArgumentException |
Returns a list of all known realms on the connected realm.
| nSecurityException | User is not authorised for the function |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| nSessionPausedException | The session is currently paused, please resume |
| long com.pcbsys.nirvana.client.nSession.getReceivedEventCount | ( | ) |
Return the number of events received by this session.
| String com.pcbsys.nirvana.client.nSession.getRemoteId | ( | ) | throws nSessionNotConnectedException |
Returns the rname that this session has used.
| nSessionNotConnectedException | Current session is not connected |
| long com.pcbsys.nirvana.client.nSession.getSentEventCount | ( | ) |
Return the number of events sent by this session.
| int com.pcbsys.nirvana.client.nSession.getServerMaxBufferSize | ( | ) |
Gets the maximum client buffer size.
The default value is 1 MB
| String com.pcbsys.nirvana.client.nSession.getServerRealmName | ( | ) | throws nSessionNotConnectedException |
Returns the sessions server realm name.
| nSessionNotConnectedException | If the session is not currently connected with the server |
| long com.pcbsys.nirvana.client.nSession.getServerTime | ( | ) | throws nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nSessionPausedException, nSecurityException |
Gets the current time on the server.
| nSecurityException | User is not authorised for the function |
| nSessionNotConnectedException | Current session is not connected |
| nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
| nRequestTimedOutException | The server has not responded to the request in the timeout period |
| nSessionPausedException | The session is currently paused, please resume |
| long com.pcbsys.nirvana.client.nSession.getSessionConnectionId | ( | ) |
Returns the unique connection id associated with this session by the server.
| String com.pcbsys.nirvana.client.nSession.getStreamId | ( | ) |
Get the stream Id for this session if initialised with an nDataStreamListener.
| nSubject [] com.pcbsys.nirvana.client.nSession.getSubject | ( | ) | throws nSessionNotConnectedException |
Gets the subject associated with this nirvana session.
| nSessionNotConnectedException | If the session is not currently connected with the server |
| nSubject com.pcbsys.nirvana.client.nSession.getSubjectObject | ( | ) | throws nSessionNotConnectedException |
Gets the subject associated with this nirvana session.
| nSessionNotConnectedException | If the session is not currently connected with the server |
| int com.pcbsys.nirvana.client.nSession.getThreadPoolSize | ( | ) |
Returns the current configured thread pool size.
| String com.pcbsys.nirvana.client.nSession.getUsername | ( | ) |
Gets the username associated with this nirvana session.
| boolean com.pcbsys.nirvana.client.nSession.hasQuorum | ( | ) | throws nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nSessionPausedException, nSecurityException |
If the realm this session is connected to is part of a cluster then this function will return whether the cluster has Quorum according to the connected realm.
| void com.pcbsys.nirvana.client.nSession.init | ( | ) | throws nRealmUnreachableException, nSecurityException, nSessionNotConnectedException, nSessionAlreadyInitialisedException |
Initialises a session object, opening the physical connection to the server.
| nRealmUnreachableException | if the realm is currently not available |
| nSessionNotConnectedException | Current session is not connected |
| nSessionAlreadyInitialisedException | The session has already been initialised |
| nSecurityException | Insufficient privileges |
| void com.pcbsys.nirvana.client.nSession.init | ( | boolean | disconnectIfClusterFails | ) | throws nRealmUnreachableException, nSecurityException, nSessionNotConnectedException, nSessionAlreadyInitialisedException |
Initialises a session object, opening the physical connection to the server.
| disconnectIfClusterFails | - if the cluster loses quorum, should this nSession become disconnected (true/false) |
| nRealmUnreachableException | if the realm is currently not available |
| nSessionNotConnectedException | Current session is not connected |
| nSessionAlreadyInitialisedException | The session has already been initialised |
| nSecurityException | Insufficient privileges |
| nDataStream com.pcbsys.nirvana.client.nSession.init | ( | nDataStreamListener | streamListener | ) | throws nRealmUnreachableException, nSecurityException, nSessionNotConnectedException, nSessionAlreadyInitialisedException |
Initialises a session object, opening the physical connection to the server and supplies a nDataStreamListener to receive asynchronous direct events.
| streamListener | - a stream listener to receive asynchronous events |
| nRealmUnreachableException | if the realm is currently not available |
| nSessionNotConnectedException | Current session is not connected |
| nSessionAlreadyInitialisedException | The session has already been initialised |
| nSecurityException | Insufficient privileges |
| nDataStream com.pcbsys.nirvana.client.nSession.init | ( | boolean | disconnectIfClusterFails, |
| nDataStreamListener | streamListener | ||
| ) | throws nRealmUnreachableException, nSecurityException, nSessionNotConnectedException, nSessionAlreadyInitialisedException |
Initialises a session object, opening the physical connection to the server and supplies a nDataStreamListener to receive asynchronous direct events.
| disconnectIfClusterFails | - if the cluster loses quorum, should this nSession become disconnected (true/false) |
| streamListener | - a stream listener to receive asynchronous events |
| nRealmUnreachableException | if the realm is currently not available |
| nSessionNotConnectedException | Current session is not connected |
| nSessionAlreadyInitialisedException | The session has already been initialised |
| nSecurityException | Insufficient privileges |
| boolean com.pcbsys.nirvana.client.nSession.isConnected | ( | ) |
Returns true if this session is still connected with the remote realm.
| boolean com.pcbsys.nirvana.client.nSession.isConnectionVirtual | ( | ) |
Queries the underlying connection of this session to establish if it is a virtual connection or not.
| boolean com.pcbsys.nirvana.client.nSession.isMaxBufferSizeClientCheck | ( | ) |
Returns whether the elements of the events being sent should be checked against the max buffer size.
| boolean com.pcbsys.nirvana.client.nSession.isMemberOfCluster | ( | ) |
If the realm this session is connected to is part of a cluster then this function will return true.
| boolean com.pcbsys.nirvana.client.nSession.isPaused | ( | ) |
Returns true if this session is paused.
| synchronized void com.pcbsys.nirvana.client.nSession.pause | ( | boolean | releaseRequests | ) |
This function pauses delivery of new events to all subscribed nEventListeners until resume is called.
| releaseRequests | specifies whether to release any outstanding synchronous requests awaiting responses from the server |
| synchronized void com.pcbsys.nirvana.client.nSession.pauseStream | ( | ) | throws Exception |
Pause the events being received by the Data Group Listener.
This is not currently implemented
| Exception |
|
protected |
Used to register for listening to embedded API events.
| callback | embedded events |
| void com.pcbsys.nirvana.client.nSession.removeAsyncExceptionListener | ( | nAsyncExceptionListener | listener | ) | throws nIllegalArgumentException |
Removes an already added asynchronous exception listener, which will not be notified of asynchronous exceptions anymore.
| listener | The asynchronous exception listener to be added |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| void com.pcbsys.nirvana.client.nSession.removeConnectionQueueListener | ( | nConnectionQueueListener | listener | ) | throws nIllegalArgumentException |
Removes an already added connection queue listener, which will not be notified of queue state changes anymore.
| listener | The asynchronous exception listener to be added |
| nIllegalArgumentException | if the listener is Null of if no listener registered |
| void com.pcbsys.nirvana.client.nSession.removeReconnectHandler | ( | nReconnectHandler | handler | ) |
Remove the reconnect handler from the session.
| handler | - the reconnect handler to be removed |
| synchronized void com.pcbsys.nirvana.client.nSession.resumeStream | ( | ) | throws Exception |
Resumes the events being received by the Data Group Listener.
This is not curently implemented
| Exception |
|
protected |
This function is only used by nAdminSession and could be refactored there with some careful thought.
| ca | the channel attributes to use |
| Exception |
|
protected |
This function is only used by nAdminSession and could be refactored there with some careful thought.
| ca | the queue attributes to use |
| void com.pcbsys.nirvana.client.nSession.setAdditionalPrincipals | ( | String[] | principals | ) |
| void com.pcbsys.nirvana.client.nSession.setChannelMultiplexing | ( | boolean | flag | ) | throws nSessionAlreadyInitialisedException |
Enables or disables the ability to add multiple subscriptions on a channel, by default it is enabled.
This must be called prior to calling session init
| flag | Boolean flag to enable/disable |
| nSessionAlreadyInitialisedException |
| void com.pcbsys.nirvana.client.nSession.setHTTPURLParameter | ( | String | param | ) |
Allows the HTTP communication between the client and the realm to include an optional parameter that can be analysed by load balance servers or proxies.
| param | Parameter in the form of : ?param |
|
static |
Sets the maximum client buffer size.
The default value is 1 MB
| size | an int specifying the new maximum client buffer size |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| void com.pcbsys.nirvana.client.nSession.setReadThreadAsDaemon | ( | boolean | isDaemon | ) |
Each Nirvana nSession has a dedicated thread used to synchronously read from the underlying transport.
This thread is set as non-daemon thread by default. This is to ensure that on program exit, or Main thread exit, callstacks are correctly unwound. Setting the read thread to be a daemon thread may cause your program to prematurely exit when all other non-daemon threads exit. This method should be used with extreme care.
| isDaemon | specifies whether to set the read thread as a daemon |
| void com.pcbsys.nirvana.client.nSession.setThreadPoolSize | ( | int | size | ) |
Changes the current size of the thread pool to the size passed.
| size | New size of the thread pool |
| nSubscriptionAttributes [] com.pcbsys.nirvana.client.nSession.subscribe | ( | nSubscriptionAttributes[] | attributes | ) | throws Exception |
Subscribe to the channels specified within the nSubscriptionAttributes array.
| attributes | - the details of each channel subscription |
| Exception | if the server encounters any problem during this operation |
| nIllegalArgumentException | if attributes contains a illegal value |
| void com.pcbsys.nirvana.client.nSession.unblockThread | ( | String | name | ) |
Unblocks the thread of the given name that my be in a synchronous call.
| name | the name of the thread |
| void com.pcbsys.nirvana.client.nSession.write | ( | nConsumeEvent | event, |
| nAbstractChannel[] | destinations | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the event to the specified channel / queue.
| event | the event to write to the streams |
| destinations | the array of channels / queues to write to |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.write | ( | nConsumeEvent[] | events, |
| nAbstractChannel | destination | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the events to the specified channel / queue.
| events | the array of events to write to the channel |
| destination | the stream to write to |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.write | ( | nConsumeEvent[] | events, |
| nAbstractChannel[] | destinations | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the events to the specified channels / queues.
| events | the array of events to write to the channels / queues |
| destinations | the array of channels / queues to write to |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.write | ( | nConsumeEvent[] | evts, |
| nAbstractChannel[] | destinations, | ||
| boolean | waitForReply | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the events to the specified channels / queues.
| evts | the array of events to write to the channels / queues |
| destinations | the array of channels / queues to write to |
| waitForReply | if true then the method will not return until it receives a response from the server |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.write | ( | nConsumeEvent | evts, |
| nAbstractChannel[] | destinations, | ||
| boolean | waitForReply | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the event to the specified channels / queues.
| evts | the event to write to the channels / queues |
| destinations | the array of channels / queues to write to |
| waitForReply | if true then the method will not return until it receives a response from the server |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.write | ( | nConsumeEvent[] | evts, |
| nAbstractChannel | destination, | ||
| boolean | waitForReply | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the events to the specified channels / queues.
| evts | the array of events to write to the channel / queue |
| destination | the channel / queue to write to |
| waitForReply | if true then the method will not return until it receives a response from the server |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.write | ( | nConsumeEvent | evt, |
| nAbstractChannel | destination, | ||
| boolean | waitForReply | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the event to the specified channel / queue.
| evt | the event to write to the channel / queue |
| destination | the channel / queue to write to |
| waitForReply | if true then the method will not return until it receives a response from the server |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.write | ( | Map< nConsumeEvent, nAbstractChannel > | list, |
| boolean | waitForResponse | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends each event in the list to its corresponding channel / queue.
| list | <key,value> list of nConsumeEvent and channel / queue |
| waitForResponse | if true then the method will not return until it receives a response from the server |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
|
protected |
Sends each event in the list to its corresponding channel / queue.
| list | <key,value> list of nConsumeEvent and data groups |
| waitForResponse | if true then the method will not return until it receives a response from the server |
| isRegisteredEvent | if this is true, the events will be handled as a list of nRegisteredEvents |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataGroup | ( | nConsumeEvent | evt, |
| nDataGroup | dataGroup | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the event to the specified data group.
| evt | the event to write to the data group |
| dataGroup | the data group to write to |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataGroup | ( | nConsumeEvent | evt, |
| nDataGroup[] | dataGroups | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the event to all of the specified data groups.
| evt | the event to write to the data groups |
| dataGroups | the array of data groups to write to |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataGroup | ( | nConsumeEvent[] | evts, |
| nDataGroup | dataGroup | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the list of events to the specified data group.
| evts | the array of events to write to the group |
| dataGroup | the data group to write to |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataGroup | ( | Map< nConsumeEvent, nDataGroup > | list | ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends each event in the list to its corresponding data group.
| list | the <key,value> list of nConsumeEvent and data groups |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataGroup | ( | nConsumeEvent[] | evts, |
| nDataGroup[] | dataGroups | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the list of events to all of the specified data groups.
| evts | the array of events to write to the groups |
| dataGroups | the groups to write to |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataGroup | ( | nConsumeEvent | evt, |
| nDataGroup | dataGroup, | ||
| boolean | waitForReply | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the event to the specified data group.
| evt | the event to write to the group |
| dataGroup | the data group to write to |
| waitForReply | if true then the method will not return until it receives a response from the server |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataGroup | ( | nConsumeEvent | evt, |
| nDataGroup[] | dataGroups, | ||
| boolean | waitForReply | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the event to all of the specified data groups.
| evt | the event to write to the groups |
| dataGroups | the array of data groups to write to |
| waitForReply | if true then the method will not return until it receives a response from the server |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataGroup | ( | nConsumeEvent[] | evts, |
| nDataGroup | dataGroup, | ||
| boolean | waitForReply | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the list of events to the specified data group.
| evts | the array of events to write to the group |
| dataGroup | the data group to write to |
| waitForReply | if true then the method will not return until it receives a response from the server |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataGroup | ( | nConsumeEvent[] | evts, |
| nDataGroup[] | dataGroups, | ||
| boolean | waitForReply | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the list of events to all of the specified data groups.
| evts | the array of events to write to the groups |
| dataGroups | the array of groups to write to |
| waitForReply | if true then the method will not return until it receives a response from the server |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataGroup | ( | Map< nConsumeEvent, nDataGroup > | list, |
| boolean | waitForResponse | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends each event in the list to its corresponding data group.
| list | <key,value> list of nConsumeEvent and data groups |
| waitForResponse | if true then the method will not return until it receives a response from the server |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
|
protected |
Sends each event in the list to its corresponding data group.
| list | <key,value> list of nConsumeEvent and data groups |
| waitForResponse | if true then the method will not return until it receives a response from the server |
| isRegisteredEvent | if this is true, the events will be handled as a list of nRegisteredEvents |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataStream | ( | nConsumeEvent | evt, |
| nDataStream | stream | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the event to the specified stream.
| evt | the event to write to the stream |
| stream | the stream to write to |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataStream | ( | nConsumeEvent | evt, |
| nDataStream[] | streams | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the event to the specified streams.
| evt | the event to write to the streams |
| streams | the array of streams to write to |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataStream | ( | nConsumeEvent[] | evts, |
| nDataStream | stream | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the events to the specified stream.
| evts | the array of events to write to the stream |
| stream | the stream to write to |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataStream | ( | nConsumeEvent[] | evts, |
| nDataStream[] | streams | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the events to the specified streams.
| evts | the array of events to write to the stream |
| streams | the array of streams to write to |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataStream | ( | Map< nConsumeEvent, nDataStream > | list | ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends each event in the list to its corresponding data stream.
| list | the <key,value> list of nConsumeEvent and data streams |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataStream | ( | Map< nConsumeEvent, nDataStream > | list, |
| boolean | waitForResponse | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends each event in the list to its corresponding data stream.
| list | <key,value> list of nConsumeEvent and data streams |
| waitForResponse | if true then the method will not return until it receives a response from the server |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
|
protected |
Sends each event in the list to its corresponding data stream.
| list | <key,value> list of nConsumeEvent and data streams |
| waitForResponse | if true then the method will not return until it receives a response from the server |
| isRegisteredEvent | if this is true, the events will be handled as a list of nRegisteredEvents |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataStream | ( | nConsumeEvent | evt, |
| nDataStream | stream, | ||
| boolean | waitForReply | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the event to the specified stream.
| evt | the event to write to the stream |
| stream | the data stream to write to |
| waitForReply | if true then the method will not return until it receives a response from the server |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataStream | ( | nConsumeEvent | evt, |
| nDataStream[] | streams, | ||
| boolean | waitForReply | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the event to the specified streams.
| evt | the event to write to the streams |
| streams | the array of streams to write to |
| waitForReply | if true then the method will not return until it receives a response from the server |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataStream | ( | nConsumeEvent[] | evts, |
| nDataStream | stream, | ||
| boolean | waitForReply | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the event to the specified stream.
| evts | the array of events to write to the stream |
| stream | the stream to write to |
| waitForReply | if true then the method will not return until it receives a response from the server |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
| void com.pcbsys.nirvana.client.nSession.writeDataStream | ( | nConsumeEvent[] | evts, |
| nDataStream[] | streams, | ||
| boolean | waitForReply | ||
| ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nMaxBufferSizeExceededException |
Sends the event to the specified streams.
| evts | the array of events to write to the streams |
| streams | the array of streams to write to |
| waitForReply | if true then the method will not return until it receives a response from the server |
| nSecurityException | |
| nRequestTimedOutException | |
| nSessionPausedException | |
| nSessionNotConnectedException | |
| nMaxBufferSizeExceededException | is thrown when elements of the event being sent exceed the connection's max buffer size |
|
protected |
Writes a synchronous or asynchronous event to the associated connection.
WARNING: Must synchronise the event PRIOR to sending the event to the server. This is because the server may respond faster than the client can move into the synchronised block and hence will miss the notify and would then wait for the time out. This would make every one sad and miserable.. So don't do it.
| e | The event to be written |
| nSessionNotConnectedException | Current session is not connected |
| nRequestTimedOutException | <Enter Exception Description> |
|
protected |
nEvent to be written by the connection to the server and depending on the event will receive a sync response
| e | event to be written |
| timeout | the max lenght of time to wait for a response from the server |