Package lu.kbra.p4j.socket.client

Class P4JClient

java.lang.Object

lu.kbra.p4j.socket.client.P4JClient

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable, P4JInstance, P4JInstance.P4JClientInstance, EventDispatcher

public class P4JClient
extends Object
implements P4JInstance.P4JClientInstance, EventDispatcher, Closeable, Runnable

This class represents the client-side Client connecting to the server.

Nested Class Summary

Nested classes/interfaces inherited from interface lu.kbra.p4j.socket.P4JInstance

P4JInstance.P4JClientInstance, P4JInstance.P4JClientServerInstance, P4JInstance.P4JServerClientInstance, P4JInstance.P4JServerInstance

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_PACKET_SIZE

Constructor Summary

Constructors

Constructor	Description
P4JClient(CodecManager codecManager, EncryptionManager encryptionManager, CompressionManager compressionManager)

Method Summary

Modifier and Type	Method	Description
void	bind()	Bind to a random available port on the local machine.
void	bind(int port)	Bind to the specified port on the local machine.
void	bind(InetSocketAddress inetSocketAddress)	Bind to the specified port on the local machine.
void	close()	Closes the client socket. The client' socket will be closed and the port will be released. Doesn't dispatch a P4JConnectionEvent.ClientDisconnectedEvent.
void	connect(InetAddress remote, int port)	Connect to the specified address and port on the remote machine.
void	connect(InetSocketAddress inetSocketAddress)	Connect to the specified address and port on the remote machine.
void	disconnect()	Disconnects & closes the client socket And dispatches a P4JConnectionEvent.ClientDisconnectedEvent.
void	dispatchEvent(P4JEvent event)
ClientServer	getClientServer()
BiFunction<P4JClient,InetSocketAddress,ClientServer>	getClientServerSupplier()
ClientStatus	getClientStatus()
CodecManager	getCodec()
CompressionManager	getCompression()
int	getConnectionTimeout()
EncryptionManager	getEncryption()
final P4JEndPoint	getEndPoint()
EventManager	getEventManager()
InetSocketAddress	getLocalInetSocketAddress()
PacketManager	getPackets()
int	getPort()
InetSocketAddress	getRemoteInetSocketAddress()
Thread.State	getState()
final boolean	isAlive()
boolean	isBound()
boolean	isConnected()
final void	join()
final void	join(long millis)
final void	join(long millis, int nanos)
protected void	read()
protected void	read_handleRawPacket(int id, ByteBuffer content)
void	registerPacket(Class<?> p, int id)
void	run()
void	setClientServerSupplier(BiFunction<P4JClient,InetSocketAddress,ClientServer> clientServerSupplier)
void	setCodec(CodecManager codec)
void	setCompression(CompressionManager compression)
void	setConnectionTimeout(int connectionTimeout)
void	setEncryption(EncryptionManager encryption)
void	setEventManager(EventManager eventManager)
void	setPackets(PacketManager packets)
boolean	testConnection()
boolean	write(C2SPacket packet)

Methods inherited from class java.lang.Object

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

Field Details

MAX_PACKET_SIZE

public static int MAX_PACKET_SIZE

Constructor Details

P4JClient

public P4JClient(CodecManager codecManager,
 EncryptionManager encryptionManager,
 CompressionManager compressionManager)

Parameters:

codecManager - the client's codec manager

encryptionManager - the client's encryption manager

compressionManager - the client's compression manager

Method Details

bind

public void bind()
          throws UnknownHostException

Bind to a random available port on the local machine.

Throws:

UnknownHostException

P4JClientException

bind

public void bind(InetSocketAddress inetSocketAddress)

Bind to the specified port on the local machine. If the port is 0, a random available port is chosen.

Parameters:

inetSocketAddress - the local address to bind to

Throws:

IOException - if the Socket cannot be created or bound

bind

public void bind(int port)
          throws UnknownHostException

Bind to the specified port on the local machine. If the port is 0, a random available port is chosen.

Parameters:

port - the port to bind to

Throws:

P4JClientException

UnknownHostException

close

public void close()

Closes the client socket.
The client' socket will be closed and the port will be released.
Doesn't dispatch a P4JConnectionEvent.ClientDisconnectedEvent.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

P4JClientException - if the client isn't started

connect

public void connect(InetAddress remote,
 int port)

Connect to the specified address and port on the remote machine.

Parameters:

remote - the remote address

port - the remote port

Throws:

IOException - if the Socket cannot be connected

connect

public void connect(InetSocketAddress inetSocketAddress)

Connect to the specified address and port on the remote machine.

disconnect

public void disconnect()

Disconnects & closes the client socket
And dispatches a P4JConnectionEvent.ClientDisconnectedEvent.

Throws:

P4JClientException - if the client isn't started

dispatchEvent

public void dispatchEvent(P4JEvent event)

getClientServer

public ClientServer getClientServer()

getClientServerSupplier

public BiFunction<P4JClient,InetSocketAddress,ClientServer> getClientServerSupplier()

getClientStatus

public ClientStatus getClientStatus()

getCodec

public CodecManager getCodec()

getCompression

public CompressionManager getCompression()

getConnectionTimeout

public int getConnectionTimeout()

getEncryption

public EncryptionManager getEncryption()

getEndPoint

public final P4JEndPoint getEndPoint()

Specified by:

getEndPoint in interface P4JInstance

Specified by:

getEndPoint in interface P4JInstance.P4JClientInstance

getEventManager

public EventManager getEventManager()

getLocalInetSocketAddress

public InetSocketAddress getLocalInetSocketAddress()

getPackets

public PacketManager getPackets()

getPort

public int getPort()

Returns:

the current port the client is connected to or -1 if it isn't bound

getRemoteInetSocketAddress

public InetSocketAddress getRemoteInetSocketAddress()

getState

public Thread.State getState()

isAlive

public final boolean isAlive()

isBound

public boolean isBound()

isConnected

public boolean isConnected()

join

public final void join()
                throws InterruptedException

Throws:

InterruptedException

join

public final void join(long millis)
                throws InterruptedException

Throws:

InterruptedException

join

public final void join(long millis,
 int nanos)
                throws InterruptedException

Throws:

InterruptedException

registerPacket

public void registerPacket(Class<?> p,
 int id)

run

public void run()

Specified by:

run in interface Runnable

setClientServerSupplier

public void setClientServerSupplier(BiFunction<P4JClient,InetSocketAddress,ClientServer> clientServerSupplier)

setCodec

public void setCodec(CodecManager codec)

setCompression

public void setCompression(CompressionManager compression)

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

setEncryption

public void setEncryption(EncryptionManager encryption)

setEventManager

public void setEventManager(EventManager eventManager)

setPackets

public void setPackets(PacketManager packets)

testConnection

public boolean testConnection()

write

public boolean write(C2SPacket packet)

read

protected void read()

read_handleRawPacket

protected void read_handleRawPacket(int id,
 ByteBuffer content)