GigaSpaces XAP 9.7.2 API

com.gigaspaces.events
Interface EventSession

All Known Subinterfaces:
DataEventSession

public interface EventSession

a common interface for all EventSession types
a session is a stateful service used to register event listeners to the space
the state of the session contains a set of configuration parameters such as the communication protocol
used to convey the events and whether of not to use FIFO order
the session can be used to register multiple listeners that share the same configuration.
the session provides methods for retrieving the bounded
entities of the session - the transaction and the configuration object.
the interface also provides a lifecycle management support methods.

Since:
6.0
Version:
1.0
Author:
asy ronen
See Also:
EventSessionConfig

Method Summary
 void close()
          closes the session and deregister all listeners.
 EventSessionConfig getSessionConfig()
          Retrieves the bounded configuration object.
 IJSpace getSpace()
           
 Transaction getTransaction()
          Deprecated. Since 8.0.4 - Event sessions with transactions are deprecated.
 

Method Detail

getTransaction

@Deprecated
Transaction getTransaction()
Deprecated. Since 8.0.4 - Event sessions with transactions are deprecated.

Retrieves the bounded transaction

Returns:
the transaction

getSessionConfig

EventSessionConfig getSessionConfig()
Retrieves the bounded configuration object.

Returns:
the EventSessionConfig object.

getSpace

IJSpace getSpace()
Returns:
the space that the session is attached to.

close

void close()
           throws RemoteException,
                  UnknownLeaseException
closes the session and deregister all listeners.

Throws:
RemoteException - if the remove space failed to remove the notification registration.
UnknownLeaseException - if the listeners lease has expired.

GigaSpaces XAP 9.7.2 API

Copyright © GigaSpaces.