io.github.spair.byond.message.client

Class ByondClient

java.lang.Object

io.github.spair.byond.message.client.ByondClient

public class ByondClient
extends Object

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

Simple usage example:

 ByondMessage messageToSend = new ByondMessage(new ServerAddress("bagil.game.tgstation13.org", 2337), "?ping");

 ByondClient client = new ByondClient();
 ByondResponse response = client.sendMessage(messageToSend);
 

This, with the same result, could be rewritten in the next way:

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

Constructor Summary

Constructors

Constructor and Description
ByondClient()

Method Summary

Modifier and Type	Method and Description
static ByondClient	create() Static method to create ByondClient instance without calling of constructor.
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 of returning 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

create

public static ByondClient create()

Static method to create ByondClient instance without calling of constructor.

Returns:

ByondClient instance.

sendCommand

public void sendCommand(ByondMessage byondMessage)
                 throws HostUnavailableException

Sends message to BYOND server without waiting for response.

Parameters:

byondMessage - message object to send.

Throws:

HostUnavailableException - signals that requested server unavailable to connect.

sendMessage

public ByondResponse sendMessage(ByondMessage byondMessage)
                          throws HostUnavailableException,
                                 UnexpectedResponseTypeException,
                                 EmptyResponseException,
                                 UnknownResponseException

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

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

Parameters:

byondMessage - message object to send.

Returns:

Response from BYOND server as ByondResponse. If message expecting response type is ResponseType.NONE, then response instance will has 'null' in 'responseData' field and ResponseType.NONE in 'responseType' field.

Throws:

HostUnavailableException - signals that requested server unavailable to connect.

UnexpectedResponseTypeException - thrown if expected response doesn't equals to actual got.

EmptyResponseException - thrown if response was empty, but user waiting for something. Cause could be in BYOND server itself. Typically, it doesn't handle message which was send and, as a result, not provide any response.

UnknownResponseException - signals that response was caught, but it encoded into unknown format.

sendMessage

public ByondResponse sendMessage(ByondMessage byondMessage,
                                 int readTimeout)
                          throws HostUnavailableException,
                                 UnexpectedResponseTypeException,
                                 EmptyResponseException,
                                 UnknownResponseException

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

Method is blocking. Waiting time created from connection lag, sending time and reading timeout. If timeout expired before response fully read 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. If message expecting response type is ResponseType.NONE, then response instance will has 'null' in 'responseData' field and ResponseType.NONE in 'responseType' field.

Throws:

HostUnavailableException - signals that requested server unavailable to connect.

UnexpectedResponseTypeException - thrown if expected response doesn't equals to actual got.

EmptyResponseException - thrown if response was empty, but user waiting for something. Cause could be in BYOND server itself. Typically, it doesn't handle message which was send and, as a result, not provide any response.

UnknownResponseException - signals that response was caught, but it encoded into unknown format.