|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.mina.core.polling.AbstractPollingIoProcessor<AprSession>
org.apache.mina.transport.socket.apr.AprIoProcessor
public final class AprIoProcessor
The class in charge of processing socket level IO events for the AprSocketConnector
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.apache.mina.core.polling.AbstractPollingIoProcessor |
|---|
AbstractPollingIoProcessor.SessionState |
| Constructor Summary | |
|---|---|
AprIoProcessor(Executor executor)
|
|
| Method Summary | |
|---|---|
protected Iterator<AprSession> |
allSessions()
Get an Iterator for the list of IoSession polled by this
IoProcessor |
protected void |
destroy(AprSession 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(AprSession session)
Initialize the polling of a session. |
protected boolean |
isInterestedInRead(AprSession session)
is this session registered for reading |
protected boolean |
isInterestedInWrite(AprSession session)
is this session registered for writing |
protected boolean |
isReadable(AprSession 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(AprSession session)
Is the session ready for writing |
protected int |
read(AprSession session,
IoBuffer buffer)
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<AprSession> |
selectedSessions()
Get an Iterator for the list of IoSession found selected
by the last call of {@link AbstractPollingIoProcessor#select(int) |
protected void |
setInterestedInRead(AprSession session,
boolean value)
register a session for reading |
protected void |
setInterestedInWrite(AprSession session,
boolean value)
register a session for writing |
protected AbstractPollingIoProcessor.SessionState |
state(AprSession session)
Get the sate of a session (preparing, open, closed) |
protected int |
transferFile(AprSession 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(AprSession 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 |
|---|
public AprIoProcessor(Executor executor)
| Method Detail |
|---|
protected void dispose0()
AbstractPollingIoProcessorIoProcessor for polling
the client connections
dispose0 in class AbstractPollingIoProcessor<AprSession>
protected boolean select(int timeout)
throws Exception
AbstractPollingIoProcessor
select in class AbstractPollingIoProcessor<AprSession>timeout - milliseconds before the call timeout if no event appear
Exception - if some low level IO error occursprotected boolean isSelectorEmpty()
AbstractPollingIoProcessorIoSession polled by this IoProcessor
is empty
isSelectorEmpty in class AbstractPollingIoProcessor<AprSession>IoProcessorprotected void wakeup()
AbstractPollingIoProcessor
wakeup in class AbstractPollingIoProcessor<AprSession>protected Iterator<AprSession> allSessions()
AbstractPollingIoProcessorIterator for the list of IoSession polled by this
IoProcessor
allSessions in class AbstractPollingIoProcessor<AprSession>Iterator of IoSessionprotected Iterator<AprSession> selectedSessions()
AbstractPollingIoProcessorIterator for the list of IoSession found selected
by the last call of {@link AbstractPollingIoProcessor#select(int)
selectedSessions in class AbstractPollingIoProcessor<AprSession>Iterator of IoSession read for I/Os operation
protected void init(AprSession session)
throws Exception
AbstractPollingIoProcessor
init in class AbstractPollingIoProcessor<AprSession>session - the IoSession to add to the polling
Exception - any exception thrown by the underlying system calls
protected void destroy(AprSession session)
throws Exception
AbstractPollingIoProcessor
destroy in class AbstractPollingIoProcessor<AprSession>session - the IoSession
Exception - any exception thrown by the underlying system callsprotected AbstractPollingIoProcessor.SessionState state(AprSession session)
AbstractPollingIoProcessor
state in class AbstractPollingIoProcessor<AprSession>session - the IoSession to inspect
protected boolean isReadable(AprSession session)
AbstractPollingIoProcessor
isReadable in class AbstractPollingIoProcessor<AprSession>session - the session queried
protected boolean isWritable(AprSession session)
AbstractPollingIoProcessor
isWritable in class AbstractPollingIoProcessor<AprSession>session - the session queried
protected boolean isInterestedInRead(AprSession session)
AbstractPollingIoProcessor
isInterestedInRead in class AbstractPollingIoProcessor<AprSession>session - the session queried
protected boolean isInterestedInWrite(AprSession session)
AbstractPollingIoProcessor
isInterestedInWrite in class AbstractPollingIoProcessor<AprSession>session - the session queried
protected void setInterestedInRead(AprSession session,
boolean value)
throws Exception
AbstractPollingIoProcessor
setInterestedInRead in class AbstractPollingIoProcessor<AprSession>session - the session registeredvalue - true for registering, false for removing
Exception
protected void setInterestedInWrite(AprSession session,
boolean value)
throws Exception
AbstractPollingIoProcessor
setInterestedInWrite in class AbstractPollingIoProcessor<AprSession>session - the session registeredvalue - true for registering, false for removing
Exception
protected int read(AprSession session,
IoBuffer buffer)
throws Exception
AbstractPollingIoProcessorIoSession into the given IoBuffer.
Is called when the session was found ready for reading.
read in class AbstractPollingIoProcessor<AprSession>session - the session to readbuffer - the buffer to fill
Exception - any exception thrown by the underlying system calls
protected int write(AprSession session,
IoBuffer buf,
int length)
throws Exception
AbstractPollingIoProcessorIoSession, means to be called when a session
was found ready for writing.
write in class AbstractPollingIoProcessor<AprSession>session - the session to writebuf - the buffer to writelength - the number of bytes to write can be superior to the number of bytes remaining
in the buffer
Exception - any exception thrown by the underlying system calls
protected int transferFile(AprSession session,
FileRegion region,
int length)
throws Exception
AbstractPollingIoProcessorIoSession, 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 in class AbstractPollingIoProcessor<AprSession>session - the session to writeregion - the file region to writelength - the length of the portion to send
Exception - any exception thrown by the underlying system calls
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||