com.almasb.fxgl.net

Class NetworkConnection

java.lang.Object

com.almasb.fxgl.net.NetworkConnection

Direct Known Subclasses:

Client, Server

public abstract class NetworkConnection
extends Object

Represents a communication between two machines over network.

Author:

Almas Baimagambetov (AlmasB) ([email protected])

Property Summary

Type	Property and Description
javafx.beans.property.ReadOnlyBooleanProperty	connectionActive

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
NetworkConnection()

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.
abstract void	close()
javafx.beans.property.ReadOnlyBooleanProperty	connectionActiveProperty()
Map<Class<?>,DataParser<? super Serializable>>	getParsers()
protected void	handleError(Exception e)
boolean	isConnectionActive() Gets the value of the property connectionActive.
protected void	onConnectionClosed()
protected void	onConnectionOpen()
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 abstract void	sendTCP(Serializable data)
protected abstract void	sendUDP(Serializable data)
void	setExceptionHandler(Consumer<Throwable> exceptionHandler)
void	setOnConnectionClosed(Runnable onConnectionClosed)
void	setOnConnectionOpen(Runnable onConnectionOpen)
void	setParsers(Map<Class<?>,DataParser<? super Serializable>> parsers)
protected static byte[]	toByteArray(Serializable data)

Methods inherited from class java.lang.Object

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

Property Detail

connectionActive

public final javafx.beans.property.ReadOnlyBooleanProperty connectionActiveProperty

See Also:

isConnectionActive()

Field Detail

parsers

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

Constructor Detail

NetworkConnection

public NetworkConnection()

Method Detail

getParsers

public Map<Class<?>,DataParser<? super Serializable>> getParsers()

setParsers

public void setParsers(Map<Class<?>,DataParser<? super Serializable>> parsers)

connectionActiveProperty

public final javafx.beans.property.ReadOnlyBooleanProperty connectionActiveProperty()

See Also:

isConnectionActive()

isConnectionActive

public boolean isConnectionActive()

Gets the value of the property connectionActive.

setOnConnectionOpen

public void setOnConnectionOpen(Runnable onConnectionOpen)

onConnectionOpen

protected void onConnectionOpen()

setOnConnectionClosed

public void setOnConnectionClosed(Runnable onConnectionClosed)

onConnectionClosed

protected void onConnectionClosed()

setExceptionHandler

public void setExceptionHandler(Consumer<Throwable> exceptionHandler)

handleError

protected void handleError(Exception e)

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)

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

Parameters:

data - the data object

send

public void send(Serializable data,
                 NetworkProtocol protocol)

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

Parameters:

data - the data object

protocol - the protocol to use

sendUDP

protected abstract void sendUDP(Serializable data)

sendTCP

protected abstract void sendTCP(Serializable data)

close

public abstract void close()

toByteArray

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

Throws:

Exception