Package dev.forbit.server.abstracts

Class Server

java.lang.Object

java.lang.Thread

dev.forbit.server.abstracts.Server

All Implemented Interfaces:

ServerInterface, Runnable

Direct Known Subclasses:

GSONServer, RawServer

public abstract class Server
extends Thread
implements ServerInterface

Base Server class that defines common methods and functionality for all server types. For implementation see RawServer or GSONServer

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor	Description
Server()

Method Summary

Modifier and Type	Method	Description
void	addClient(Client client)	Adds a client to this list.
void	forceDisconnect(Client client)	Override this for custom force disconnect behaviour
Optional<Client>	getClient(SocketAddress address)	Get the client from a given SocketAddress.
Optional<Client>	getClient(SocketChannel channel)	Get the client from a given SocketChannel.
Optional<Client>	getClient(UUID id)	Get client from a given UUID
Optional<Scheduler>	getScheduler()	Returns the scheduler object, or optional.null if not created yet
void	init()	Method called when booting up the server.
boolean	removeClient(Client client)	Remove the client from the Server's list.
void	run()
void	sendPacketTCP(Client client, Packet packet)	Send a packet to the client.
void	sendPacketUDP(Client client, Packet packet)
void	shutdown()	Shutdown all the servers.
void	updateClients()	Update the client set, removing inactive clients if required.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, onSpinWait, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.forbit.server.interfaces.ServerInterface

getServerProperties, getTCPServer, getTimeout, getUDPServer, onConnect, onDisconnect, setServerProperties, setTCPServer, setUDPServer

Constructor Details

Server

public Server()

Method Details

init

public void init()

Description copied from interface: ServerInterface

Method called when booting up the server.

Use this to start the thread if your server is extending Thread

Specified by:

init in interface ServerInterface

shutdown

public void shutdown()

Description copied from interface: ServerInterface

Shutdown all the servers.

Specified by:

shutdown in interface ServerInterface

updateClients

public void updateClients()

Description copied from interface: ServerInterface

Update the client set, removing inactive clients if required.

Specified by:

updateClients in interface ServerInterface

getClient

public Optional<Client> getClient(UUID id)

Description copied from interface: ServerInterface

Get client from a given UUID

Specified by:

getClient in interface ServerInterface

Parameters:

id - the id of the client

Returns:

optional containing the client, or empty if it cannot be found

getClient

public Optional<Client> getClient(SocketChannel channel)

Description copied from interface: ServerInterface

Get the client from a given SocketChannel.

Specified by:

getClient in interface ServerInterface

Parameters:

channel - the channel of the client

Returns:

optional containing the client, or empty if it cannot be found

getClient

public Optional<Client> getClient(SocketAddress address)

Description copied from interface: ServerInterface

Get the client from a given SocketAddress.

Specified by:

getClient in interface ServerInterface

Parameters:

address - the adress of the client.

Returns:

optional containing the client, or empty if it cannot be found.

removeClient

public boolean removeClient(Client client)

Description copied from interface: ServerInterface

Remove the client from the Server's list.

Specified by:

removeClient in interface ServerInterface

Parameters:

client - the client to remove

Returns:

whether or not the client was actually in the list.

addClient

public void addClient(Client client)

Description copied from interface: ServerInterface

Adds a client to this list.

Specified by:

addClient in interface ServerInterface

Parameters:

client - the client to add

sendPacketTCP

public void sendPacketTCP(Client client,
 Packet packet)

Description copied from interface: ServerInterface

Send a packet to the client.

Defaults to TCP.

Specified by:

sendPacketTCP in interface ServerInterface

Parameters:

client - client

packet - packet.

sendPacketUDP

public void sendPacketUDP(Client client,
 Packet packet)

Specified by:

sendPacketUDP in interface ServerInterface

getScheduler

public Optional<Scheduler> getScheduler()

Description copied from interface: ServerInterface

Returns the scheduler object, or optional.null if not created yet

Specified by:

getScheduler in interface ServerInterface

Returns:

scheduler

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

forceDisconnect

public void forceDisconnect(Client client)

Override this for custom force disconnect behaviour