io.github.spair.byond.message

Class ByondClient

java.lang.Object

io.github.spair.byond.message.ByondClient

public final class ByondClient
extends Object

Class to send string messages from Java app to BYOND server.

Simple usage example:

      ByondMessage messageToSend = new ByondMessage(new ServerAddress("bagil.game.tgstation13.org", 2337), "?ping");
      ByondResponse response = ByondClient.getInstance().sendMessage(messageToSend);
 

ServerAddress could be omitted like that: new ByondMessage("bagil.game.tgstation13.org", 2337, "ping")

Constructor Summary

Constructors

Constructor and Description
ByondClient()

Method Summary

Modifier and Type	Method and Description
void	sendCommand(ByondMessage byondMessage) Sends message to BYOND server without waiting for response.
ByondResponse	sendMessage(ByondMessage byondMessage) Sends message to BYOND server with wait and returning of response.
ByondResponse	sendMessage(ByondMessage byondMessage, int readTimeout) Sends message to BYOND server with wait and returning of response.

Methods inherited from class java.lang.Object

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

Constructor Detail

ByondClient

public ByondClient()

Method Detail

sendCommand

public void sendCommand(ByondMessage byondMessage)
                 throws HostUnavailableException

Sends message to BYOND server without waiting for response.

Parameters:

byondMessage - message to send

Throws:

HostUnavailableException - signals that requested server unavailable to connect

sendMessage

public ByondResponse sendMessage(ByondMessage byondMessage)
                          throws HostUnavailableException,
                                 UnexpectedResponseException

Sends message to BYOND server with wait and returning of response.

Method is blocking. Timeout time created from connection lag and sending/reading response time. Unlike sendMessage(ByondMessage, int) additional wait from timeout won't be added, but method is still guarantee, that whole data will be got.

Parameters:

byondMessage - message object to send

Returns:

Response from BYOND server as ByondResponse or null, if expected response is ResponseType.NONE

Throws:

HostUnavailableException - signals that requested server unavailable to connect

UnexpectedResponseException - if somehow response has unexpected behavior

sendMessage

public ByondResponse sendMessage(ByondMessage byondMessage,
                                 int readTimeout)
                          throws HostUnavailableException,
                                 UnexpectedResponseException

Sends message to BYOND server with wait and returning of response. Custom timeout wait could be insert.

Method is blocking. Timeout time created from connection lag, sending time and reading timeout. If timeout expired before response will be fully read, response data will be incomplete, but still exist. Zero and less timeout value means, that actual read will be performed like in sendMessage(ByondMessage), without any custom timeout at all.

Method is not recommended to be used, due to extra wait time from timeout, and possibility of shredding data if timeout is too low.

Parameters:

byondMessage - message object to send

readTimeout - timeout time to read response

Returns:

Response from BYOND server as ByondResponse or null, if expected response is ResponseType.NONE

Throws:

HostUnavailableException - signals that requested server unavailable to connect.

UnexpectedResponseException - if somehow response has unexpected behavior