com.captainalm.lib.calmnet.marshal

Class NetMarshalClient

java.lang.Object

com.captainalm.lib.calmnet.marshal.NetMarshalClient

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

NetMarshalClientWrapped

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

This class provides a managed way of networking on the client side. 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
NetMarshalClient(java.net.DatagramSocket socketIn, java.net.InetAddress remoteAddress, int remotePort, java.io.InputStream inputStream, IPacketFactory factory, PacketLoader loader, FragmentationOptions fragmentationOptions) Constructs a new NetMarshalClient with the specified DatagramSocket, remote InetAddress, remote port, InputStream, IPacketFactory, PacketLoader and FragmentationOptions.
NetMarshalClient(java.net.DatagramSocket socketIn, java.net.InetAddress remoteAddress, int remotePort, IPacketFactory factory, PacketLoader loader, FragmentationOptions fragmentationOptions) Constructs a new NetMarshalClient with the specified DatagramSocket, remote InetAddress, remote port, IPacketFactory, PacketLoader and FragmentationOptions.
NetMarshalClient(java.net.MulticastSocket socketIn, java.net.InetAddress multicastGroupAddress, int multicastGroupPort, IPacketFactory factory, PacketLoader loader, FragmentationOptions fragmentationOptions) Constructs a new NetMarshalClient with the specified MulticastSocket, multicast group InetAddress, multicast port, IPacketFactory, PacketLoader and FragmentationOptions.
NetMarshalClient(java.net.Socket socketIn, IPacketFactory factory, PacketLoader loader, FragmentationOptions fragmentationOptions) Constructs a new NetMarshalClient with the specified Socket, IPacketFactory, PacketLoader and FragmentationOptions.

Method Summary

Modifier and Type	Method and Description
boolean	arePacketsBeingRead() Are IPackets being read.
boolean	areReceivedPacketsWaiting() Gets if there are received IPackets.
void	clearFragmentStorage() Clears the fragment storage registries if fragmentation is enabled.
void	close() Closes the marshal, closing all its streams.
void	flush() Flushes the output streams.
java.util.function.Consumer<NetMarshalClient>	getClosedConsumer() Gets the Consumer closed consumer.
FragmentationOptions	getFragmentationOptions() Gets the FragmentationOptions of the client.
java.io.InputStream	getInputStream() Get the input stream.
java.io.OutputStream	getOutputStream() Get the output stream.
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.io.InputStream	getRootInputStream() Get the root input stream.
java.io.OutputStream	getRootOutputStream() Get the root output stream.
boolean	isRunning() Gets if the marshal is running.
boolean	isSSLUpgraded() Gets if the marshal is ssl upgraded.
java.net.InetAddress	localAddress() Get the local InetAddress.
int	localPort() Get the local port.
void	open() Opens the marshal.
IPacket	receivePacket() Receives a IPacket.
IPacket	receivePacketPolled() Receives a IPacket polled.
java.net.InetAddress	remoteAddress() Get the remote InetAddress.
int	remotePort() Get the remote port.
void	sendPacket(IPacket packetIn, boolean directSend) Sends a IPacket.
void	setClosedConsumer(java.util.function.Consumer<NetMarshalClient> consumer) Sets the Consumer closed consumer.
void	setPacketsShouldBeRead(boolean shouldRead) Set if IPackets should be read.
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	sslUpgradeClientSide(javax.net.ssl.SSLContext context, java.lang.String remoteHostName) Performs SSL socket upgrades on client side (Use for constructed sockets).
void	sslUpgradeServerSide(javax.net.ssl.SSLContext context) Performs SSL socket upgrades on server side (Use for accepted sockets).

Methods inherited from class java.lang.Object

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

Constructor Detail

NetMarshalClient

public NetMarshalClient(java.net.Socket socketIn,
                        IPacketFactory factory,
                        PacketLoader loader,
                        FragmentationOptions fragmentationOptions)

Constructs a new NetMarshalClient with the specified Socket, IPacketFactory, PacketLoader and FragmentationOptions.

Parameters:

socketIn - The 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.

NetMarshalClient

public NetMarshalClient(java.net.MulticastSocket socketIn,
                        java.net.InetAddress multicastGroupAddress,
                        int multicastGroupPort,
                        IPacketFactory factory,
                        PacketLoader loader,
                        FragmentationOptions fragmentationOptions)
                 throws java.io.IOException

Constructs a new NetMarshalClient with the specified MulticastSocket, multicast group InetAddress, multicast port, IPacketFactory, PacketLoader and FragmentationOptions. The MulticastSocket will join the multicast group.

Parameters:

socketIn - The multicast socket to use.

multicastGroupAddress - The multicast group address.

multicastGroupPort - The multicast group port.

factory - The packet factory to use.

loader - The packet loader to use.

fragmentationOptions - The fragmentation options, null to disable fragmentation.

Throws:

java.io.IOException - There is an error joining or multicastGroupAddress is not a multicast address.

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

java.lang.IllegalArgumentException - multicastGroupPort is less than 0 or greater than 65535 or fragmentation options failed validation.

NetMarshalClient

public NetMarshalClient(java.net.DatagramSocket socketIn,
                        java.net.InetAddress remoteAddress,
                        int remotePort,
                        java.io.InputStream inputStream,
                        IPacketFactory factory,
                        PacketLoader loader,
                        FragmentationOptions fragmentationOptions)

Constructs a new NetMarshalClient with the specified DatagramSocket, remote InetAddress, remote port, InputStream, IPacketFactory, PacketLoader and FragmentationOptions.

Parameters:

socketIn - The datagram socket to use.

remoteAddress - The remote address to send data to.

remotePort - The remote port to send data to.

inputStream - The receiving input stream.

factory - The packet factory to use.

loader - The loader to use.

fragmentationOptions - The fragmentation options, null to disable fragmentation.

Throws:

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

java.lang.IllegalArgumentException - remotePort is less than 0 or greater than 65535 or fragmentation options failed validation.

NetMarshalClient

public NetMarshalClient(java.net.DatagramSocket socketIn,
                        java.net.InetAddress remoteAddress,
                        int remotePort,
                        IPacketFactory factory,
                        PacketLoader loader,
                        FragmentationOptions fragmentationOptions)

Constructs a new NetMarshalClient with the specified DatagramSocket, remote InetAddress, remote port, IPacketFactory, PacketLoader and FragmentationOptions.

Parameters:

socketIn - The datagram socket to use.

remoteAddress - The remote address to send data to.

remotePort - The remote port to send data to.

factory - The packet factory to use.

loader - The loader to use.

fragmentationOptions - The fragmentation options, null to disable fragmentation.

Throws:

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

java.lang.IllegalArgumentException - remotePort is less than 0 or greater than 65535 or fragmentation options failed validation.

Method Detail

open

public final void open()

Opens the marshal.

getInputStream

public java.io.InputStream getInputStream()

Get the input stream.

Returns:

Gets the input stream.

getRootInputStream

public java.io.InputStream getRootInputStream()

Get the root input stream.

Returns:

Gets the root input stream.

getOutputStream

public java.io.OutputStream getOutputStream()

Get the output stream.

Returns:

Gets the output stream.

getRootOutputStream

public java.io.OutputStream getRootOutputStream()

Get the root output stream.

Returns:

Gets the root output stream.

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.

clearFragmentStorage

public final void clearFragmentStorage()

Clears the fragment storage registries if fragmentation is enabled. WARNING: Use of this method is not recommended.

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.

remoteAddress

public java.net.InetAddress remoteAddress()

Get the remote InetAddress.

Returns:

The remote address.

remotePort

public int remotePort()

Get the remote port.

Returns:

The remote 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.

isSSLUpgraded

public final boolean isSSLUpgraded()

Gets if the marshal is ssl upgraded.

Returns:

Is the marshal ssl upgraded.

sendPacket

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

Sends a IPacket.

Parameters:

packetIn - The packet to send.

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 the output streams.

Throws:

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

areReceivedPacketsWaiting

public boolean areReceivedPacketsWaiting()

Gets if there are received IPackets.

Returns:

If there are received packets.

receivePacket

public IPacket receivePacket()
                      throws java.lang.InterruptedException

Receives a IPacket.

Returns:

The received packet.

Throws:

java.lang.InterruptedException - A thread interruption has occurred.

receivePacketPolled

public IPacket receivePacketPolled()

Receives a IPacket polled.

Returns:

The received packet.

arePacketsBeingRead

public boolean arePacketsBeingRead()

Are IPackets being read.

Returns:

Are packets being read.

setPacketsShouldBeRead

public void setPacketsShouldBeRead(boolean shouldRead)

Set if IPackets should be read.

Parameters:

shouldRead - Should packets be read.

sslUpgradeServerSide

public void sslUpgradeServerSide(javax.net.ssl.SSLContext context)
                          throws SSLUtilityException,
                                 java.io.IOException

Performs SSL socket upgrades on server side (Use for accepted sockets). Can only be called when setPacketsShouldBeRead(boolean) is set to false or in a BiConsumer consumer for setReceiveBiConsumer(BiConsumer).

Parameters:

context - The SSL context to use.

Throws:

SSLUtilityException - An SSL Utility exception has occurred.

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

java.lang.NullPointerException - context is null.

java.lang.IllegalStateException - sslUpgrade methods should be called in a BiConsumer (for setReceiveBiConsumer) within the target NetMarshalClient or when reading packets (arePacketsBeingRead) is disabled on the NetMarshalClient.

sslUpgradeClientSide

public void sslUpgradeClientSide(javax.net.ssl.SSLContext context,
                                 java.lang.String remoteHostName)
                          throws SSLUtilityException,
                                 java.io.IOException

Performs SSL socket upgrades on client side (Use for constructed sockets). Can only be called when setPacketsShouldBeRead(boolean) is set to false or in a BiConsumer consumer for setReceiveBiConsumer(BiConsumer).

Parameters:

context - The SSL context to use.

remoteHostName - The hostname of the remote server.

Throws:

SSLUtilityException - An SSL Utility exception has occurred.

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

java.lang.NullPointerException - context or remoteHostName is null.

java.lang.IllegalStateException - sslUpgrade methods should be called in a BiConsumer (for setReceiveBiConsumer) within the target NetMarshalClient or when reading packets (arePacketsBeingRead) is disabled on the NetMarshalClient.

getReceiveBiConsumer

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

Gets the BiConsumer receiver consumer. WARNING: Calling sendPacket(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 sendPacket(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.

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.

close

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

Closes the marshal, closing all its streams.

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.