org.cojen.dirmi.core

Class StandardSession

java.lang.Object

org.cojen.dirmi.core.StandardSession

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Link, Session

public class StandardSession
extends Object
implements Session

Standard implementation of a remote method invocation Session.

Author:

Brian S O'Neill

Method Summary

Modifier and Type	Method and Description
void	addCloseListener(SessionCloseListener listener) Add a listener which receives notification when this session is closed.
void	close() Closes the session.
static Session	create(IOExecutor executor, ChannelBroker broker)
static Session	create(IOExecutor executor, ChannelBroker broker, long timeout, TimeUnit unit)
static Session	create(IOExecutor executor, ChannelBroker broker, Timer timer)
void	flush() Flushes all channels of this session, including channels used for batch calls and eventual asynchronous methods.
Object	getLocalAddress()
Object	getRemoteAddress()
Object	receive() Receives a Remote or Serializable object sent by the remote session.
Object	receive(long timeout, TimeUnit unit) Receives a Remote or Serializable object sent by the remote session.
void	send(Object obj) Sends a Remote or Serializable object to be received by the remote session.
void	send(Object obj, long timeout, TimeUnit unit) Sends a Remote or Serializable object to be received by the remote session.
void	setClassLoader(ClassLoader loader) Convenience method to use a ClassLoader for resolving classes.
void	setClassResolver(ClassResolver resolver) Can be called at most once to control how deserialized classes and remote interfaces are resolved.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

create

public static Session create(IOExecutor executor,
                             ChannelBroker broker)
                      throws IOException

Parameters:

executor - shared executor for remote methods

broker - channel broker must always connect to same remote server

Throws:

IOException

create

public static Session create(IOExecutor executor,
                             ChannelBroker broker,
                             long timeout,
                             TimeUnit unit)
                      throws IOException

Parameters:

executor - shared executor for remote methods

broker - channel broker must always connect to same remote server

Throws:

IOException

create

public static Session create(IOExecutor executor,
                             ChannelBroker broker,
                             Timer timer)
                      throws IOException

Parameters:

executor - shared executor for remote methods

broker - channel broker must always connect to same remote server

Throws:

IOException

send

public void send(Object obj)
          throws RemoteException

Description copied from interface: Session

Sends a Remote or Serializable object to be received by the remote session. Any failure during the send forces the session to be closed.

Specified by:

send in interface Session

Parameters:

obj - remote or serializable object to send; can be null

Throws:

RemoteException

send

public void send(Object obj,
                 long timeout,
                 TimeUnit unit)
          throws RemoteException

Description copied from interface: Session

Sends a Remote or Serializable object to be received by the remote session. Any failure or timeout during the send forces the session to be closed.

Specified by:

send in interface Session

Parameters:

obj - remote or serializable object to send; can be null

timeout - how long to wait before timing out, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Throws:

RemoteTimeoutException - if timeout elapses

RemoteException

receive

public Object receive()
               throws RemoteException

Description copied from interface: Session

Receives a Remote or Serializable object sent by the remote session. Any failure during the receive forces the session to be closed.

Specified by:

receive in interface Session

Returns:

remote or serializable object from remote session; can be null

Throws:

RemoteException

receive

public Object receive(long timeout,
                      TimeUnit unit)
               throws RemoteException

Description copied from interface: Session

Receives a Remote or Serializable object sent by the remote session. Any failure or timeout during the receive forces the session to be closed.

Specified by:

receive in interface Session

Parameters:

timeout - how long to wait before timing out, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

remote or serializable object from remote session; can be null

Throws:

RemoteTimeoutException - if timeout elapses

RemoteException

addCloseListener

public void addCloseListener(SessionCloseListener listener)

Description copied from interface: Session

Add a listener which receives notification when this session is closed. Listener is called at most once, and then it is unregistered.

Specified by:

addCloseListener in interface Session

setClassResolver

public void setClassResolver(ClassResolver resolver)

Description copied from interface: Session

Can be called at most once to control how deserialized classes and remote interfaces are resolved. If the implemention chooses to remotely download classes, it is strongly recommended that a security manager be installed. Resolver implementation may choose to enforce this restriction.

Specified by:

setClassResolver in interface Session

Parameters:

resolver - resolves deserialized classes and interfaces; pass null to always use default resolver

setClassLoader

public void setClassLoader(ClassLoader loader)

Description copied from interface: Session

Convenience method to use a ClassLoader for resolving classes.

Specified by:

setClassLoader in interface Session

Parameters:

loader - resolves deserialized classes and interfaces; pass null to always use default resolver

flush

public void flush()
           throws IOException

Description copied from interface: Session

Flushes all channels of this session, including channels used for batch calls and eventual asynchronous methods.

Specified by:

flush in interface Flushable

Specified by:

flush in interface Session

Throws:

IOException

close

public void close()
           throws IOException

Description copied from interface: Session

Closes the session.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Session

Throws:

IOException

getRemoteAddress

public Object getRemoteAddress()

Specified by:

getRemoteAddress in interface Link

Specified by:

getRemoteAddress in interface Session

Returns:

remote session address or null if unknown or not applicable

getLocalAddress

public Object getLocalAddress()

Specified by:

getLocalAddress in interface Link

Specified by:

getLocalAddress in interface Session

Returns:

local session address or null if unknown or not applicable

toString

public String toString()

Overrides:

toString in class Object