Package org.apache.mina.common.support
Class BaseIoService
- java.lang.Object
-
- org.apache.mina.common.support.BaseIoService
-
- All Implemented Interfaces:
IoService
- Direct Known Subclasses:
BaseIoAcceptor
,BaseIoConnector
public abstract class BaseIoService extends java.lang.Object implements IoService
Base implementation ofIoService
s.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
BaseIoService()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addListener(IoServiceListener listener)
Adds anIoServiceListener
that listens any events related with this service.DefaultIoFilterChainBuilder
getFilterChain()
A shortcut for ( ( DefaultIoFilterChainBuilder )IoService.getFilterChainBuilder()
).IoFilterChainBuilder
getFilterChainBuilder()
Returns the globalIoFilterChainBuilder
which will modify theIoFilterChain
of allIoSession
s which is managed by this service.protected IoServiceListenerSupport
getListeners()
java.util.Set<java.net.SocketAddress>
getManagedServiceAddresses()
Returns allSocketAddress
es this service is managing.java.util.Set<IoSession>
getManagedSessions(java.net.SocketAddress serviceAddress)
Returns all sessions with the specified remote or local address, which are currently managed by this service.boolean
isManaged(java.net.SocketAddress serviceAddress)
Returns true if this service is managing the specified serviceAddress.void
removeListener(IoServiceListener listener)
Removed an existingIoServiceListener
that listens any events related with this service.void
setFilterChainBuilder(IoFilterChainBuilder builder)
Sets the globalIoFilterChainBuilder
which will modify theIoFilterChain
of allIoSession
s which is managed by this service.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.mina.common.IoService
getDefaultConfig
-
-
-
-
Method Detail
-
getFilterChainBuilder
public IoFilterChainBuilder getFilterChainBuilder()
Description copied from interface:IoService
Returns the globalIoFilterChainBuilder
which will modify theIoFilterChain
of allIoSession
s which is managed by this service. The default value is an emptyDefaultIoFilterChainBuilder
.- Specified by:
getFilterChainBuilder
in interfaceIoService
-
setFilterChainBuilder
public void setFilterChainBuilder(IoFilterChainBuilder builder)
Description copied from interface:IoService
Sets the globalIoFilterChainBuilder
which will modify theIoFilterChain
of allIoSession
s which is managed by this service. If you specify null this property will be set to an emptyDefaultIoFilterChainBuilder
.- Specified by:
setFilterChainBuilder
in interfaceIoService
-
getFilterChain
public DefaultIoFilterChainBuilder getFilterChain()
Description copied from interface:IoService
A shortcut for ( ( DefaultIoFilterChainBuilder )IoService.getFilterChainBuilder()
). Please note that the returned object is not a realIoFilterChain
but aDefaultIoFilterChainBuilder
. Modifying the returned builder won't affect the existingIoSession
s at all, becauseIoFilterChainBuilder
s affect only newly createdIoSession
s.- Specified by:
getFilterChain
in interfaceIoService
-
addListener
public void addListener(IoServiceListener listener)
Description copied from interface:IoService
Adds anIoServiceListener
that listens any events related with this service.- Specified by:
addListener
in interfaceIoService
-
removeListener
public void removeListener(IoServiceListener listener)
Description copied from interface:IoService
Removed an existingIoServiceListener
that listens any events related with this service.- Specified by:
removeListener
in interfaceIoService
-
getManagedServiceAddresses
public java.util.Set<java.net.SocketAddress> getManagedServiceAddresses()
Description copied from interface:IoService
Returns allSocketAddress
es this service is managing. If this service is anIoAcceptor
, a set of bind addresses will be returned. If this service is anIoConnector
, a set of remote addresses will be returned.- Specified by:
getManagedServiceAddresses
in interfaceIoService
-
getManagedSessions
public java.util.Set<IoSession> getManagedSessions(java.net.SocketAddress serviceAddress)
Description copied from interface:IoService
Returns all sessions with the specified remote or local address, which are currently managed by this service.IoAcceptor
will assume the specified address is a local address, andIoConnector
will assume it's a remote address.- Specified by:
getManagedSessions
in interfaceIoService
- Parameters:
serviceAddress
- the address to return all sessions for.- Returns:
- the sessions. An empty collection if there's no session.
-
isManaged
public boolean isManaged(java.net.SocketAddress serviceAddress)
Description copied from interface:IoService
Returns true if this service is managing the specified serviceAddress. If this service is anIoAcceptor
, serviceAddress is a bind address. If this service is anIoConnector
, serviceAddress is a remote address.
-
getListeners
protected IoServiceListenerSupport getListeners()
-
-