com.almasb.fxgl.net

Class Server

java.lang.Object

com.almasb.fxgl.net.Server

public final class Server
extends Object

Server side of the network connection.

Example:

  // create server object with default params, note: no network operation yet
 Server server = new Server();
  // add relevant parsers for messages from client
 server.addParser(String.class, data -> System.out.println(data));
  // actual network operation
 server.start();
  // send some messages
 server.send("This is an example message");
  // when done, stop the server
 server.stop();
 

Version:

1.0

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
Server() Constructs and configures a single-client server with default ports No network operation is done at this point.
Server(int tcpPort, int udpPort) Constructs and configures a single-client server with default ports No network operation is done at this point.

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.
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)
void	start() Starts the server.
void	stop() Sends a message to all connected clients that the server is about to shut down.
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

Server

public Server()

Constructs and configures a single-client server with default ports No network operation is done at this point.

Server

public Server(int tcpPort,
              int udpPort)

Constructs and configures a single-client server with default ports No network operation is done at this point.

Method Detail

start

public void start()

Starts the server. This performs an actual network operation of binding to ports and listening for incoming connections.

stop

public void stop()

Sends a message to all connected clients that the server is about to shut down. Then stops the server and the 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