omero.api

Interface _ClientCallbackOperationsNC

All Known Subinterfaces:

ClientCallback

All Known Implementing Classes:

_ClientCallbackDisp, _ClientCallbackTie

public interface _ClientCallbackOperationsNC

Primary callback interface for interaction between client and server session (""ServiceFactory""). Where possible these methods will be called one-way to prevent clients from hanging the server.

Method Summary

Modifier and Type	Method and Description
void	requestHeartbeat() Heartbeat-request made by the server to guarantee that the client is alive.
void	sessionClosed() The session to which this ServiceFactory is connected has been closed.
void	shutdownIn(long milliseconds) Message that the server will be shutting down in the given number of milliseconds, after which all new and running method invocations will receive a CancelledException.

Method Detail

requestHeartbeat

void requestHeartbeat()

Heartbeat-request made by the server to guarantee that the client is alive. If the client is still active, then some method should be made on the server to update the last idle time.

sessionClosed

void sessionClosed()

The session to which this ServiceFactory is connected has been closed. Almost no further method calls (if any) are possible. Create a new session via omero.client.createSession()

shutdownIn

void shutdownIn(long milliseconds)

Message that the server will be shutting down in the given number of milliseconds, after which all new and running method invocations will receive a CancelledException.