org.cojen.dirmi.core

Interface SkeletonSupport

public interface SkeletonSupport

Object passed to a Skeleton instance in order for it to decide when channels can be reused.

Author:

Brian S O'Neill

Method Summary

Modifier and Type	Method and Description
<V> void	completion(Future<V> response, RemoteCompletion<V> completion) Used by asynchronous methods which return a Future to write completion response.
OrderedInvoker	createOrderedInvoker() Called if Skeleton needs to support ordered method invocation.
void	dispose(VersionedIdentifier objId) Called by a disposer method when finished executing.
<R extends Remote> R	failedBatchedRemote(Class<R> type, Throwable cause) Used by batched methods which return a Remote object.
int	finished(InvocationChannel channel, boolean reset) Called after synchronous method is finished with channel.
int	finished(InvocationChannel channel, Throwable cause) Called after synchronous method threw an exception and is finished with channel.
void	finishedAsync(InvocationChannel channel) Called after asynchronous method is finished with channel.
<R extends Remote> void	linkBatchedRemote(Skeleton skeleton, String skeletonMethodName, Identifier typeId, VersionedIdentifier remoteId, Class<R> type, R remote) Used by batched methods which return a Remote object.
Pipe	requestReply(InvocationChannel channel) Called if channel is expected to be a request-reply Pipe.
void	uncaughtException(Throwable cause) Called if an asynchronous method throws an exception which cannot be passed to the remote caller.

Method Detail

requestReply

Pipe requestReply(InvocationChannel channel)

Called if channel is expected to be a request-reply Pipe. This method should not throw any exception.

completion

<V> void completion(Future<V> response,
                    RemoteCompletion<V> completion)
             throws RemoteException

Used by asynchronous methods which return a Future to write completion response.

Throws:

RemoteException

linkBatchedRemote

<R extends Remote> void linkBatchedRemote(Skeleton skeleton,
                                          String skeletonMethodName,
                                          Identifier typeId,
                                          VersionedIdentifier remoteId,
                                          Class<R> type,
                                          R remote)
                                   throws RemoteException

Used by batched methods which return a Remote object. This method creates a skeleton for the given remote object and registers it.

Parameters:

skeleton - skeleton which was invoked

skeletonMethodName - name skeleton method invoked

typeId - type ID assigned by client

remoteId - object ID assigned by client

type - type of remote object

remote - remote object returned by server method

Throws:

RemoteException

failedBatchedRemote

<R extends Remote> R failedBatchedRemote(Class<R> type,
                                         Throwable cause)

Used by batched methods which return a Remote object. This method is called if server method throws an exception.

Parameters:

type - type of remote object

cause - thrown by server method

Returns:

instance of remote object which throws the cause from every method

finished

int finished(InvocationChannel channel,
             boolean reset)

Called after synchronous method is finished with channel. This method should not throw any exception.

Parameters:

reset - pass true if object output should be reset

Returns:

READ_FINISHED or READ_SAME_THREAD

finished

int finished(InvocationChannel channel,
             Throwable cause)

Called after synchronous method threw an exception and is finished with channel. Exception is written to channel and output is reset. This method should not throw any exception.

Returns:

READ_FINISHED or READ_SAME_THREAD

finishedAsync

void finishedAsync(InvocationChannel channel)

Called after asynchronous method is finished with channel. This method should not throw any exception.

uncaughtException

void uncaughtException(Throwable cause)

Called if an asynchronous method throws an exception which cannot be passed to the remote caller.

createOrderedInvoker

OrderedInvoker createOrderedInvoker()

Called if Skeleton needs to support ordered method invocation.

dispose

void dispose(VersionedIdentifier objId)

Called by a disposer method when finished executing.