Class AprIoProcessor
- java.lang.Object
-
- org.apache.mina.core.polling.AbstractPollingIoProcessor<AprSession>
-
- org.apache.mina.transport.socket.apr.AprIoProcessor
-
- All Implemented Interfaces:
IoProcessor<AprSession>
public final class AprIoProcessor extends AbstractPollingIoProcessor<AprSession>
The class in charge of processing socket level IO events for theAprSocketConnector
- Author:
- Apache MINA Project
-
-
Field Summary
-
Fields inherited from class org.apache.mina.core.polling.AbstractPollingIoProcessor
wakeupCalled
-
-
Constructor Summary
Constructors Constructor Description AprIoProcessor(Executor executor)
Create a new instance ofAprIoProcessor
with a given Exector for handling I/Os events.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Iterator<AprSession>
allSessions()
protected int
allSessionsCount()
Get the number ofIoSession
polled by thisIoProcessor
protected void
destroy(AprSession session)
Destroy the underlying client socket handleprotected void
doDispose()
Dispose the resources used by thisIoProcessor
for polling the client connections.protected SessionState
getState(AprSession session)
Get the state of a session (One of OPENING, OPEN, CLOSING)protected void
init(AprSession 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(AprSession session)
Tells if this session is registered for readingprotected boolean
isInterestedInWrite(AprSession session)
Tells if this session is registered for writingprotected boolean
isReadable(AprSession session)
Tells if the session ready for readingprotected boolean
isSelectorEmpty()
Say if the list ofIoSession
polled by thisIoProcessor
is emptyprotected boolean
isWritable(AprSession session)
Tells if the session ready for writingprotected int
read(AprSession session, IoBuffer buffer)
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, registring all the sockets on it.protected int
select()
poll those sessions foreverprotected int
select(long timeout)
poll those sessions for the given timeoutprotected Iterator<AprSession>
selectedSessions()
Get anIterator
for the list ofIoSession
found selected by the last call ofAbstractPollingIoProcessor.select(long)
protected void
setInterestedInRead(AprSession session, boolean isInterested)
Set the session to be informed when a read event should be processedprotected void
setInterestedInWrite(AprSession session, boolean isInterested)
Set the session to be informed when a write event should be processedprotected int
transferFile(AprSession session, FileRegion region, int length)
Write a part of a file to aIoSession
, if the underlying API isn't supporting system calls like sendfile(), you can throw aUnsupportedOperationException
so the file will be send using usualAbstractPollingIoProcessor.write(AbstractIoSession, IoBuffer, int)
call.protected void
wakeup()
Interrupt theAbstractPollingIoProcessor.select(long)
call.protected int
write(AprSession session, IoBuffer buf, int length)
Write a sequence of bytes to aIoSession
, 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, updateTrafficControl, updateTrafficMask, write
-
-
-
-
Constructor Detail
-
AprIoProcessor
public AprIoProcessor(Executor executor)
Create a new instance ofAprIoProcessor
with a given Exector for handling I/Os events.- Parameters:
executor
- theExecutor
for handling I/O events
-
-
Method Detail
-
doDispose
protected void doDispose()
Dispose the resources used by thisIoProcessor
for polling the client connections. The implementing class doDispose method will be called.- Specified by:
doDispose
in classAbstractPollingIoProcessor<AprSession>
-
select
protected int select() throws Exception
poll those sessions forever- Specified by:
select
in classAbstractPollingIoProcessor<AprSession>
- Returns:
- The number of session ready for read or for write
- Throws:
Exception
- if some low level IO error occurs
-
select
protected int select(long timeout) throws Exception
poll those sessions for the given timeout- Specified by:
select
in classAbstractPollingIoProcessor<AprSession>
- Parameters:
timeout
- milliseconds before the call timeout if no event appear- Returns:
- The number of session ready for read or for write
- Throws:
Exception
- if some low level IO error occurs
-
isSelectorEmpty
protected boolean isSelectorEmpty()
Say if the list ofIoSession
polled by thisIoProcessor
is empty- Specified by:
isSelectorEmpty
in classAbstractPollingIoProcessor<AprSession>
- Returns:
true
if at least a session is managed by thisIoProcessor
-
wakeup
protected void wakeup()
Interrupt theAbstractPollingIoProcessor.select(long)
call.- Specified by:
wakeup
in classAbstractPollingIoProcessor<AprSession>
-
allSessions
protected Iterator<AprSession> allSessions()
- Specified by:
allSessions
in classAbstractPollingIoProcessor<AprSession>
- Returns:
Iterator
ofIoSession
-
allSessionsCount
protected int allSessionsCount()
Get the number ofIoSession
polled by thisIoProcessor
- Specified by:
allSessionsCount
in classAbstractPollingIoProcessor<AprSession>
- Returns:
- the number of sessions attached to this
IoProcessor
-
selectedSessions
protected Iterator<AprSession> selectedSessions()
Get anIterator
for the list ofIoSession
found selected by the last call ofAbstractPollingIoProcessor.select(long)
- Specified by:
selectedSessions
in classAbstractPollingIoProcessor<AprSession>
- Returns:
Iterator
ofIoSession
read for I/Os operation
-
init
protected void init(AprSession session) throws Exception
Description copied from class:AbstractPollingIoProcessor
Initialize the polling of a session. Add it to the polling process.- Specified by:
init
in classAbstractPollingIoProcessor<AprSession>
- Parameters:
session
- theIoSession
to add to the polling- Throws:
Exception
- any exception thrown by the underlying system calls
-
destroy
protected void destroy(AprSession session) throws Exception
Destroy the underlying client socket handle- Specified by:
destroy
in classAbstractPollingIoProcessor<AprSession>
- Parameters:
session
- theIoSession
- Throws:
Exception
- any exception thrown by the underlying system calls
-
getState
protected SessionState getState(AprSession session)
Get the state of a session (One of OPENING, OPEN, CLOSING)- Specified by:
getState
in classAbstractPollingIoProcessor<AprSession>
- Parameters:
session
- theIoSession
to inspect- Returns:
- the state of the session
-
isReadable
protected boolean isReadable(AprSession session)
Tells if the session ready for reading- Specified by:
isReadable
in classAbstractPollingIoProcessor<AprSession>
- Parameters:
session
- the queried session- Returns:
true
is ready,false
if not ready
-
isWritable
protected boolean isWritable(AprSession session)
Tells if the session ready for writing- Specified by:
isWritable
in classAbstractPollingIoProcessor<AprSession>
- Parameters:
session
- the queried session- Returns:
true
is ready,false
if not ready
-
isInterestedInRead
protected boolean isInterestedInRead(AprSession session)
Tells if this session is registered for reading- Specified by:
isInterestedInRead
in classAbstractPollingIoProcessor<AprSession>
- Parameters:
session
- the queried session- Returns:
true
is registered for reading
-
isInterestedInWrite
protected boolean isInterestedInWrite(AprSession session)
Tells if this session is registered for writing- Specified by:
isInterestedInWrite
in classAbstractPollingIoProcessor<AprSession>
- Parameters:
session
- the queried session- Returns:
true
is registered for writing
-
setInterestedInRead
protected void setInterestedInRead(AprSession session, boolean isInterested) throws Exception
Set the session to be informed when a read event should be processed- Specified by:
setInterestedInRead
in classAbstractPollingIoProcessor<AprSession>
- Parameters:
session
- the session for which we want to be interested in read eventsisInterested
-true
for registering,false
for removing- Throws:
Exception
- If there was a problem while registering the session
-
setInterestedInWrite
protected void setInterestedInWrite(AprSession session, boolean isInterested) throws Exception
Set the session to be informed when a write event should be processed- Specified by:
setInterestedInWrite
in classAbstractPollingIoProcessor<AprSession>
- Parameters:
session
- the session for which we want to be interested in write eventsisInterested
-true
for registering,false
for removing- Throws:
Exception
- If there was a problem while registering the session
-
read
protected int read(AprSession session, IoBuffer buffer) throws Exception
Reads a sequence of bytes from aIoSession
into the givenIoBuffer
. Is called when the session was found ready for reading.- Specified by:
read
in classAbstractPollingIoProcessor<AprSession>
- Parameters:
session
- the session to readbuffer
- the buffer to fill- Returns:
- the number of bytes read
- Throws:
Exception
- any exception thrown by the underlying system calls
-
write
protected int write(AprSession session, IoBuffer buf, int length) throws IOException
Write a sequence of bytes to aIoSession
, means to be called when a session was found ready for writing.- Specified by:
write
in classAbstractPollingIoProcessor<AprSession>
- Parameters:
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- Returns:
- the number of byte written
- Throws:
IOException
- any exception thrown by the underlying system calls
-
transferFile
protected int transferFile(AprSession session, FileRegion region, int length) throws Exception
Write a part of a file to aIoSession
, if the underlying API isn't supporting system calls like sendfile(), you can throw aUnsupportedOperationException
so the file will be send using usualAbstractPollingIoProcessor.write(AbstractIoSession, IoBuffer, int)
call.- Specified by:
transferFile
in classAbstractPollingIoProcessor<AprSession>
- Parameters:
session
- the session to writeregion
- the file region to writelength
- the length of the portion to send- Returns:
- the number of written bytes
- Throws:
Exception
- any exception thrown by the underlying system calls
-
registerNewSelector
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, registring all the sockets on it.- Specified by:
registerNewSelector
in classAbstractPollingIoProcessor<AprSession>
-
isBrokenConnection
protected boolean isBrokenConnection() throws 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.- Specified by:
isBrokenConnection
in classAbstractPollingIoProcessor<AprSession>
- Returns:
true
if a connection has been brutally closed.- Throws:
IOException
- If we got an exception
-
-