Package org.apache.mina.transport.socket
Interface SocketAcceptor
-
- All Superinterfaces:
IoAcceptor
,IoService
- All Known Implementing Classes:
NioSocketAcceptor
public interface SocketAcceptor extends IoAcceptor
IoAcceptor
for socket transport (TCP/IP). This class handles incoming TCP/IP based socket connections.- Author:
- Apache MINA Project
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getBacklog()
InetSocketAddress
getDefaultLocalAddress()
Returns the default local address to bind when no argument is specified inIoAcceptor.bind()
method.InetSocketAddress
getLocalAddress()
Returns the local address which is bound currently.SocketSessionConfig
getSessionConfig()
boolean
isReuseAddress()
void
setBacklog(int backlog)
Sets the size of the backlog.void
setDefaultLocalAddress(InetSocketAddress localAddress)
Sets the default local InetSocketAddress to bind when no argument is specified inIoAcceptor.bind()
method.void
setReuseAddress(boolean reuseAddress)
-
Methods inherited from interface org.apache.mina.core.service.IoAcceptor
bind, bind, bind, bind, bind, getDefaultLocalAddresses, getLocalAddresses, isCloseOnDeactivation, newSession, setCloseOnDeactivation, setDefaultLocalAddress, setDefaultLocalAddresses, setDefaultLocalAddresses, setDefaultLocalAddresses, unbind, unbind, unbind, unbind
-
Methods inherited from interface org.apache.mina.core.service.IoService
addListener, broadcast, dispose, dispose, getActivationTime, getFilterChain, getFilterChainBuilder, getHandler, getManagedSessionCount, getManagedSessions, getScheduledWriteBytes, getScheduledWriteMessages, getSessionDataStructureFactory, getStatistics, getTransportMetadata, isActive, isDisposed, isDisposing, removeListener, setFilterChainBuilder, setHandler, setSessionDataStructureFactory
-
-
-
-
Method Detail
-
getLocalAddress
InetSocketAddress getLocalAddress()
Description copied from interface:IoAcceptor
Returns the local address which is bound currently. If more than one address are bound, only one of them will be returned, but it's not necessarily the firstly bound address.- Specified by:
getLocalAddress
in interfaceIoAcceptor
- Returns:
- the local InetSocketAddress which is bound currently. If more than one
address are bound, only one of them will be returned, but it's not
necessarily the firstly bound address.
This method overrides the
IoAcceptor.getLocalAddress()
method.
-
getDefaultLocalAddress
InetSocketAddress getDefaultLocalAddress()
Description copied from interface:IoAcceptor
Returns the default local address to bind when no argument is specified inIoAcceptor.bind()
method. Please note that the default will not be used if any local address is specified. If more than one address are set, only one of them will be returned, but it's not necessarily the firstly specified address inIoAcceptor.setDefaultLocalAddresses(List)
.- Specified by:
getDefaultLocalAddress
in interfaceIoAcceptor
- Returns:
- a
Set
of the local InetSocketAddress which are bound currently. This method overrides theIoAcceptor.getDefaultLocalAddress()
method.
-
setDefaultLocalAddress
void setDefaultLocalAddress(InetSocketAddress localAddress)
Sets the default local InetSocketAddress to bind when no argument is specified inIoAcceptor.bind()
method. Please note that the default will not be used if any local InetSocketAddress is specified. This method overrides theIoAcceptor.setDefaultLocalAddress(java.net.SocketAddress)
method.- Parameters:
localAddress
- The local address
-
isReuseAddress
boolean isReuseAddress()
- Returns:
true
if theSO_REUSEADDR
is enabled- See Also:
ServerSocket.getReuseAddress()
-
setReuseAddress
void setReuseAddress(boolean reuseAddress)
- Parameters:
reuseAddress
- tells if theSO_REUSEADDR
is to be enabled- See Also:
ServerSocket.setReuseAddress(boolean)
-
getBacklog
int getBacklog()
- Returns:
- the size of the backlog.
-
setBacklog
void setBacklog(int backlog)
Sets the size of the backlog. This can only be done when this class is not bound- Parameters:
backlog
- The backlog's size
-
getSessionConfig
SocketSessionConfig getSessionConfig()
- Specified by:
getSessionConfig
in interfaceIoService
- Returns:
- the default configuration of the new SocketSessions created by this acceptor service.
-
-