Package org.apache.mina.common

Common types required for users to use MINA.

See: Description

Interface Summary

Interface	Description
CloseFuture	An IoFuture for asynchronous close requests.
ConnectFuture	An IoFuture for asynchronous connect requests.
FileRegion	Indicates the region of a file to be sent to the remote host.
IoAcceptor	Accepts incoming connection, communicates with clients, and fires events to IoHandlers.
IoBufferAllocator	Allocates IoBuffers and manages them.
IoConnector	Connects to endpoint, communicates with the server, and fires events to IoHandlers.
IoFilter	A filter which intercepts IoHandler events like Servlet filters.
IoFilter.NextFilter	Represents the next IoFilter in IoFilterChain.
IoFilterChain	A container of IoFilters that forwards IoHandler events to the consisting filters and terminal IoHandler sequentially.
IoFilterChain.Entry	Represents a name-filter pair that an IoFilterChain contains.
IoFilterChainBuilder	An interface that builds IoFilterChain in predefined way when IoSession is created.
IoFuture	Represents the result of an ashynchronous I/O operation.
IoFutureListener<F extends IoFuture>	Something interested in being notified when the result of an IoFuture becomes available.
IoHandler	Handles all I/O events fired by MINA.
IoProcessor<T extends IoSession>	An internal interface to represent an 'I/O processor' that performs actual I/O operations for IoSessions.
IoService	Base interface for all IoAcceptors and IoConnectors that provide I/O service and manage IoSessions.
IoServiceListener	Listens to events related to an IoService.
IoSession	A handle which represents connection between two end-points regardless of transport types.
IoSessionAttributeMap	Stores the user-defined attributes which is provided per IoSession.
IoSessionConfig	The configuration of IoSession.
IoSessionDataStructureFactory	Provides data structures to a newly created session.
IoSessionInitializer<T extends IoFuture>	Defines a callback for obtaining the IoSession during session initialization.
IoSessionRecycler	A connectionless transport can recycle existing sessions by assigning an IoSessionRecycler to an IoService.
ReadFuture	An IoFuture for asynchronous read requests.
TransportMetadata	Provides meta-information that describes an IoService.
WriteFuture	An IoFuture for asynchronous write requests.
WriteRequest	Represents write request fired by IoSession.write(Object).
WriteRequestQueue	Stores WriteRequests which are queued to an IoSession.

Class Summary

Class	Description
AbstractIoAcceptor	A base implementation of IoAcceptor.
AbstractIoAcceptor.AcceptorOperationFuture
AbstractIoBuffer	A base implementation of IoBuffer.
AbstractIoConnector	A base implementation of IoConnector.
AbstractIoService	Base implementation of IoServices.
AbstractIoService.ServiceOperationFuture
AbstractIoSession	Base implementation of IoSession.
AbstractIoSessionConfig	A base implementation of IoSessionConfig.
AbstractPollingConnectionlessIoAcceptor<T extends AbstractIoSession,H>	IoAcceptor for datagram transport (UDP/IP).
AbstractPollingIoAcceptor<T extends AbstractIoSession,H>
AbstractPollingIoConnector<T extends AbstractIoSession,H>
AbstractPollingIoProcessor<T extends AbstractIoSession>	An abstract implementation of IoProcessor which helps transport developers to write an IoProcessor easily.
AttributeKey	A key that makes its parent Map or session attribute to search fast while being debug-friendly by providing the string representation.
CachedBufferAllocator	An IoBufferAllocator that caches the buffers which are likely to be reused during auto-expansion of the buffers.
CompositeIoFuture<E extends IoFuture>	An IoFuture of IoFutures.
DefaultCloseFuture	A default implementation of CloseFuture.
DefaultConnectFuture	A default implementation of ConnectFuture.
DefaultExceptionMonitor	A default ExceptionMonitor implementation that logs uncaught exceptions using Logger.
DefaultFileRegion
DefaultIoFilterChain	A default implementation of IoFilterChain that provides all operations for developers who want to implement their own transport layer once used with AbstractIoSession.
DefaultIoFilterChainBuilder	The default implementation of IoFilterChainBuilder which is useful in most cases.
DefaultIoFuture	A default implementation of IoFuture.
DefaultIoSessionDataStructureFactory	The default IoSessionDataStructureFactory implementation that creates a new HashMap-based IoSessionAttributeMap instance and a new synchronized CircularQueue instance per IoSession.
DefaultReadFuture	A default implementation of WriteFuture.
DefaultTransportMetadata	A default immutable implementation of TransportMetadata.
DefaultWriteFuture	A default implementation of WriteFuture.
DefaultWriteRequest	The default implementation of WriteRequest.
DummySession	A dummy IoSession for unit-testing or non-network-use of the classes that depends on IoSession.
ExceptionMonitor	Monitors uncaught exceptions.
ExpiringSessionRecycler	An IoSessionRecycler with sessions that time out on inactivity.
IdleStatus	Represents the type of idleness of IoSession or IoSession.
IdleStatusChecker	Detects idle sessions and fires sessionIdle events to them.
IoBuffer	A byte buffer used by MINA applications.
IoBufferWrapper	A IoBuffer that wraps a buffer and proxies any operations to it.
IoEvent	An I/O event or an I/O request that MINA provides.
IoFilterAdapter	An abstract adapter class for IoFilter.
IoFilterEvent	An I/O event or an I/O request that MINA provides for IoFilters.
IoHandlerAdapter	An abstract adapter class for IoHandler.
IoServiceListenerSupport	A helper which provides addition and removal of IoServiceListeners and firing events.
IoUtil	A utility class that provides various convenience methods related with IoSession and IoFuture.
SimpleBufferAllocator	A simplistic IoBufferAllocator which simply allocates a new buffer every time.
SimpleIoProcessorPool<T extends AbstractIoSession>	An IoProcessor pool that distributes IoSessions into one or more IoProcessors.
TrafficMask	A type-safe mask that is used to control the traffic of IoSession with IoSession.setTrafficMask(TrafficMask).
UnderivableBuffer	An IoBufferWrapper that prohibits derivation of the buffer.
WriteRequestWrapper	A wrapper for an existing WriteRequest.

Enum Summary

Enum	Description
AbstractPollingIoProcessor.SessionState
IoEventType	An Enum that represents the type of I/O events and requests.

Exception Summary

Exception	Description
BufferDataException	A RuntimeException which is thrown when the data the IoBuffer contains is corrupt.
IoFilterLifeCycleException	A RuntimeException which is thrown when IoFilter.init() or IoFilter.onPostAdd(IoFilterChain, String, org.apache.mina.common.IoFilter.NextFilter) failed.
IoSessionInitializationException	A RuntimeException that is thrown when the initialization of an IoSession fails.
NothingWrittenException	An exception which is thrown when one or more write requests resulted in no actual write operation.
RuntimeIoException	A unchecked version of IOException.
UnknownMessageTypeException	An exception that is thrown when the type of the message cannot be determined.
WriteException	An exception which is thrown when one or more write operations were failed.
WriteTimeoutException	An exception which is thrown when write buffer is not flushed for IoSessionConfig.getWriteTimeout() seconds.
WriteToClosedSessionException	An exception which is thrown when one or more write operations were attempted on a closed session.

Package org.apache.mina.common Description

Common types required for users to use MINA.