Package org.apache.mina.common
Interface IoAcceptor
- All Superinterfaces:
IoService
- All Known Implementing Classes:
BaseIoAcceptor
,DatagramAcceptor
,DatagramAcceptorDelegate
,DelegatedIoAcceptor
,SocketAcceptor
,VmPipeAcceptor
Accepts incoming connection, communicates with clients, and fires events to
IoHandler
s.
Please refer to EchoServer example.
You should bind to the desired socket address to accept incoming
connections, and then events for incoming connections will be sent to
the specified default IoHandler
.
Threads accept incoming connections start automatically when
bind(SocketAddress, IoHandler)
is invoked, and stop when all
addresses are unbound.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
bind
(SocketAddress address, IoHandler handler) Binds to the specifiedaddress
and handles incoming connections with the specifiedhandler
.void
bind
(SocketAddress address, IoHandler handler, IoServiceConfig config) Binds to the specifiedaddress
and handles incoming connections with the specifiedhandler
.newSession
(SocketAddress remoteAddress, SocketAddress localAddress) (Optional) Returns anIoSession
that is bound to the specified localAddress and remoteAddress which reuses the localAddress that is already bound byIoAcceptor
viabind(SocketAddress, IoHandler)
.void
unbind
(SocketAddress address) Unbinds from the specifiedaddress
and disconnects all clients connected there.void
Unbinds all addresses which were bound by this acceptor.Methods inherited from interface org.apache.mina.common.IoService
addListener, getDefaultConfig, getFilterChain, getFilterChainBuilder, getManagedServiceAddresses, getManagedSessions, isManaged, removeListener, setFilterChainBuilder
-
Method Details
-
bind
Binds to the specifiedaddress
and handles incoming connections with the specifiedhandler
.- Throws:
IOException
- if failed to bind
-
bind
Binds to the specifiedaddress
and handles incoming connections with the specifiedhandler
.- Parameters:
config
- the configuration- Throws:
IOException
- if failed to bind
-
unbind
Unbinds from the specifiedaddress
and disconnects all clients connected there. -
unbindAll
void unbindAll()Unbinds all addresses which were bound by this acceptor. -
newSession
(Optional) Returns anIoSession
that is bound to the specified localAddress and remoteAddress which reuses the localAddress that is already bound byIoAcceptor
viabind(SocketAddress, IoHandler)
.This operation is optional. Please throw
UnsupportedOperationException
if the transport type doesn't support this operation. This operation is usually implemented for connectionless transport types.- Throws:
UnsupportedOperationException
- if this operation is not supportedIllegalArgumentException
- if the specified localAddress is not bound yet. (seebind(SocketAddress, IoHandler)
)
-