org.apache.mina.transport.socket.nio

类 NioProcessor

java.lang.Object

org.apache.mina.core.polling.AbstractPollingIoProcessor<NioSession>

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

所有已实现的接口:

IoProcessor<NioSession>

public final class NioProcessor
extends AbstractPollingIoProcessor<NioSession>

TODO Add documentation

作者:

Apache MINA Project

嵌套类概要

嵌套类

限定符和类型	类和说明
protected static class	NioProcessor.IoSessionIterator<NioSession> An encapsulating iterator around the Selector.selectedKeys() or the Selector.keys() iterator;

字段概要

从类继承的字段 org.apache.mina.core.polling.AbstractPollingIoProcessor

wakeupCalled

构造器概要

构造器

构造器和说明
NioProcessor(java.util.concurrent.Executor executor) Creates a new instance of NioProcessor.
NioProcessor(java.util.concurrent.Executor executor, java.nio.channels.spi.SelectorProvider selectorProvider) Creates a new instance of NioProcessor.

方法概要

方法

限定符和类型	方法和说明
protected java.util.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	doDispose() Dispose the resources used by this IoProcessor for polling the client connections.
protected SessionState	getState(NioSession session) Get the state of a session (One of OPENING, OPEN, CLOSING)
protected void	init(NioSession session) Initialize the polling of a session.
protected boolean	isBrokenConnection() Check that the select() has not exited immediately just because of a broken connection.
protected boolean	isInterestedInRead(NioSession session) Tells if this session is registered for reading
protected boolean	isInterestedInWrite(NioSession session) Tells if this session is registered for writing
protected boolean	isReadable(NioSession session) Tells if 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) Tells if 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 void	registerNewSelector() In the case we are using the java select() method, this method is used to trash the buggy selector and create a new one, registering all the sockets on it.
protected int	select() poll those sessions forever
protected int	select(long timeout) poll those sessions for the given timeout
protected java.util.Iterator<NioSession>	selectedSessions() Get an Iterator for the list of IoSession found selected by the last call of AbstractPollingIoProcessor.select(long)
protected void	setInterestedInRead(NioSession session, boolean isInterested) Set the session to be informed when a read event should be processed
protected void	setInterestedInWrite(NioSession session, boolean isInterested) Set the session to be informed when a write event should be processed
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 AbstractPollingIoProcessor.select(long) 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.

从类继承的方法 org.apache.mina.core.polling.AbstractPollingIoProcessor

add, dispose, flush, isDisposed, isDisposing, remove, updateTrafficControl, updateTrafficMask, write

从类继承的方法 java.lang.Object

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

构造器详细资料

NioProcessor

public NioProcessor(java.util.concurrent.Executor executor)

Creates a new instance of NioProcessor.

参数:

executor - The executor to use

NioProcessor

public NioProcessor(java.util.concurrent.Executor executor,
            java.nio.channels.spi.SelectorProvider selectorProvider)

Creates a new instance of NioProcessor.

参数:

executor - The executor to use

selectorProvider - The Selector provider to use

方法详细资料

doDispose

protected void doDispose()
                  throws java.lang.Exception

从类复制的说明: AbstractPollingIoProcessor

Dispose the resources used by this IoProcessor for polling the client connections. The implementing class doDispose method will be called.

指定者:

doDispose 在类中 AbstractPollingIoProcessor<NioSession>

抛出:

java.lang.Exception - if some low level IO error occurs

select

protected int select(long timeout)
              throws java.lang.Exception

从类复制的说明: AbstractPollingIoProcessor

poll those sessions for the given timeout

指定者:

select 在类中 AbstractPollingIoProcessor<NioSession>

参数:

timeout - milliseconds before the call timeout if no event appear

返回:

The number of session ready for read or for write

抛出:

java.lang.Exception - if some low level IO error occurs

select

protected int select()
              throws java.lang.Exception

从类复制的说明: AbstractPollingIoProcessor

poll those sessions forever

指定者:

select 在类中 AbstractPollingIoProcessor<NioSession>

返回:

The number of session ready for read or for write

抛出:

java.lang.Exception - if some low level IO error occurs

isSelectorEmpty

protected boolean isSelectorEmpty()

从类复制的说明: AbstractPollingIoProcessor

Say if the list of IoSession polled by this IoProcessor is empty

指定者:

isSelectorEmpty 在类中 AbstractPollingIoProcessor<NioSession>

返回:

true if at least a session is managed by this IoProcessor

wakeup

protected void wakeup()

从类复制的说明: AbstractPollingIoProcessor

Interrupt the AbstractPollingIoProcessor.select(long) call.

指定者:

wakeup 在类中 AbstractPollingIoProcessor<NioSession>

allSessions

protected java.util.Iterator<NioSession> allSessions()

从类复制的说明: AbstractPollingIoProcessor

Get an Iterator for the list of IoSession polled by this IoProcessor

指定者:

allSessions 在类中 AbstractPollingIoProcessor<NioSession>

返回:

Iterator of IoSession

selectedSessions

protected java.util.Iterator<NioSession> selectedSessions()

从类复制的说明: AbstractPollingIoProcessor

Get an Iterator for the list of IoSession found selected by the last call of AbstractPollingIoProcessor.select(long)

指定者:

selectedSessions 在类中 AbstractPollingIoProcessor<NioSession>

返回:

Iterator of IoSession read for I/Os operation

init

protected void init(NioSession session)
             throws java.lang.Exception

从类复制的说明: AbstractPollingIoProcessor

Initialize the polling of a session. Add it to the polling process.

指定者:

init 在类中 AbstractPollingIoProcessor<NioSession>

参数:

session - the IoSession to add to the polling

抛出:

java.lang.Exception - any exception thrown by the underlying system calls

destroy

protected void destroy(NioSession session)
                throws java.lang.Exception

从类复制的说明: AbstractPollingIoProcessor

Destroy the underlying client socket handle

指定者:

destroy 在类中 AbstractPollingIoProcessor<NioSession>

参数:

session - the IoSession

抛出:

java.lang.Exception - any exception thrown by the underlying system calls

registerNewSelector

protected void registerNewSelector()
                            throws java.io.IOException

In the case we are using the java select() method, this method is used to trash the buggy selector and create a new one, registering all the sockets on it.

指定者:

registerNewSelector 在类中 AbstractPollingIoProcessor<NioSession>

抛出:

java.io.IOException - If we got an exception

isBrokenConnection

protected boolean isBrokenConnection()
                              throws java.io.IOException

Check that the select() has not exited immediately just because of a broken connection. In this case, this is a standard case, and we just have to loop.

指定者:

isBrokenConnection 在类中 AbstractPollingIoProcessor<NioSession>

返回:

true if a connection has been brutally closed.

抛出:

java.io.IOException - If we got an exception

getState

protected SessionState getState(NioSession session)

Get the state of a session (One of OPENING, OPEN, CLOSING)

指定者:

getState 在类中 AbstractPollingIoProcessor<NioSession>

参数:

session - the IoSession to inspect

返回:

the state of the session

isReadable

protected boolean isReadable(NioSession session)

从类复制的说明: AbstractPollingIoProcessor

Tells if the session ready for reading

指定者:

isReadable 在类中 AbstractPollingIoProcessor<NioSession>

参数:

session - the queried session

返回:

true is ready, false if not ready

isWritable

protected boolean isWritable(NioSession session)

从类复制的说明: AbstractPollingIoProcessor

Tells if the session ready for writing

指定者:

isWritable 在类中 AbstractPollingIoProcessor<NioSession>

参数:

session - the queried session

返回:

true is ready, false if not ready

isInterestedInRead

protected boolean isInterestedInRead(NioSession session)

从类复制的说明: AbstractPollingIoProcessor

Tells if this session is registered for reading

指定者:

isInterestedInRead 在类中 AbstractPollingIoProcessor<NioSession>

参数:

session - the queried session

返回:

true is registered for reading

isInterestedInWrite

protected boolean isInterestedInWrite(NioSession session)

从类复制的说明: AbstractPollingIoProcessor

Tells if this session is registered for writing

指定者:

isInterestedInWrite 在类中 AbstractPollingIoProcessor<NioSession>

参数:

session - the queried session

返回:

true is registered for writing

setInterestedInRead

protected void setInterestedInRead(NioSession session,
                       boolean isInterested)
                            throws java.lang.Exception

Set the session to be informed when a read event should be processed

指定者:

setInterestedInRead 在类中 AbstractPollingIoProcessor<NioSession>

参数:

session - the session for which we want to be interested in read events

isInterested - true for registering, false for removing

抛出:

java.lang.Exception - If there was a problem while registering the session

setInterestedInWrite

protected void setInterestedInWrite(NioSession session,
                        boolean isInterested)
                             throws java.lang.Exception

Set the session to be informed when a write event should be processed

指定者:

setInterestedInWrite 在类中 AbstractPollingIoProcessor<NioSession>

参数:

session - the session for which we want to be interested in write events

isInterested - true for registering, false for removing

抛出:

java.lang.Exception - If there was a problem while registering the session

read

protected int read(NioSession session,
       IoBuffer buf)
            throws java.lang.Exception

从类复制的说明: AbstractPollingIoProcessor

Reads a sequence of bytes from a IoSession into the given IoBuffer. Is called when the session was found ready for reading.

指定者:

read 在类中 AbstractPollingIoProcessor<NioSession>

参数:

session - the session to read

buf - the buffer to fill

返回:

the number of bytes read

抛出:

java.lang.Exception - any exception thrown by the underlying system calls

write

protected int write(NioSession session,
        IoBuffer buf,
        int length)
             throws java.lang.Exception

从类复制的说明: AbstractPollingIoProcessor

Write a sequence of bytes to a IoSession, means to be called when a session was found ready for writing.

指定者:

write 在类中 AbstractPollingIoProcessor<NioSession>

参数:

session - the session to write

buf - the buffer to write

length - the number of bytes to write can be superior to the number of bytes remaining in the buffer

返回:

the number of byte written

抛出:

java.lang.Exception - any exception thrown by the underlying system calls

transferFile

protected int transferFile(NioSession session,
               FileRegion region,
               int length)
                    throws java.lang.Exception

从类复制的说明: AbstractPollingIoProcessor

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.

指定者:

transferFile 在类中 AbstractPollingIoProcessor<NioSession>

参数:

session - the session to write

region - the file region to write

length - the length of the portion to send

返回:

the number of written bytes

抛出:

java.lang.Exception - any exception thrown by the underlying system calls