|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.mina.common.IoFilterAdapter
org.apache.mina.filter.executor.ExecutorFilter
public class ExecutorFilter
A filter that forwards I/O events to Executor
to enforce a certain
thread model while allowing the events per session to be processed
simultaneously. You can apply various thread model by inserting this filter
to a IoFilterChain
.
Executor
.
If you created this filter using ExecutorFilter(Executor)
or similar
constructor that accepts an Executor
that you've instantiated, you have
full control and responsibility of managing its life cycle (e.g. calling
ExecutorService.shutdown()
.
If you created this filter using convenience constructors like
ExecutorFilter(int)
, then you can shut down the executor by calling
destroy()
explicitly.
OrderedThreadPoolExecutor
instance. Therefore, the order of event is
maintained like the following:
Executor
instance in the constructor,
the order of events are not maintained at all. This means more than one event
handler methods can be invoked at the same time with mixed order. For example,
let's assume that messageReceived, messageSent, and sessionClosed events are
fired.
OrderedThreadPoolExecutor
instance or use the convenience constructors.
If you want to submit only a certain set of event types, you can specify them in the constructor. For example, you could configure a thread pool for write operation for the maximum performance:
IoService service = ...;
DefaultIoFilterChainBuilder chain = service.getFilterChain();
chain.addLast("codec", new ProtocolCodecFilter(...));
// Use one thread pool for most events.
chain.addLast("executor1", new ExecutorFilter());
// and another dedicated thread pool for 'filterWrite' events.
chain.addLast("executor2", new ExecutorFilter(IoEventType.WRITE));
OutOfMemoryError
IoEventQueueThrottle
, which is specified as
a parameter of the convenience constructors.
OrderedThreadPoolExecutor
,
UnorderedThreadPoolExecutor
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.apache.mina.common.IoFilter |
---|
IoFilter.NextFilter |
Constructor Summary | |
---|---|
ExecutorFilter()
(Convenience constructor) Creates a new instance with a new OrderedThreadPoolExecutor . |
|
ExecutorFilter(Executor executor)
Creates a new instance with the specified Executor . |
|
ExecutorFilter(Executor executor,
IoEventType... eventTypes)
Creates a new instance with the specified Executor . |
|
ExecutorFilter(int maximumPoolSize)
(Convenience constructor) Creates a new instance with a new OrderedThreadPoolExecutor . |
|
ExecutorFilter(int corePoolSize,
int maximumPoolSize)
(Convenience constructor) Creates a new instance with a new OrderedThreadPoolExecutor . |
|
ExecutorFilter(int corePoolSize,
int maximumPoolSize,
IoEventType... eventTypes)
(Convenience constructor) Creates a new instance with a new OrderedThreadPoolExecutor . |
|
ExecutorFilter(int corePoolSize,
int maximumPoolSize,
long keepAliveTime,
TimeUnit unit)
(Convenience constructor) Creates a new instance with a new OrderedThreadPoolExecutor . |
|
ExecutorFilter(int corePoolSize,
int maximumPoolSize,
long keepAliveTime,
TimeUnit unit,
IoEventQueueHandler queueHandler)
(Convenience constructor) Creates a new instance with a new OrderedThreadPoolExecutor . |
|
ExecutorFilter(int corePoolSize,
int maximumPoolSize,
long keepAliveTime,
TimeUnit unit,
IoEventQueueHandler queueHandler,
IoEventType... eventTypes)
(Convenience constructor) Creates a new instance with a new OrderedThreadPoolExecutor . |
|
ExecutorFilter(int corePoolSize,
int maximumPoolSize,
long keepAliveTime,
TimeUnit unit,
IoEventType... eventTypes)
(Convenience constructor) Creates a new instance with a new OrderedThreadPoolExecutor . |
|
ExecutorFilter(int corePoolSize,
int maximumPoolSize,
long keepAliveTime,
TimeUnit unit,
ThreadFactory threadFactory)
(Convenience constructor) Creates a new instance with a new OrderedThreadPoolExecutor . |
|
ExecutorFilter(int corePoolSize,
int maximumPoolSize,
long keepAliveTime,
TimeUnit unit,
ThreadFactory threadFactory,
IoEventQueueHandler queueHandler)
(Convenience constructor) Creates a new instance with a new OrderedThreadPoolExecutor . |
|
ExecutorFilter(int corePoolSize,
int maximumPoolSize,
long keepAliveTime,
TimeUnit unit,
ThreadFactory threadFactory,
IoEventQueueHandler queueHandler,
IoEventType... eventTypes)
(Convenience constructor) Creates a new instance with a new OrderedThreadPoolExecutor . |
|
ExecutorFilter(int corePoolSize,
int maximumPoolSize,
long keepAliveTime,
TimeUnit unit,
ThreadFactory threadFactory,
IoEventType... eventTypes)
(Convenience constructor) Creates a new instance with a new OrderedThreadPoolExecutor . |
|
ExecutorFilter(int maximumPoolSize,
IoEventType... eventTypes)
(Convenience constructor) Creates a new instance with a new OrderedThreadPoolExecutor . |
|
ExecutorFilter(IoEventType... eventTypes)
(Convenience constructor) Creates a new instance with a new OrderedThreadPoolExecutor . |
Method Summary | |
---|---|
void |
destroy()
Shuts down the underlying executor if this filter is creates via a convenience constructor. |
void |
exceptionCaught(IoFilter.NextFilter nextFilter,
IoSession session,
Throwable cause)
Filters IoHandler.exceptionCaught(IoSession,Throwable)
event. |
void |
filterClose(IoFilter.NextFilter nextFilter,
IoSession session)
Filters IoSession.close() method invocation. |
void |
filterWrite(IoFilter.NextFilter nextFilter,
IoSession session,
WriteRequest writeRequest)
Filters IoSession.write(Object) method invocation. |
protected void |
fireEvent(IoFilterEvent event)
Fires the specified event through the underlying executor. |
Executor |
getExecutor()
Returns the underlying Executor instance this filter uses. |
void |
messageReceived(IoFilter.NextFilter nextFilter,
IoSession session,
Object message)
Filters IoHandler.messageReceived(IoSession,Object)
event. |
void |
messageSent(IoFilter.NextFilter nextFilter,
IoSession session,
WriteRequest writeRequest)
Filters IoHandler.messageSent(IoSession,Object)
event. |
void |
onPreAdd(IoFilterChain parent,
String name,
IoFilter.NextFilter nextFilter)
Invoked before this filter is added to the specified parent. |
void |
sessionClosed(IoFilter.NextFilter nextFilter,
IoSession session)
Filters IoHandler.sessionClosed(IoSession) event. |
void |
sessionCreated(IoFilter.NextFilter nextFilter,
IoSession session)
Filters IoHandler.sessionCreated(IoSession) event. |
void |
sessionIdle(IoFilter.NextFilter nextFilter,
IoSession session,
IdleStatus status)
Filters IoHandler.sessionIdle(IoSession,IdleStatus)
event. |
void |
sessionOpened(IoFilter.NextFilter nextFilter,
IoSession session)
Filters IoHandler.sessionOpened(IoSession) event. |
Methods inherited from class org.apache.mina.common.IoFilterAdapter |
---|
filterSetTrafficMask, init, onPostAdd, onPostRemove, onPreRemove |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ExecutorFilter()
OrderedThreadPoolExecutor
.
public ExecutorFilter(int maximumPoolSize)
OrderedThreadPoolExecutor
.
public ExecutorFilter(int corePoolSize, int maximumPoolSize)
OrderedThreadPoolExecutor
.
public ExecutorFilter(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit)
OrderedThreadPoolExecutor
.
public ExecutorFilter(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit, IoEventQueueHandler queueHandler)
OrderedThreadPoolExecutor
.
public ExecutorFilter(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit, ThreadFactory threadFactory)
OrderedThreadPoolExecutor
.
public ExecutorFilter(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit, ThreadFactory threadFactory, IoEventQueueHandler queueHandler)
OrderedThreadPoolExecutor
.
public ExecutorFilter(IoEventType... eventTypes)
OrderedThreadPoolExecutor
.
public ExecutorFilter(int maximumPoolSize, IoEventType... eventTypes)
OrderedThreadPoolExecutor
.
public ExecutorFilter(int corePoolSize, int maximumPoolSize, IoEventType... eventTypes)
OrderedThreadPoolExecutor
.
public ExecutorFilter(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit, IoEventType... eventTypes)
OrderedThreadPoolExecutor
.
public ExecutorFilter(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit, IoEventQueueHandler queueHandler, IoEventType... eventTypes)
OrderedThreadPoolExecutor
.
public ExecutorFilter(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit, ThreadFactory threadFactory, IoEventType... eventTypes)
OrderedThreadPoolExecutor
.
public ExecutorFilter(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit, ThreadFactory threadFactory, IoEventQueueHandler queueHandler, IoEventType... eventTypes)
OrderedThreadPoolExecutor
.
public ExecutorFilter(Executor executor)
Executor
.
public ExecutorFilter(Executor executor, IoEventType... eventTypes)
Executor
.
Method Detail |
---|
public void destroy()
destroy
in interface IoFilter
destroy
in class IoFilterAdapter
public final Executor getExecutor()
Executor
instance this filter uses.
protected void fireEvent(IoFilterEvent event)
public void onPreAdd(IoFilterChain parent, String name, IoFilter.NextFilter nextFilter) throws Exception
IoFilter
IoFilter.init()
is invoked.
onPreAdd
in interface IoFilter
onPreAdd
in class IoFilterAdapter
parent
- the parent who called this methodname
- the name assigned to this filternextFilter
- the IoFilter.NextFilter
for this filter. You can reuse
this object until this filter is removed from the chain.
Exception
public final void sessionCreated(IoFilter.NextFilter nextFilter, IoSession session)
IoFilter
IoHandler.sessionCreated(IoSession)
event.
sessionCreated
in interface IoFilter
sessionCreated
in class IoFilterAdapter
public final void sessionOpened(IoFilter.NextFilter nextFilter, IoSession session)
IoFilter
IoHandler.sessionOpened(IoSession)
event.
sessionOpened
in interface IoFilter
sessionOpened
in class IoFilterAdapter
public final void sessionClosed(IoFilter.NextFilter nextFilter, IoSession session)
IoFilter
IoHandler.sessionClosed(IoSession)
event.
sessionClosed
in interface IoFilter
sessionClosed
in class IoFilterAdapter
public final void sessionIdle(IoFilter.NextFilter nextFilter, IoSession session, IdleStatus status)
IoFilter
IoHandler.sessionIdle(IoSession,IdleStatus)
event.
sessionIdle
in interface IoFilter
sessionIdle
in class IoFilterAdapter
public final void exceptionCaught(IoFilter.NextFilter nextFilter, IoSession session, Throwable cause)
IoFilter
IoHandler.exceptionCaught(IoSession,Throwable)
event.
exceptionCaught
in interface IoFilter
exceptionCaught
in class IoFilterAdapter
public final void messageReceived(IoFilter.NextFilter nextFilter, IoSession session, Object message)
IoFilter
IoHandler.messageReceived(IoSession,Object)
event.
messageReceived
in interface IoFilter
messageReceived
in class IoFilterAdapter
public final void messageSent(IoFilter.NextFilter nextFilter, IoSession session, WriteRequest writeRequest)
IoFilter
IoHandler.messageSent(IoSession,Object)
event.
messageSent
in interface IoFilter
messageSent
in class IoFilterAdapter
public final void filterWrite(IoFilter.NextFilter nextFilter, IoSession session, WriteRequest writeRequest)
IoFilter
IoSession.write(Object)
method invocation.
filterWrite
in interface IoFilter
filterWrite
in class IoFilterAdapter
public final void filterClose(IoFilter.NextFilter nextFilter, IoSession session) throws Exception
IoFilter
IoSession.close()
method invocation.
filterClose
in interface IoFilter
filterClose
in class IoFilterAdapter
Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |