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.
Could be created by no args constructor or with create() method.

Simple usage example:

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

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

Sending process could be made in one line style:

  ByondResponse response = ByondClient.create().sendMessage(messageToSend);
 

Message sending is based on Socket class and process of reading returned data is built on reacting on SocketTimeoutException, due to BYOND doesn't send 'end byte'.
Response reading timeout could be set up. If it won't, default value, which is 500 ms, will be used.

Constructor Summary

Constructors

Constructor and Description
ByondClient()

Method Summary

Modifier and Type	Method and Description
static ByondClient	create() Static method create ByondClient instance without constructor.
void	sendCommand(ByondMessage byondMessage) Send message to BYOND server without waiting for response.
ByondResponse	sendMessage(ByondMessage byondMessage) Send message to BYOND server with waiting for response.
ByondResponse	sendMessage(ByondMessage byondMessage, int readTimeout) Send message to BYOND server with waiting for 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 create ByondClient instance without constructor.

Returns:

new ByondClient instance.

sendCommand

public void sendCommand(ByondMessage byondMessage)
                 throws HostUnavailableException

Send message to BYOND server without waiting for response.

Parameters:

byondMessage - message to send.

Throws:

HostUnavailableException - signals that requested server unavailable to connect. Offline or some other reason.

sendMessage

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

Send message to BYOND server with waiting for response. Similar to sendMessage(ByondMessage, int) but without second argument, so as reading timeout 500 ms used.

Parameters:

byondMessage - mesasge to send.

Returns:

response from BYOND server as ByondResponse or as null, if message response type was ResponseType.NONE.

Throws:

HostUnavailableException - signals that requested server unavailable to connect. Offline or some other reason.

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

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

UnknownResponseException

sendMessage

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

Send message to BYOND server with waiting for response.

Parameters:

byondMessage - message to send.

readTimeout - timeout time to read response.

Returns:

response from BYOND server as ByondResponse or as null, if message response type was ResponseType.NONE.

Throws:

HostUnavailableException - signals that requested server unavailable to connect. Offline or some other reason.

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

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

UnknownResponseException