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 game server.
Because BYOND has no native REST or something like that, communication handled with Socket. BYOND game servers didn't developed to handle external communication due sockets, so while reading response data, there is no way to know where it's ended. The only way to close socket connection is during SocketTimeoutException.
Default timeout wait is 500 ms. This value can be controlled with sendMessage(ByondMessage, int) method.

Constructor Summary

Constructors

Constructor and Description
ByondClient()

Method Summary

Modifier and Type	Method and Description
static ByondClient	create() Static method to do things instead of this: ByondClient client = new ByondClient(); client.sendCommand(ByondMessage); like that: ByondClient.create().sendCommand(ByondMessage);
void	sendCommand(ByondMessage byondMessage) Send message to BYOND game server without waiting for response.
ByondResponse	sendMessage(ByondMessage byondMessage) Send message to BYOND game server with getting response.
ByondResponse	sendMessage(ByondMessage byondMessage, int readTimeout) Send message to BYOND game server with getting 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 do things instead of this:

     
         ByondClient client = new ByondClient();
         client.sendCommand(ByondMessage);
     
 

like that:

     
         ByondClient.create().sendCommand(ByondMessage);
     
 

Returns:

new ByondClient instance.

sendCommand

public void sendCommand(ByondMessage byondMessage)
                 throws HostUnavailableException

Send message to BYOND game 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

Send message to BYOND game server with getting response. Similar to sendMessage(ByondMessage, int) but second argument, which is read timeout time, taken by default as 500 ms.

Parameters:

byondMessage - mesasge to send.

Returns:

response from BYOND game 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. Reason could hide in BYOND game server itself. Typical, it doesn't handle message which was send and, as a result, not provide any response.

sendMessage

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

Send message to BYOND game server with getting response.

Parameters:

byondMessage - message to send.

readTimeout - timeout time to read response.

Returns:

response from BYOND game 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. Reason could hide in BYOND game server itself. Typical, it doesn't handle message which was send and, as result, not provide any response.