me.melchor9000.net

Class UDPSocket

java.lang.Object

me.melchor9000.net.Socket

me.melchor9000.net.UDPSocket

All Implemented Interfaces:

java.lang.AutoCloseable

public class UDPSocket
extends Socket

UDP socket for any kind of operation with them.

This implementation creates a UDP socket that can act as server or client, or both. To use this socket you can either Socket.bind() to a random port, bind(SocketAddress) to a known port or connect to a remote endpoint. In UDP, connect is not defined, instead we use this connection to discard any message that doesn't come from the remote endpoint and send only to the remote endpoint. A not connected socket could send to any endpoint and receive from any endpoint, using the special receiveFrom and sendTo methods.

Receive operations reads message by message, that's the essence of User Datagram Protocol (UDP). Any received packet is stored in a queue and every receive operation will read only one of this, if is possible. If the buffer not has enough capacity, will fail the receive operation. In this case, will throw a UDPSocket.NotEnoughSpaceForPacketException with some useful information about the packet. In case of an asynchronous operation, you must read the packet inside the callback using a synchronous receive operation, otherwise, the packet will be discarded.

Send operations also goes message by message. Every message is sent directly, without any intermediary buffers nor queue (except by the OS).

Received messages from any sender (receiveFrom operations) will return a UDPSocket.Packet which stores information about the Datagram received. The buffer inside it is your buffer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UDPSocket.NotEnoughSpaceForPacketException When there isn't enough space to save a Datagram, this exception is raised to notify the programmer to pass a more bigger buffer.
class	UDPSocket.Packet Represents a Datagram of UDP

Field Summary

Fields inherited from class me.melchor9000.net.Socket

bootstrap, bytesRead, bytesWrote, channel, service

Constructor Summary

Constructors

Constructor and Description
UDPSocket(IOService service) Create a UDP Socket
UDPSocket(IOService service, java.net.ProtocolFamily ip) Create a UDP Socket

Method Summary

Modifier and Type	Method and Description
void	bind(java.net.SocketAddress local) Binds the socket to a local address.
void	connect(java.net.SocketAddress endpoint) Binds the socket to a random port and connects to the remote endpoint.
Future<java.lang.Void>	connectAsync(java.net.SocketAddress endpoint) Binds the socket to a random port and connects to the remote endpoint asynchronously.
long	receive(io.netty.buffer.ByteBuf data, int bytes) Receives some data from the socket and writes it into the ByteBuf data a maximum of bytes bytes.
void	receive(Serializable data)
Future<java.lang.Long>	receiveAsync(io.netty.buffer.ByteBuf data, int bytes) Receives some data from the socket and writes it into the ByteBuf data a maximum of bytes bytes.
<Type extends Serializable> Future<Type>	receiveAsync(Type data)
Future<UDPSocket.Packet>	receiveAsyncFrom(io.netty.buffer.ByteBuf data)
Future<UDPSocket.Packet>	receiveAsyncFrom(io.netty.buffer.ByteBuf data, int bytes)
<Type extends Serializable> Future<UDPSocket.Packet>	receiveAsyncFrom(Type data)
UDPSocket.Packet	receiveFrom(io.netty.buffer.ByteBuf data)
UDPSocket.Packet	receiveFrom(io.netty.buffer.ByteBuf data, int bytes)
UDPSocket.Packet	receiveFrom(Serializable data)
long	send(Serializable data)
Future<java.lang.Void>	sendAsync(Serializable data)
Future<java.lang.Void>	sendAsyncTo(io.netty.buffer.ByteBuf data, java.net.InetSocketAddress endpoint)
Future<java.lang.Void>	sendAsyncTo(io.netty.buffer.ByteBuf data, int bytes, java.net.InetSocketAddress endpoint)
Future<java.lang.Void>	sendAsyncTo(Serializable data, java.net.InetSocketAddress remoteEndpoint)
Future<java.lang.Void>	sendAsyncTo(java.lang.String data, java.net.InetSocketAddress remoteEndpoint)
long	sendTo(io.netty.buffer.ByteBuf data, java.net.InetSocketAddress endpoint) Sends the data contained in data with a length of data.remaining() to the remote endpoint endpoint.
long	sendTo(io.netty.buffer.ByteBuf data, int bytes, java.net.InetSocketAddress endpoint) Sends the data contained in data with a length of bytes to the remote endpoint endpoint.
long	sendTo(Serializable data, java.net.InetSocketAddress remoteEndpoint)
long	sendTo(java.lang.String data, java.net.InetSocketAddress remoteEndpoint)

Methods inherited from class me.melchor9000.net.Socket

addOnDataReceivedListener, bind, checkSocketCreated, close, closeAsync, connect, connect, connectAsync, connectAsync, createFuture, createFuture, fireReceivedData, isOpen, localEndpoint, receive, receiveAsync, receivedBytes, remoteEndpoint, send, send, send, sendAsync, sendAsync, sendAsync, sendBytes, setOption

Methods inherited from class java.lang.Object

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

Constructor Detail

UDPSocket

public UDPSocket(IOService service)

Create a UDP Socket

Parameters:

service - IOService to attach this socket

UDPSocket

public UDPSocket(IOService service,
                 java.net.ProtocolFamily ip)

Create a UDP Socket

Parameters:

service - IOService to attach this socket

ip - ProtocolFamily

See Also:

StandardProtocolFamily

Method Detail

bind

public void bind(@NotNull
                 java.net.SocketAddress local)

Description copied from class: Socket

Binds the socket to a local address. Depending on the implementation, this could fail.

Overrides:

bind in class Socket

Parameters:

local - address to bind

connect

public void connect(@NotNull
                    java.net.SocketAddress endpoint)
             throws java.lang.InterruptedException

Description copied from class: Socket

Binds the socket to a random port and connects to the remote endpoint.

Overrides:

connect in class Socket

Parameters:

endpoint - remote endpoint

Throws:

java.lang.InterruptedException - When this Thread is interrupted

connectAsync

@NotNull
public Future<java.lang.Void> connectAsync(@NotNull
                                                    java.net.SocketAddress endpoint)

Description copied from class: Socket

Binds the socket to a random port and connects to the remote endpoint asynchronously. Returns a Future where the task can be managed.

Overrides:

connectAsync in class Socket

Parameters:

endpoint - remote endpoint to connect

Returns:

Future of the task

sendTo

public long sendTo(io.netty.buffer.ByteBuf data,
                   int bytes,
                   java.net.InetSocketAddress endpoint)

Sends the data contained in data with a length of bytes to the remote endpoint endpoint.

Parameters:

data - data to send

bytes - number of bytes to send

endpoint - remote endpoint

Returns:

number of bytes sent

sendTo

public long sendTo(io.netty.buffer.ByteBuf data,
                   java.net.InetSocketAddress endpoint)

Sends the data contained in data with a length of data.remaining() to the remote endpoint endpoint.

Parameters:

data - data to send

endpoint - remote endpoint

Returns:

number of bytes sent

sendAsyncTo

public Future<java.lang.Void> sendAsyncTo(io.netty.buffer.ByteBuf data,
                                          int bytes,
                                          java.net.InetSocketAddress endpoint)

sendAsyncTo

public Future<java.lang.Void> sendAsyncTo(io.netty.buffer.ByteBuf data,
                                          java.net.InetSocketAddress endpoint)

receive

public long receive(io.netty.buffer.ByteBuf data,
                    int bytes)
             throws java.lang.Throwable

Description copied from class: Socket

Receives some data from the socket and writes it into the ByteBuf data a maximum of bytes bytes. This method don't read exactly bytes bytes, only at most. To ensure read all the bytes, use one of the SocketUtil methods.

Specified by:

receive in class Socket

Parameters:

data - buffer where to write on all the data

bytes - maximum number of bytes to read

Returns:

number of bytes read currently

Throws:

java.lang.Throwable - if the receive operation fails, throws something

receiveFrom

public UDPSocket.Packet receiveFrom(io.netty.buffer.ByteBuf data,
                                    int bytes)
                             throws java.lang.Throwable

Throws:

java.lang.Throwable

receiveFrom

public UDPSocket.Packet receiveFrom(io.netty.buffer.ByteBuf data)
                             throws java.lang.Throwable

Throws:

java.lang.Throwable

receiveAsync

@NotNull
public Future<java.lang.Long> receiveAsync(io.netty.buffer.ByteBuf data,
                                                    int bytes)

Description copied from class: Socket

Receives some data from the socket and writes it into the ByteBuf data a maximum of bytes bytes. This method don't read exactly bytes bytes, only at most. To ensure read all the bytes, use one of the SocketUtil methods. This operation is done asynchronously, so returns a Future for the task.

Specified by:

receiveAsync in class Socket

Parameters:

data - buffer where to write on all the data

bytes - maximum number of bytes to read

Returns:

a Future representing this task

receiveAsyncFrom

public Future<UDPSocket.Packet> receiveAsyncFrom(io.netty.buffer.ByteBuf data,
                                                 int bytes)

receiveAsyncFrom

public Future<UDPSocket.Packet> receiveAsyncFrom(io.netty.buffer.ByteBuf data)

sendAsync

public Future<java.lang.Void> sendAsync(Serializable data)

send

public long send(Serializable data)
          throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

sendAsyncTo

public Future<java.lang.Void> sendAsyncTo(java.lang.String data,
                                          java.net.InetSocketAddress remoteEndpoint)

sendAsyncTo

public Future<java.lang.Void> sendAsyncTo(Serializable data,
                                          java.net.InetSocketAddress remoteEndpoint)

sendTo

public long sendTo(java.lang.String data,
                   java.net.InetSocketAddress remoteEndpoint)
            throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

sendTo

public long sendTo(Serializable data,
                   java.net.InetSocketAddress remoteEndpoint)
            throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

receiveAsync

public <Type extends Serializable> Future<Type> receiveAsync(Type data)

receiveAsyncFrom

public <Type extends Serializable> Future<UDPSocket.Packet> receiveAsyncFrom(Type data)

receive

public void receive(Serializable data)
             throws java.lang.Throwable

Throws:

java.lang.Throwable

receiveFrom

public UDPSocket.Packet receiveFrom(Serializable data)
                             throws java.lang.Throwable

Throws:

java.lang.Throwable