com.captainalm.lib.calmnet.marshal

Class NetMarshalServer

java.lang.Object

com.captainalm.lib.calmnet.marshal.NetMarshalServer

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

NetMarshalServerWrapped

public class NetMarshalServer
extends java.lang.Object
implements java.io.Closeable

This class provides a way of networking on the server side and holds a collection of NetMarshalClients. NOTE: Methods that are synchronised are used here, do NOT use instances of these classes as monitors.

Author:

Captain ALM

Constructor Summary

Constructors

Constructor and Description
NetMarshalServer(java.net.DatagramSocket socketIn, IPacketFactory factory, PacketLoader loader, FragmentationOptions fragmentationOptions) Constructs a new NetMarshalServer with the specified DatagramSocket, IPacketFactory, PacketLoader and FragmentationOptions.
NetMarshalServer(java.net.ServerSocket socketIn, IPacketFactory factory, PacketLoader loader, FragmentationOptions fragmentationOptions) Constructs a new NetMarshalServer with the specified ServerSocket, IPacketFactory, PacketLoader and FragmentationOptions.

Method Summary

Modifier and Type	Method and Description
void	broadcastPacket(IPacket packetIn, boolean directSend) Broadcasts a IPacket.
void	close() Closes the marshal, closing all the connected clients.
NetMarshalClient	connect(java.net.InetAddress remoteAddress, int remotePort, int timeout) Connects to a remote endpoint.
void	disconnectAll() Disconnects all the clients (By closing them).
void	flush() Flushes all the output streams on all the clients.
java.util.function.BiConsumer<java.lang.Exception,NetMarshalServer>	getAcceptExceptionBiConsumer() Gets the BiConsumer accept exception consumer.
java.util.function.BiConsumer<CandidateClient,NetMarshalServer>	getClientAcceptanceBiConsumer() Gets the BiConsumer client acceptance consumer.
java.util.function.Consumer<NetMarshalClient>	getClosedConsumer() Gets the Consumer closed consumer.
NetMarshalClient[]	getConnectedClients() Gets the current set of connected NetMarshalClients.
FragmentationOptions	getFragmentationOptions() Gets the FragmentationOptions of the client.
java.util.function.Consumer<NetMarshalClient>	getOpenedConsumer() Gets the Consumer opened consumer.
IPacketFactory	getPacketFactory() Gets the packet factory in use.
PacketLoader	getPacketLoader() Gets the packet loader in use.
java.util.function.BiConsumer<IPacket,NetMarshalClient>	getReceiveBiConsumer() Gets the BiConsumer receiver consumer.
java.util.function.BiConsumer<java.lang.Exception,NetMarshalClient>	getReceiveExceptionBiConsumer() Gets the BiConsumer receive exception consumer.
java.util.function.BiConsumer<java.net.Socket,NetMarshalServer>	getSocketSetupBiConsumer() Gets the BiConsumer socket setup consumer.
boolean	isRunning() Gets if the marshal is running.
java.net.InetAddress	localAddress() Get the local InetAddress.
int	localPort() Get the local port.
void	open() Opens the marshal.
void	setAcceptExceptionBiConsumer(java.util.function.BiConsumer<java.lang.Exception,NetMarshalServer> consumer) Sets the BiConsumer accept exception consumer.
void	setClientAcceptanceBiConsumer(java.util.function.BiConsumer<CandidateClient,NetMarshalServer> consumer) Sets the BiConsumer client acceptance consumer.
void	setClosedConsumer(java.util.function.Consumer<NetMarshalClient> consumer) Sets the Consumer closed consumer.
void	setOpenedConsumer(java.util.function.Consumer<NetMarshalClient> consumer) Sets the Consumer opened consumer.
void	setReceiveBiConsumer(java.util.function.BiConsumer<IPacket,NetMarshalClient> consumer) Sets the BiConsumer receiver consumer.
void	setReceiveExceptionBiConsumer(java.util.function.BiConsumer<java.lang.Exception,NetMarshalClient> consumer) Sets the BiConsumer receive exception consumer.
void	setSocketSetupBiConsumer(java.util.function.BiConsumer<java.net.Socket,NetMarshalServer> consumer) Sets the BiConsumer socket setup consumer.

Methods inherited from class java.lang.Object

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

Constructor Detail

NetMarshalServer

public NetMarshalServer(java.net.ServerSocket socketIn,
                        IPacketFactory factory,
                        PacketLoader loader,
                        FragmentationOptions fragmentationOptions)

Constructs a new NetMarshalServer with the specified ServerSocket, IPacketFactory, PacketLoader and FragmentationOptions.

Parameters:

socketIn - The server socket to use.

factory - The packet factory to use.

loader - The packet loader to use.

fragmentationOptions - The fragmentation options, null to disable fragmentation.

Throws:

java.lang.NullPointerException - socketIn, factory or loader is null.

java.lang.IllegalArgumentException - Fragmentation options failed validation.

NetMarshalServer

public NetMarshalServer(java.net.DatagramSocket socketIn,
                        IPacketFactory factory,
                        PacketLoader loader,
                        FragmentationOptions fragmentationOptions)

Constructs a new NetMarshalServer with the specified DatagramSocket, IPacketFactory, PacketLoader and FragmentationOptions.

Parameters:

socketIn - The datagram socket to use.

factory - The packet factory to use.

loader - The packet loader to use.

fragmentationOptions - The fragmentation options, null to disable fragmentation.

Throws:

java.lang.NullPointerException - socketIn, factory or loader is null.

java.lang.IllegalArgumentException - Fragmentation options failed validation.

Method Detail

open

public final void open()

Opens the marshal.

getPacketFactory

public IPacketFactory getPacketFactory()

Gets the packet factory in use.

Returns:

The packet factory.

getPacketLoader

public PacketLoader getPacketLoader()

Gets the packet loader in use.

Returns:

The packet loader.

localAddress

public java.net.InetAddress localAddress()

Get the local InetAddress.

Returns:

The local address or null.

localPort

public int localPort()

Get the local port.

Returns:

The local port or -1.

isRunning

public final boolean isRunning()

Gets if the marshal is running.

Returns:

If the marshal is running.

getFragmentationOptions

public FragmentationOptions getFragmentationOptions()

Gets the FragmentationOptions of the client.

Returns:

The fragmentation options or null if fragmentation is disabled.

getConnectedClients

public final NetMarshalClient[] getConnectedClients()

Gets the current set of connected NetMarshalClients.

Returns:

An array of connected clients.

broadcastPacket

public final void broadcastPacket(IPacket packetIn,
                                  boolean directSend)
                           throws java.io.IOException,
                                  PacketException

Broadcasts a IPacket.

Parameters:

packetIn - The packet to broadcast.

directSend - Whether the packet should be sent directly or through the fragmentation system.

Throws:

java.io.IOException - A stream exception has occurred.

PacketException - An exception has occurred.

java.lang.NullPointerException - packetIn is null.

flush

public final void flush()
                 throws java.io.IOException

Flushes all the output streams on all the clients.

Throws:

java.io.IOException - A stream exception has occurred.

disconnectAll

public final void disconnectAll()
                         throws java.io.IOException

Disconnects all the clients (By closing them).

Throws:

java.io.IOException - An I/O Exception has occurred.

getReceiveBiConsumer

public java.util.function.BiConsumer<IPacket,NetMarshalClient> getReceiveBiConsumer()

Gets the BiConsumer receiver consumer. WARNING: Calling broadcastPacket(IPacket, boolean) or flush() could cause full buffer hangs.

Returns:

The receiver consumer or null.

setReceiveBiConsumer

public void setReceiveBiConsumer(java.util.function.BiConsumer<IPacket,NetMarshalClient> consumer)

Sets the BiConsumer receiver consumer. WARNING: Calling broadcastPacket(IPacket, boolean) or flush() could cause full buffer hangs.

Parameters:

consumer - The new receiver consumer.

Throws:

java.lang.NullPointerException - consumer is null.

getReceiveExceptionBiConsumer

public java.util.function.BiConsumer<java.lang.Exception,NetMarshalClient> getReceiveExceptionBiConsumer()

Gets the BiConsumer receive exception consumer.

Returns:

The exception consumer or null.

setReceiveExceptionBiConsumer

public void setReceiveExceptionBiConsumer(java.util.function.BiConsumer<java.lang.Exception,NetMarshalClient> consumer)

Sets the BiConsumer receive exception consumer.

Parameters:

consumer - The new exception consumer.

Throws:

java.lang.NullPointerException - consumer is null.

getAcceptExceptionBiConsumer

public java.util.function.BiConsumer<java.lang.Exception,NetMarshalServer> getAcceptExceptionBiConsumer()

Gets the BiConsumer accept exception consumer.

Returns:

The exception consumer or null.

setAcceptExceptionBiConsumer

public void setAcceptExceptionBiConsumer(java.util.function.BiConsumer<java.lang.Exception,NetMarshalServer> consumer)

Sets the BiConsumer accept exception consumer.

Parameters:

consumer - The new exception consumer.

Throws:

java.lang.NullPointerException - consumer is null.

getClosedConsumer

public java.util.function.Consumer<NetMarshalClient> getClosedConsumer()

Gets the Consumer closed consumer.

Returns:

The closed consumer or null.

setClosedConsumer

public void setClosedConsumer(java.util.function.Consumer<NetMarshalClient> consumer)

Sets the Consumer closed consumer.

Parameters:

consumer - The new closed consumer.

Throws:

java.lang.NullPointerException - consumer is null.

getOpenedConsumer

public java.util.function.Consumer<NetMarshalClient> getOpenedConsumer()

Gets the Consumer opened consumer.

Returns:

The opened consumer or null.

setOpenedConsumer

public void setOpenedConsumer(java.util.function.Consumer<NetMarshalClient> consumer)

Sets the Consumer opened consumer.

Parameters:

consumer - The new opened consumer.

Throws:

java.lang.NullPointerException - consumer is null.

getClientAcceptanceBiConsumer

public java.util.function.BiConsumer<CandidateClient,NetMarshalServer> getClientAcceptanceBiConsumer()

Gets the BiConsumer client acceptance consumer. Use CandidateClient.accept to declare whether the candidate should be accepted.

Returns:

The acceptance consumer or null.

setClientAcceptanceBiConsumer

public void setClientAcceptanceBiConsumer(java.util.function.BiConsumer<CandidateClient,NetMarshalServer> consumer)

Sets the BiConsumer client acceptance consumer. Use CandidateClient.accept to declare whether the candidate should be accepted.

Parameters:

consumer - The new acceptance consumer.

Throws:

java.lang.NullPointerException - consumer is null.

getSocketSetupBiConsumer

public java.util.function.BiConsumer<java.net.Socket,NetMarshalServer> getSocketSetupBiConsumer()

Gets the BiConsumer socket setup consumer.

Returns:

The setup consumer or null.

setSocketSetupBiConsumer

public void setSocketSetupBiConsumer(java.util.function.BiConsumer<java.net.Socket,NetMarshalServer> consumer)

Sets the BiConsumer socket setup consumer.

Parameters:

consumer - The new setup consumer.

Throws:

java.lang.NullPointerException - consumer is null.

connect

public final NetMarshalClient connect(java.net.InetAddress remoteAddress,
                                      int remotePort,
                                      int timeout)
                               throws java.io.IOException

Connects to a remote endpoint.

Parameters:

remoteAddress - The remote address to connect to.

remotePort - The remote port to connect to.

timeout - The timeout of the connection attempt (0 for infinite timeout).

Returns:

A NetMarshalClient instance or null for non-accepted connection.

Throws:

java.io.IOException - A connection error has occurred.

close

public final void close()
                 throws java.io.IOException

Closes the marshal, closing all the connected clients.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - An I/O Exception has occurred.