me.melchor9000.net

Class Acceptor<SocketType extends Socket>

java.lang.Object

me.melchor9000.net.Acceptor<SocketType>

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

TCPAcceptor

public abstract class Acceptor<SocketType extends Socket>
extends java.lang.Object
implements java.lang.AutoCloseable

Allows to accept connections from others hosts. Basic for a server.

Field Summary

Fields

Modifier and Type	Field and Description
protected io.netty.bootstrap.ServerBootstrap	bootstrap
protected io.netty.channel.Channel	channel
protected Callback<SocketType>	onConnection
protected IOService	service

Method Summary

Modifier and Type	Method and Description
SocketType	accept() Waits until someone is connected to the acceptor, and returns its Socket.
abstract Future<SocketType>	acceptAsync() Accepts a connection from any client and returns the Socket.
void	bind(java.net.InetAddress address, int port) Binds the acceptor to the InetAddress and port port.
void	bind(int port) Binds the acceptor to the port port.
void	bind(java.net.SocketAddress address) Binds the acceptor to the SocketAddress.
protected void	checkSocketCreated(java.lang.String method) Call this method to check if the socket is created, if it's not, then throws a SocketNotCreated exception.
void	close()
Future<java.lang.Void>	closeAsync() Stops the acceptor asynchronously.
protected <ReturnType> Future<ReturnType>	createFuture(io.netty.util.concurrent.Future<ReturnType> n)
protected <ReturnType> FutureImpl<ReturnType>	createFuture(Procedure whenCancelled)
Future<java.lang.Void>	onClose() Returns a Future that it results when the server is closed
<T> void	setChildOption(io.netty.channel.ChannelOption<T> option, T value) Before calling any bind() methods, this can set some default options for the new sockets created when a client is connected.
void	setOnConnectionListener(Callback<SocketType> cbk) Instead of using accept() or acceptAsync(), it is possible to use a listener to receive any new connection to the acceptor.
<T> boolean	setOption(io.netty.channel.ChannelOption<T> option, T value) Sets an option for the acceptor
void	waitForClose() Waits until the acceptor is closed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

service

protected final IOService service

channel

protected io.netty.channel.Channel channel

bootstrap

protected io.netty.bootstrap.ServerBootstrap bootstrap

onConnection

protected Callback<SocketType extends Socket> onConnection

Method Detail

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception

closeAsync

public Future<java.lang.Void> closeAsync()

Stops the acceptor asynchronously.

Returns:

a Future for the close task

waitForClose

public void waitForClose()

Waits until the acceptor is closed. Cannot be interrupted.

onClose

public Future<java.lang.Void> onClose()

Returns a Future that it results when the server is closed

Returns:

a Future with the close task

bind

public void bind(java.net.SocketAddress address)
          throws java.lang.InterruptedException

Binds the acceptor to the SocketAddress.

Parameters:

address - address to bind

Throws:

java.lang.InterruptedException - if it is interrupted

bind

public void bind(java.net.InetAddress address,
                 int port)
          throws java.lang.InterruptedException

Binds the acceptor to the InetAddress and port port.

Parameters:

address - address

port - port

Throws:

java.lang.InterruptedException - if it is interrupted

bind

public void bind(int port)
          throws java.lang.InterruptedException

Binds the acceptor to the port port.

Parameters:

port - port

Throws:

java.lang.InterruptedException - if it is interrupted

acceptAsync

public abstract Future<SocketType> acceptAsync()

Accepts a connection from any client and returns the Socket.

Returns:

a Future with the accept task

accept

public SocketType accept()
                  throws java.lang.Exception

Waits until someone is connected to the acceptor, and returns its Socket.

Returns:

the Socket of the connection

Throws:

java.lang.Exception - if something bad happened

setOnConnectionListener

public void setOnConnectionListener(Callback<SocketType> cbk)

Instead of using accept() or acceptAsync(), it is possible to use a listener to receive any new connection to the acceptor. It is complementary of the before methods, so if one of the before methods are called, the new connection will be returned in this calls, not in the listener.

Parameters:

cbk - a listener that will be called when a new connection occurs

setOption

public <T> boolean setOption(io.netty.channel.ChannelOption<T> option,
                             T value)

Sets an option for the acceptor

Type Parameters:

T - type of the value for the option

Parameters:

option - option

value - value to set

Returns:

true if could be changed

setChildOption

public <T> void setChildOption(io.netty.channel.ChannelOption<T> option,
                               T value)

Before calling any bind() methods, this can set some default options for the new sockets created when a client is connected.

Type Parameters:

T - type of the value for the option

Parameters:

option - option

value - value to set

Throws:

java.lang.IllegalStateException - If the server is already bound

checkSocketCreated

protected void checkSocketCreated(java.lang.String method)

Call this method to check if the socket is created, if it's not, then throws a SocketNotCreated exception.

Parameters:

method - method that was called

createFuture

protected <ReturnType> FutureImpl<ReturnType> createFuture(Procedure whenCancelled)

createFuture

protected <ReturnType> Future<ReturnType> createFuture(io.netty.util.concurrent.Future<ReturnType> n)