com.sun.sgs.impl.service.session
Interface ClientSessionServer

All Superinterfaces:

Remote

public interface ClientSessionServer
extends Remote

A remote interface for communicating between peer client session service implementations.

Method Summary

byte[]	relocatingSession(Identity identity, byte[] sessionId, long oldNodeId) Notifies this server that the client session with the specified identity and sessionId is relocating to this server's node from the old node (specified by oldNodeId).
void	send(byte[] sessionId, byte[] message, byte deliveryOrdinal) Forwards the specified message to be sent to the session with the specified sessionId according to the delivery guarantee with the corresponding deliveryOrdinal (the ordinal representing the Delivery enum).
void	serviceEventQueue(byte[] sessionId) Notifies this server that it should service the event queue of the client session with the specified sessionId.

Method Detail

serviceEventQueue

void serviceEventQueue(byte[] sessionId)
                       throws IOException

Notifies this server that it should service the event queue of the client session with the specified sessionId.

Parameters:

sessionId - a session ID

Throws:

IOException - if a communication problem occurs while invoking this method

send

void send(byte[] sessionId,
          byte[] message,
          byte deliveryOrdinal)
          throws IOException

Forwards the specified message to be sent to the session with the specified sessionId according to the delivery guarantee with the corresponding deliveryOrdinal (the ordinal representing the Delivery enum).

Parameters:

sessionId - a session ID

message - a message

deliveryOrdinal - a delivery guarantee (the ordinal representing the Delivery enum)

Throws:

IOException - if a communication problem occurs while invoking this method

relocatingSession

byte[] relocatingSession(Identity identity,
                         byte[] sessionId,
                         long oldNodeId)
                         throws IOException

Notifies this server that the client session with the specified identity and sessionId is relocating to this server's node from the old node (specified by oldNodeId).

This method returns a relocation key to be used to re-establish the session on this node. The returned relocation key should be supplied to the relocatedSession method of the appropriate ProtocolListener to reestablish the client session.

Parameters:

identity - an identity

sessionId - a session ID

oldNodeId - the ID of the node the session is relocating from

Returns:

a relocation key

Throws:

IOException - if a communication problem occurs while invoking this method