Index (Dirmi 2.4.2 API)

A B C D E F G I L N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form|System Properties

A

acceptAll(ServerSocket) - Method in interface org.cojen.dirmi.Environment: Accept all server-side connections from the given ServerSocket.
acceptAll(ServerSocket, Predicate<Socket>) - Method in interface org.cojen.dirmi.Environment: Accept all server-side connections from the given ServerSocket.
acceptAll(ServerSocketChannel) - Method in interface org.cojen.dirmi.Environment: Accept all server-side connections from the given ServerSocketChannel.
acceptAll(ServerSocketChannel, Predicate<SocketChannel>) - Method in interface org.cojen.dirmi.Environment: Accept all server-side connections from the given ServerSocketChannel.
accepted(Socket) - Method in interface org.cojen.dirmi.Environment: Call when a server-side connection has been explicitly accepted.
accepted(SocketAddress, SocketAddress, InputStream, OutputStream) - Method in interface org.cojen.dirmi.Environment: Call when a server-side connection has been explicitly accepted.
accepted(SocketChannel) - Method in interface org.cojen.dirmi.Environment: Call when a server-side connection has been explicitly accepted.
access(Object) - Static method in interface org.cojen.dirmi.Session: Access the session that the given remote object is bound to.
adapt(Object) - Method in interface org.cojen.dirmi.Serializer: Adapts this serializer to conform to the given descriptor or else returns this instance if no adaptation is required.
addStateListener(BiPredicate<Session<?>, Throwable>) - Method in interface org.cojen.dirmi.Session: Add a listener which is immediately invoked (in the current thread), or when the session state changes, or when a reconnect attempt fails.
attached(Session<?>) - Method in interface org.cojen.dirmi.SessionAware: Called when this object has been attached to a session and can be accessed remotely.
AutoDispose - Annotation Interface in org.cojen.dirmi: Designates a remote interface as supporting automatic disposal when the client-side object is reclaimed by the garbage collector.

B

Batched - Annotation Interface in org.cojen.dirmi: Designates a remote method as being batched, which can be used to reduce transport overhead.

C

classLoader(ClassLoader) - Method in interface org.cojen.dirmi.Environment: Convenience method to use a ClassLoader for resolving classes.
classResolver(ClassResolver) - Method in interface org.cojen.dirmi.Environment: Set the class resolver to use for newly established sessions.
ClassResolver - Interface in org.cojen.dirmi: Defines a custom class loading scheme.
close() - Method in interface org.cojen.dirmi.Environment: Stops accepting new sessions, closes all acceptors, closes all sessions, and disposes of all exported objects.
close() - Method in interface org.cojen.dirmi.Session: Closes all connections and immediately closes any future connections.
CLOSED - Enum constant in enum class org.cojen.dirmi.Session.State: Indicates that the session is permanently closed.
ClosedException - Exception Class in org.cojen.dirmi: Generic exception indicating that a resource is closed.
ClosedException() - Constructor for exception class org.cojen.dirmi.ClosedException
ClosedException(String) - Constructor for exception class org.cojen.dirmi.ClosedException
ClosedException(String, Throwable) - Constructor for exception class org.cojen.dirmi.ClosedException
ClosedException(Throwable) - Constructor for exception class org.cojen.dirmi.ClosedException
connect(Class<R>, Object, String, int) - Method in interface org.cojen.dirmi.Environment: Call to establish a new client-side session.
connect(Class<R>, Object, SocketAddress) - Method in interface org.cojen.dirmi.Environment: Call to establish a new client-side session.
connect(Session<?>) - Method in interface org.cojen.dirmi.Connector: Called to establish a new socket connection using the session's remote address.
connected(Socket) - Method in interface org.cojen.dirmi.Session: Receives new connections from a Connector.
connected(SocketAddress, SocketAddress, InputStream, OutputStream) - Method in interface org.cojen.dirmi.Session: Receives new connections from a Connector.
connected(SocketChannel) - Method in interface org.cojen.dirmi.Session: Receives new connections from a Connector.
CONNECTED - Enum constant in enum class org.cojen.dirmi.Session.State: Indicates that the session is currently connected, and remote calls are likely to succeed.
connector(Connector) - Method in interface org.cojen.dirmi.Environment: Assign a connector for establishing new client-side socket connections.
Connector - Interface in org.cojen.dirmi: Defines a function which is called whenever client-side socket connections need to be established.
create() - Static method in interface org.cojen.dirmi.Environment: Returns a new Environment instance which uses a default Executor.
create(Executor) - Static method in interface org.cojen.dirmi.Environment: Returns a new Environment instance which uses the given Executor.
create(Executor, boolean) - Static method in interface org.cojen.dirmi.Environment: Returns a new Environment instance which uses the given Executor.
current() - Static method in interface org.cojen.dirmi.Session: Returns the current thread-local session, which is available to a remote method implementation when it's invoked.
customSerializers(Serializer...) - Method in interface org.cojen.dirmi.Environment: Provide custom serializers for newly established sessions.

D

Data - Annotation Interface in org.cojen.dirmi: Designates a remote method which is just data, which is serialized whenever the remote object is transported over the session.
DataUnavailableException - Exception Class in org.cojen.dirmi: Thrown when calling a @Data method when the data isn't available for some reason.
DataUnavailableException() - Constructor for exception class org.cojen.dirmi.DataUnavailableException
DataUnavailableException(String) - Constructor for exception class org.cojen.dirmi.DataUnavailableException
DataUnavailableException(String, Throwable) - Constructor for exception class org.cojen.dirmi.DataUnavailableException
DataUnavailableException(Throwable) - Constructor for exception class org.cojen.dirmi.DataUnavailableException
declared() - Element in annotation interface org.cojen.dirmi.RemoteFailure: By default, if the exception is checked, it must be declared to be thrown.
decode(T, int, byte[], int) - Method in interface org.cojen.dirmi.Pipe.Decoder: Called to decode an object.
decode(T, int, Pipe) - Method in interface org.cojen.dirmi.Pipe.Decoder: Called to decode an object when the requested length was too large.
descriptor() - Method in interface org.cojen.dirmi.Serializer: Returns an opaque serializable object describing the encoding format.
detached(Session<?>) - Method in interface org.cojen.dirmi.SessionAware: Called when this object has been detached from a session which it was previously attached to.
direct() - Static method in interface org.cojen.dirmi.Connector: Returns a default connector that directly connects sockets.
disableReferences() - Method in interface org.cojen.dirmi.Pipe: Disables tracking of object references.
DISCONNECTED - Enum constant in enum class org.cojen.dirmi.Session.State: Indicates that the session isn't connected, and it's about to begin reconnecting.
DisconnectedException - Exception Class in org.cojen.dirmi: Exception which indicates that a session is disconnected, but a reconnect is in progress.
DisconnectedException() - Constructor for exception class org.cojen.dirmi.DisconnectedException
DisconnectedException(String) - Constructor for exception class org.cojen.dirmi.DisconnectedException
DisconnectedException(String, Throwable) - Constructor for exception class org.cojen.dirmi.DisconnectedException
DisconnectedException(Throwable) - Constructor for exception class org.cojen.dirmi.DisconnectedException
dispose(Object) - Static method in interface org.cojen.dirmi.Session: Explicitly dispose a client-side remote object.
DisposedException - Exception Class in org.cojen.dirmi: Thrown when attempting to invoke a method against a disposed object.
DisposedException() - Constructor for exception class org.cojen.dirmi.DisposedException
DisposedException(String) - Constructor for exception class org.cojen.dirmi.DisposedException
DisposedException(String, Throwable) - Constructor for exception class org.cojen.dirmi.DisposedException
DisposedException(Throwable) - Constructor for exception class org.cojen.dirmi.DisposedException
Disposer - Annotation Interface in org.cojen.dirmi: Designates a remote method as being a Remote object disposer, allowing memory to be freed on the remote side.
disposeServer(Object) - Static method in interface org.cojen.dirmi.Session: Explicitly dispose a server-side remote object implementation from the current session.

E

enableReferences() - Method in interface org.cojen.dirmi.Pipe: Enables tracking of object references as they are written, for correctly serializing object graphs, and to potentially reduce the overall encoding size.
encode(T, int, byte[], int) - Method in interface org.cojen.dirmi.Pipe.Encoder: Called to encode an object.
encode(T, int, Pipe) - Method in interface org.cojen.dirmi.Pipe.Encoder: Called to encode an object when the requested length was too large.
Environment - Interface in org.cojen.dirmi: Sharable environment for connecting and accepting remote sessions.
exception() - Element in annotation interface org.cojen.dirmi.RemoteFailure: Specify the exception to throw when the remote call fails.
export(Object, Object) - Method in interface org.cojen.dirmi.Environment: Export a named server-side object.

F

filter() - Element in annotation interface org.cojen.dirmi.Serialized: Specify which classes should be rejected or allowed by serialization.

G

getMessage() - Method in exception class org.cojen.dirmi.RemoteException

I

idleConnectionMillis(int) - Method in interface org.cojen.dirmi.Environment: Set the maximum idle connection time for newly established sessions (±33%).
inputStream() - Method in interface org.cojen.dirmi.Pipe: Returns the pipe's InputStream, which also implements ObjectInput.

L

lenient() - Element in annotation interface org.cojen.dirmi.Restorable: A restorable method which is lenient allows an object to be returned by a method even if the session is currenly disconnected.
Link - Interface in org.cojen.dirmi: Represents an established connection between two endpoints.
local(Environment) - Static method in interface org.cojen.dirmi.Connector: Returns a connector that doesn't establish remote connections, but instead pipes communication directly to accepted sessions of the given environment.
localAddress() - Method in interface org.cojen.dirmi.Link: Returns the local link address, or null if unknown or not applicable.

N

NoReply - Annotation Interface in org.cojen.dirmi: Designates a remote method which doesn't block reading a reply or acknowledgment.
NoSuchObjectException - Exception Class in org.cojen.dirmi: Thrown when attempting to invoke a method against an object that is unknown to a session.
NoSuchObjectException(long) - Constructor for exception class org.cojen.dirmi.NoSuchObjectException
NoSuchObjectException(String) - Constructor for exception class org.cojen.dirmi.NoSuchObjectException

O

org.cojen.dirmi - module org.cojen.dirmi: Bidirectional remote method invocation.
org.cojen.dirmi - package org.cojen.dirmi: Dirmi is a framework for supporting bidirectional remote method invocation.
org.cojen.dirmi.Pipe.RECYCLE_CLOSE - Search tag in org.cojen.dirmi.Pipe.recycle(): System Property
outputStream() - Method in interface org.cojen.dirmi.Pipe: Returns the pipe's OutputStream, which also implements ObjectOutput.

P

pingTimeoutMillis(int) - Method in interface org.cojen.dirmi.Environment: Set the ping timeout for newly established sessions (±33%).
Pipe - Interface in org.cojen.dirmi: A pipe is a bidirectional stream which supports basic object serialization.
Pipe.Decoder<T> - Interface in org.cojen.dirmi: Support for efficiently reading complex objects from a pipe.
Pipe.Encoder<T> - Interface in org.cojen.dirmi: Support for efficiently writing complex objects to a pipe.

R

read(Pipe) - Method in interface org.cojen.dirmi.Serializer: Reads an object from the pipe.
readDecode(T, int, Pipe.Decoder<T>) - Method in interface org.cojen.dirmi.Pipe: Read a complex object from the pipe by invoking a decoder, which can be more efficient than reading from the pipe multiple times.
readObject() - Method in interface org.cojen.dirmi.Pipe: Read and return an object.
readThrowable() - Method in interface org.cojen.dirmi.Pipe: Read and return an object, and if it's a Throwable instance, a local stack trace is stitched in.
reconnect() - Method in interface org.cojen.dirmi.Session: Closes all connections and initiates a reconnect.
reconnectDelayMillis(int) - Method in interface org.cojen.dirmi.Environment: Set the reconnect delay for newly established client sessions (±10%).
RECONNECTED - Enum constant in enum class org.cojen.dirmi.Session.State: Indicates that the session has just finished reconnecting, but remote calls will still fail until the session state is connected.
RECONNECTING - Enum constant in enum class org.cojen.dirmi.Session.State: Indicates that the session is attempting to reconnect, and all remote calls from this session are failing.
recycle() - Method in interface org.cojen.dirmi.Pipe: Attempt to recycle the connection instead of closing it.
Remote - Interface in org.cojen.dirmi: Marker for designating a remote interface.
remoteAddress() - Method in interface org.cojen.dirmi.Link: Returns the remote link address, or null if unknown or not applicable.
remoteAddress() - Method in exception class org.cojen.dirmi.RemoteException: Returns the associated remote address, which can be null if unknown or not applicable.
remoteAddress(SocketAddress) - Method in exception class org.cojen.dirmi.RemoteException: Assign the associated remote address.
RemoteException - Exception Class in org.cojen.dirmi: Defines the default exception for indicating a remote call failure.
RemoteException() - Constructor for exception class org.cojen.dirmi.RemoteException
RemoteException(String) - Constructor for exception class org.cojen.dirmi.RemoteException
RemoteException(String, Throwable) - Constructor for exception class org.cojen.dirmi.RemoteException
RemoteException(Throwable) - Constructor for exception class org.cojen.dirmi.RemoteException
RemoteFailure - Annotation Interface in org.cojen.dirmi: Annotate a remote method or interface to specify what exception is to be used for indicating a remote call failure.
resolveClass(String) - Method in interface org.cojen.dirmi.ClassResolver: Load the class or interface for the given name.
resolveClass(String) - Method in interface org.cojen.dirmi.Session: Resolve a class using the default or custom ClassResolver.
Restorable - Annotation Interface in org.cojen.dirmi: Designates a remote method which returns a remote object which should be restored when a session reconnects.
root() - Method in interface org.cojen.dirmi.Session: Returns the root object which was exported or imported.

S

secure(SSLContext) - Static method in interface org.cojen.dirmi.Connector: Returns a connector that directly connects sockets over TLS/SSL.
Serialized - Annotation Interface in org.cojen.dirmi: Indicates that a remote method should use Java object serialization for the parameters and return value.
Serializer - Interface in org.cojen.dirmi: Supports writing and reading of object instances to/from a pipe.
Session<R> - Interface in org.cojen.dirmi: Manages a client-side or server-side remote session, which establishes new socket connections as needed.
Session.State - Enum Class in org.cojen.dirmi: Indicates the session's current connection state.
SessionAware - Interface in org.cojen.dirmi: Remote objects implementing this interface are notified when they are attached and detached from sessions.
simple(Class<?>) - Static method in interface org.cojen.dirmi.Serializer: Generates and returns a serializer for a record type, an enum type, or a simple class.
skip(Pipe, Consumer<Object>) - Method in interface org.cojen.dirmi.Serializer: Skip an object instead of reading it.
skipNBytes(long) - Method in interface org.cojen.dirmi.Pipe: Skips over and discards exactly n bytes of data from this pipe.
skipObject(Consumer<Object>) - Method in interface org.cojen.dirmi.Pipe: Skip an object instead of reading it.
state() - Method in interface org.cojen.dirmi.Session: Returns the current session state.
supportedTypes() - Method in interface org.cojen.dirmi.Serializer: Returns a non-null set of classes.

T

transferTo(OutputStream, long) - Method in interface org.cojen.dirmi.Pipe: Reads up to n bytes from this pipe and writes them into the given stream.

U

Unbatched - Annotation Interface in org.cojen.dirmi: Designates a remote method which should never be included in a batched request.
uncaught(Throwable) - Method in interface org.cojen.dirmi.Session: Pass an uncaught exception directly to the uncaught exception handler.
uncaughtExceptionHandler(BiConsumer<Session<?>, Throwable>) - Method in interface org.cojen.dirmi.Environment: Set the handler which is invoked for any uncaught exceptions within this environment instance.
uncaughtExceptionHandler(BiConsumer<Session<?>, Throwable>) - Method in interface org.cojen.dirmi.Session: Set the handler which is invoked for any uncaught exceptions within this session instance.
UnimplementedException - Exception Class in org.cojen.dirmi: Thrown when attempting to invoke a method which is unimplemented on the remote side.
UnimplementedException() - Constructor for exception class org.cojen.dirmi.UnimplementedException
UnimplementedException(String) - Constructor for exception class org.cojen.dirmi.UnimplementedException
UnimplementedException(String, Throwable) - Constructor for exception class org.cojen.dirmi.UnimplementedException
UnimplementedException(Throwable) - Constructor for exception class org.cojen.dirmi.UnimplementedException

V

valueOf(String) - Static method in enum class org.cojen.dirmi.Session.State: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.cojen.dirmi.Session.State: Returns an array containing the constants of this enum class, in the order they are declared.

W

write(Pipe, Object) - Method in interface org.cojen.dirmi.Serializer: Writes a non-null object to the pipe.
writeEncode(T, int, Pipe.Encoder<T>) - Method in interface org.cojen.dirmi.Pipe: Write a complex object to the pipe by invoking an encoder, which can be more efficient than writing to the pipe multiple times.
writeNull() - Method in interface org.cojen.dirmi.Pipe: Write a null object reference.
writeObject(Object) - Method in interface org.cojen.dirmi.Pipe: Write an object (or null) to the pipe.

A B C D E F G I L N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form|System Properties