com.almasb.fxgl.net

Class Client

java.lang.Object

com.almasb.fxgl.net.Client

public final class Client
extends Object

Client side of the network connection.

Example:

  // server ip
 Client client = new Client("127.0.0.1");
  // add relevant parsers for messages from server
 client.addParser(String.class, data -> System.out.println(data));
  // connect to server
 client.connect();
  // send some messages
 client.send("This is an example message");
  // when done, disconnect from server
 client.disconnect();
 

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Class<?>,DataParser<? super Serializable>>	parsers

Constructor Summary

Constructors

Constructor and Description
Client(String serverIP) Constructs a new client with given server IP configuration.
Client(String serverIP, int tcpPort, int udpPort) Constructs a new client with given server IP and tcp/udp ports configuration.

Method Summary

Modifier and Type	Method and Description
<T extends Serializable> void	addParser(Class<T> cl, DataParser<T> parser) Register a parser for specified class.
boolean	connect() Performs an actual connection to the server
void	disconnect() Sends a message to server that client is about to disconnect and shuts down connection threads.
void	send(Serializable data) Send data to the machine at the other end using UDP protocol.
void	send(Serializable data, NetworkProtocol protocol) Send data to the machine at the other end using specified protocol
protected void	sendClosingMessage() Send a message (hint) that this end of connection is about to close
protected void	sendTCP(Serializable data)
protected void	sendUDP(Serializable data)
protected static byte[]	toByteArray(Serializable data)

Methods inherited from class java.lang.Object

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

Field Detail

parsers

protected Map<Class<?>,DataParser<? super Serializable>> parsers

Constructor Detail

Client

public Client(String serverIP)

Constructs a new client with given server IP configuration. No network operation is done at this point.

Parameters:

serverIP - ip of the server machine

Client

public Client(String serverIP,
              int tcpPort,
              int udpPort)

Constructs a new client with given server IP and tcp/udp ports configuration. No network operation is done at this point.

Parameters:

serverIP - ip of the server machine

tcpPort - tcp port to use

udpPort - udp port to use

Method Detail

connect

public boolean connect()
                throws Exception

Performs an actual connection to the server

Returns:

true if connected and all is OK, false if something failed

Throws:

Exception

disconnect

public void disconnect()

Sends a message to server that client is about to disconnect and shuts down connection threads.

Further calls to send(Serializable) will throw IllegalStateException

sendUDP

protected void sendUDP(Serializable data)
                throws Exception

Throws:

Exception

sendTCP

protected void sendTCP(Serializable data)
                throws Exception

Throws:

Exception

sendClosingMessage

protected void sendClosingMessage()

Send a message (hint) that this end of connection is about to close

addParser

public <T extends Serializable> void addParser(Class<T> cl,
                                               DataParser<T> parser)

Register a parser for specified class. The parser will be called back when an instance of the class arrives from the other end of connection

Parameters:

cl - data structure class

parser - the data parser

send

public void send(Serializable data)
          throws Exception

Send data to the machine at the other end using UDP protocol.

Parameters:

data - the data object

Throws:

Exception

send

public void send(Serializable data,
                 NetworkProtocol protocol)
          throws Exception

Send data to the machine at the other end using specified protocol

Parameters:

data - the data object

protocol - the protocol to use

Throws:

Exception

toByteArray

protected static byte[] toByteArray(Serializable data)
                             throws Exception

Throws:

Exception