NioProcessor (Apache MINA 2.0.0-M3 API Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.mina.transport.socket.nio
Class NioProcessor

java.lang.Object
  org.apache.mina.core.polling.AbstractPollingIoProcessor<NioSession>
      org.apache.mina.transport.socket.nio.NioProcessor

All Implemented Interfaces:: IoProcessor<NioSession>

public final class NioProcessor
extends AbstractPollingIoProcessor<NioSession>
extends AbstractPollingIoProcessor<NioSession>

TODO Add documentation

Version:: $Rev: 671827 $, $Date: 2008-06-26 10:49:48 +0200 (jeu, 26 jun 2008) $
Author:: The Apache MINA Project (dev@mina.apache.org)

Nested Class Summary
`protected static class`	`NioProcessor.IoSessionIterator`

Nested classes/interfaces inherited from class org.apache.mina.core.polling.AbstractPollingIoProcessor
`AbstractPollingIoProcessor.SessionState`

Constructor Summary
`NioProcessor(Executor executor)` Creates a new instance of NioProcessor.

Method Summary
`protected Iterator<NioSession>`	`allSessions()` Get an `Iterator` for the list of `IoSession` polled by this `IoProcessor`
`protected void`	`destroy(NioSession session)` Destroy the underlying client socket handle
`protected void`	`dispose0()` Dispose the resources used by this `IoProcessor` for polling the client connections
`protected void`	`init(NioSession session)` Initialize the polling of a session.
`protected boolean`	`isInterestedInRead(NioSession session)` is this session registered for reading
`protected boolean`	`isInterestedInWrite(NioSession session)` is this session registered for writing
`protected boolean`	`isReadable(NioSession session)` Is the session ready for reading
`protected boolean`	`isSelectorEmpty()` Say if the list of `IoSession` polled by this `IoProcessor` is empty
`protected boolean`	`isWritable(NioSession session)` Is the session ready for writing
`protected int`	`read(NioSession session, IoBuffer buf)` Reads a sequence of bytes from a `IoSession` into the given `IoBuffer`.
`protected boolean`	`select(int timeout)` poll those sessions for the given timeout
`protected Iterator<NioSession>`	`selectedSessions()` Get an `Iterator` for the list of `IoSession` found selected by the last call of {@link AbstractPollingIoProcessor#select(int)
`protected void`	`setInterestedInRead(NioSession session, boolean value)` register a session for reading
`protected void`	`setInterestedInWrite(NioSession session, boolean value)` register a session for writing
`protected AbstractPollingIoProcessor.SessionState`	`state(NioSession session)` Get the sate of a session (preparing, open, closed)
`protected int`	`transferFile(NioSession session, FileRegion region, int length)` Write a part of a file to a `IoSession`, if the underlying API isn't supporting system calls like sendfile(), you can throw a `UnsupportedOperationException` so the file will be send using usual `AbstractPollingIoProcessor.write(AbstractIoSession, IoBuffer, int)` call.
`protected void`	`wakeup()` Interrupt the {@link AbstractPollingIoProcessor#select(int) call.
`protected int`	`write(NioSession session, IoBuffer buf, int length)` Write a sequence of bytes to a `IoSession`, means to be called when a session was found ready for writing.

Methods inherited from class org.apache.mina.core.polling.AbstractPollingIoProcessor
`add, dispose, flush, isDisposed, isDisposing, remove, updateTrafficMask`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

NioProcessor

public NioProcessor(Executor executor)

Creates a new instance of NioProcessor.

Parameters:: executor -

Method Detail