com.almasb.fxgl.net

Class Client

java.lang.Object

com.almasb.fxgl.net.NetworkConnection

com.almasb.fxgl.net.Client

public final class Client
extends NetworkConnection

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)

Property Summary

Properties inherited from class com.almasb.fxgl.net.NetworkConnection

connectionActiveProperty

Field Summary

Fields inherited from class com.almasb.fxgl.net.NetworkConnection

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
void	close()
boolean	connect() Performs an actual (blocking for 10 sec) connection to the server.
void	disconnect() Sends a message to server that client is about to disconnect and shuts down connection threads.
protected void	sendTCP(Serializable data)
protected void	sendUDP(Serializable data)

Methods inherited from class com.almasb.fxgl.net.NetworkConnection

addParser, connectionActiveProperty, getParsers, handleError, isConnectionActive, onConnectionClosed, onConnectionOpen, send, send, sendClosingMessage, setExceptionHandler, setOnConnectionClosed, setOnConnectionOpen, setParsers, toByteArray

Methods inherited from class java.lang.Object

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

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 (blocking for 10 sec) 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 NetworkConnection.send(Serializable) will throw IllegalStateException

close

public void close()

Specified by:

close in class NetworkConnection

sendUDP

protected void sendUDP(Serializable data)

Specified by:

sendUDP in class NetworkConnection

sendTCP

protected void sendTCP(Serializable data)

Specified by:

sendTCP in class NetworkConnection