AbstractIoService (MINA 2.0.13 API文档 - 即时通讯网(52im.net))

java.lang.Object
- org.apache.mina.core.service.AbstractIoService

所有已实现的接口:

IoService

直接已知子类:

AbstractIoAcceptor, AbstractIoConnector
```
public abstract class AbstractIoService
extends java.lang.Object
implements IoService
```
Base implementation of IoServices. An instance of IoService contains an Executor which will handle the incoming events.

作者:

Apache MINA Project

嵌套类概要

嵌套类
限定符和类型类和说明

protected static class AbstractIoService.ServiceOperationFuture
A specific class used to

嵌套类
限定符和类型	类和说明
`protected static class`	`AbstractIoService.ServiceOperationFuture` A specific class used to

字段概要

字段
限定符和类型	字段和说明
`protected java.lang.Object`	`disposalLock` A lock object which must be acquired when related resources are destroyed.
`protected IoSessionConfig`	`sessionConfig` The default `IoSessionConfig` which will be used to configure new sessions.

构造器概要

构造器
限定符	构造器和说明
`protected`	`AbstractIoService(IoSessionConfig sessionConfig, java.util.concurrent.Executor executor)` Constructor for `AbstractIoService`.

方法概要

方法
限定符和类型	方法和说明
`void`	`addListener(IoServiceListener listener)` Adds an `IoServiceListener` that listens any events related with this service.
`java.util.Set<WriteFuture>`	`broadcast(java.lang.Object message)` Writes the specified `message` to all the `IoSession`s managed by this service.
`void`	`dispose()` Releases any resources allocated by this service.
`void`	`dispose(boolean awaitTermination)` Releases any resources allocated by this service.
`protected abstract void`	`dispose0()` Implement this method to release any acquired resources.
`protected void`	`executeWorker(java.lang.Runnable worker)`
`protected void`	`executeWorker(java.lang.Runnable worker, java.lang.String suffix)`
`protected void`	`finishSessionInitialization0(IoSession session, IoFuture future)` Implement this method to perform additional tasks required for session initialization.
`long`	`getActivationTime()`
`DefaultIoFilterChainBuilder`	`getFilterChain()` A shortcut for `( ( DefaultIoFilterChainBuilder )` `IoService.getFilterChainBuilder()` `)`.
`IoFilterChainBuilder`	`getFilterChainBuilder()`
`IoHandler`	`getHandler()`
`IoServiceListenerSupport`	`getListeners()`
`int`	`getManagedSessionCount()`
`java.util.Map<java.lang.Long,IoSession>`	`getManagedSessions()`
`int`	`getScheduledWriteBytes()`
`int`	`getScheduledWriteMessages()`
`IoSessionDataStructureFactory`	`getSessionDataStructureFactory()`
`IoServiceStatistics`	`getStatistics()`
`protected void`	`initSession(IoSession session, IoFuture future, IoSessionInitializer sessionInitializer)`
`boolean`	`isActive()`
`boolean`	`isDisposed()`
`boolean`	`isDisposing()`
`void`	`removeListener(IoServiceListener listener)` Removed an existing `IoServiceListener` that listens any events related with this service.
`void`	`setFilterChainBuilder(IoFilterChainBuilder builder)` Sets the `IoFilterChainBuilder` which will build the `IoFilterChain` of all `IoSession`s which is created by this service.
`void`	`setHandler(IoHandler handler)` Sets the handler which will handle all connections managed by this service.
`void`	`setSessionDataStructureFactory(IoSessionDataStructureFactory sessionDataStructureFactory)` Sets the `IoSessionDataStructureFactory` that provides related data structures for a new session created by this service.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.apache.mina.core.service.IoService
getSessionConfig, getTransportMetadata

- 字段详细资料
  - sessionConfig
```
protected final IoSessionConfig sessionConfig
```
    The default IoSessionConfig which will be used to configure new sessions.
  - disposalLock
```
protected final java.lang.Object disposalLock
```
    A lock object which must be acquired when related resources are destroyed.
- 构造器详细资料
  - AbstractIoService
```
protected AbstractIoService(IoSessionConfig sessionConfig,
                 java.util.concurrent.Executor executor)
```
    Constructor for AbstractIoService. You need to provide a default session configuration and an Executor for handling I/O events. If a null Executor is provided, a default one will be created using Executors.newCachedThreadPool().
    
    参数:
    sessionConfig - the default configuration for the managed IoSession
    executor - the Executor used for handling execution of I/O events. Can be null.
- 方法详细资料
  - getFilterChainBuilder
```
public final IoFilterChainBuilder getFilterChainBuilder()
```
    指定者:
    
    getFilterChainBuilder 在接口中 IoService
    
    返回:
    the IoFilterChainBuilder which will build the IoFilterChain of all IoSessions which is created by this service. The default value is an empty DefaultIoFilterChainBuilder.
  - setFilterChainBuilder
```
public final void setFilterChainBuilder(IoFilterChainBuilder builder)
```
    Sets the IoFilterChainBuilder which will build the IoFilterChain of all IoSessions which is created by this service. If you specify null this property will be set to an empty DefaultIoFilterChainBuilder.
    
    指定者:
    
    setFilterChainBuilder 在接口中 IoService
    
    参数:
    builder - The filter chain builder to use
  - getFilterChain
```
public final DefaultIoFilterChainBuilder getFilterChain()
```
    A shortcut for ( ( DefaultIoFilterChainBuilder ) IoService.getFilterChainBuilder() ). Please note that the returned object is not a real IoFilterChain but a DefaultIoFilterChainBuilder. Modifying the returned builder won't affect the existing IoSessions at all, because IoFilterChainBuilders affect only newly created IoSessions.
    
    指定者:
    
    getFilterChain 在接口中 IoService
    
    返回:
    The filter chain in use
  - addListener
```
public final void addListener(IoServiceListener listener)
```
    Adds an IoServiceListener that listens any events related with this service.
    
    指定者:
    
    addListener 在接口中 IoService
    
    参数:
    listener - The listener to add
  - removeListener
```
public final void removeListener(IoServiceListener listener)
```
    Removed an existing IoServiceListener that listens any events related with this service.
    
    指定者:
    
    removeListener 在接口中 IoService
    
    参数:
    listener - The listener to use
  - isActive
```
public final boolean isActive()
```
    指定者:
    
    isActive 在接口中 IoService
    
    返回:
    a value of whether or not this service is active
  - isDisposing
```
public final boolean isDisposing()
```
    指定者:
    
    isDisposing 在接口中 IoService
    
    返回:
    true if and if only IoService.dispose() method has been called. Please note that this method will return true even after all the related resources are released.
  - isDisposed
```
public final boolean isDisposed()
```
    指定者:
    
    isDisposed 在接口中 IoService
    
    返回:
    true if and if only all resources of this processor have been disposed.
  - dispose
```
public final void dispose()
```
    Releases any resources allocated by this service. Please note that this method might block as long as there are any sessions managed by this service.
    
    指定者:
    
    dispose 在接口中 IoService
  - dispose
```
public final void dispose(boolean awaitTermination)
```
    Releases any resources allocated by this service. Please note that this method might block as long as there are any sessions managed by this service. Warning : calling this method from a IoFutureListener with awaitTermination = true will probably lead to a deadlock.
    
    指定者:
    
    dispose 在接口中 IoService
    
    参数:
    awaitTermination - When true this method will block until the underlying ExecutorService is terminated
  - dispose0
```
protected abstract void dispose0()
                          throws java.lang.Exception
```
    Implement this method to release any acquired resources. This method is invoked only once by dispose().
    
    抛出:
    
    java.lang.Exception - If the dispose failed
  - getManagedSessions
```
public final java.util.Map<java.lang.Long,IoSession> getManagedSessions()
```
    指定者:
    
    getManagedSessions 在接口中 IoService
    
    返回:
    the map of all sessions which are currently managed by this service. The key of map is the ID of the session. An empty collection if there's no session.
  - getManagedSessionCount
```
public final int getManagedSessionCount()
```
    指定者:
    
    getManagedSessionCount 在接口中 IoService
    
    返回:
    the number of all sessions which are currently managed by this service.
  - getHandler
```
public final IoHandler getHandler()
```
    指定者:
    
    getHandler 在接口中 IoService
    
    返回:
    the handler which will handle all connections managed by this service.
  - setHandler
```
public final void setHandler(IoHandler handler)
```
    Sets the handler which will handle all connections managed by this service.
    
    指定者:
    
    setHandler 在接口中 IoService
    
    参数:
    handler - The IoHandler to use
  - getSessionDataStructureFactory
```
public final IoSessionDataStructureFactory getSessionDataStructureFactory()
```
    指定者:
    
    getSessionDataStructureFactory 在接口中 IoService
    
    返回:
    the IoSessionDataStructureFactory that provides related data structures for a new session created by this service.
  - setSessionDataStructureFactory
```
public final void setSessionDataStructureFactory(IoSessionDataStructureFactory sessionDataStructureFactory)
```
    Sets the IoSessionDataStructureFactory that provides related data structures for a new session created by this service.
    
    指定者:
    
    setSessionDataStructureFactory 在接口中 IoService
    
    参数:
    sessionDataStructureFactory - The factory to use
  - getStatistics
```
public IoServiceStatistics getStatistics()
```
    指定者:
    
    getStatistics 在接口中 IoService
    
    返回:
    The statistics object for this service.
  - getActivationTime
```
public final long getActivationTime()
```
    指定者:
    
    getActivationTime 在接口中 IoService
    
    返回:
    the time when this service was activated. It returns the last time when this service was activated if the service is not active now.
  - broadcast
```
public final java.util.Set<WriteFuture> broadcast(java.lang.Object message)
```
    Writes the specified message to all the IoSessions managed by this service. This method is a convenience shortcut for IoUtil.broadcast(Object, Collection).
    
    指定者:
    
    broadcast 在接口中 IoService
    
    参数:
    message - the message to broadcast
    
    返回:
    The set of WriteFuture associated to the message being broadcasted
  - getListeners
```
public final IoServiceListenerSupport getListeners()
```
  - executeWorker
```
protected final void executeWorker(java.lang.Runnable worker)
```
  - executeWorker
```
protected final void executeWorker(java.lang.Runnable worker,
                 java.lang.String suffix)
```
  - initSession
```
protected final void initSession(IoSession session,
               IoFuture future,
               IoSessionInitializer sessionInitializer)
```
  - finishSessionInitialization0
```
protected void finishSessionInitialization0(IoSession session,
                                IoFuture future)
```
    Implement this method to perform additional tasks required for session initialization. Do not call this method directly; initSession(IoSession, IoFuture, IoSessionInitializer) will call this method instead.
    
    参数:
    session - The session to initialize
    future - The Future to use
  - getScheduledWriteBytes
```
public int getScheduledWriteBytes()
```
    指定者:
    
    getScheduledWriteBytes 在接口中 IoService
    
    返回:
    The number of bytes scheduled to be written
  - getScheduledWriteMessages
```
public int getScheduledWriteMessages()
```
    指定者:
    
    getScheduledWriteMessages 在接口中 IoService
    
    返回:
    The number of messages scheduled to be written

类 AbstractIoService

嵌套类概要

字段概要

构造器概要

方法概要

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

从接口继承的方法 org.apache.mina.core.service.IoService

字段详细资料

sessionConfig

disposalLock

构造器详细资料

AbstractIoService

方法详细资料

getFilterChainBuilder

setFilterChainBuilder

getFilterChain

addListener

removeListener

isActive

isDisposing

isDisposed

dispose

dispose

dispose0

getManagedSessions

getManagedSessionCount

getHandler

setHandler

getSessionDataStructureFactory

setSessionDataStructureFactory

getStatistics

getActivationTime

broadcast

getListeners

executeWorker

executeWorker

initSession

finishSessionInitialization0

getScheduledWriteBytes

getScheduledWriteMessages