com.realtime.crossfire.jxclient.server.server

Class DefaultServerConnection

java.lang.Object

com.realtime.crossfire.jxclient.server.server.DefaultServerConnection

All Implemented Interfaces:

ServerConnection

public class DefaultServerConnection
extends java.lang.Object
implements ServerConnection

One of the two most important classes, ServerConnection performs most of the network-related work. It either decodes commands sent by the server itself, or delegates their processing to other classes, like Map or Faces.

Constructor Summary

Constructors

Constructor and Description
DefaultServerConnection(@NotNull GuiStateManager guiStateManager, @Nullable DebugWriter debugProtocol) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addClientSocketListener(@NotNull ClientSocketListener clientSocketListener) Adds a ClientSocketListener to notify.
void	connect(@NotNull java.lang.String hostname, int port) Attempts to connect the client to a server.
void	disconnect(@NotNull java.lang.String reason) Disconnects from the server.
void	removeClientSocketListener(@NotNull ClientSocketListener clientSocketListener) Removes a ClientSocketListener to notify.
void	start() Starts operation.
void	stop() Stops operation.
void	writePacket(byte[] packet, int length, @NotNull ClientSocketMonitorCommand monitor) Writes a Crossfire Message on the socket, so it is sent to the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultServerConnection

public DefaultServerConnection(@NotNull
                               @NotNull GuiStateManager guiStateManager,
                               @Nullable
                               @Nullable DebugWriter debugProtocol)
                        throws java.io.IOException

Creates a new instance.

Parameters:

guiStateManager - the gui state manager to update

debugProtocol - tf non-null, write all protocol commands to this writer

Throws:

java.io.IOException - if an internal error occurs

Method Detail

start

public void start()

Starts operation.

stop

public void stop()
          throws java.lang.InterruptedException

Stops operation.

Throws:

java.lang.InterruptedException - if stopping was interrupted

addClientSocketListener

public void addClientSocketListener(@NotNull
                                    @NotNull ClientSocketListener clientSocketListener)

Description copied from interface: ServerConnection

Adds a ClientSocketListener to notify.

Specified by:

addClientSocketListener in interface ServerConnection

Parameters:

clientSocketListener - the client socket listener to add

removeClientSocketListener

public void removeClientSocketListener(@NotNull
                                       @NotNull ClientSocketListener clientSocketListener)

Description copied from interface: ServerConnection

Removes a ClientSocketListener to notify.

Specified by:

removeClientSocketListener in interface ServerConnection

Parameters:

clientSocketListener - the client socket listener to remove

writePacket

public void writePacket(byte[] packet,
                        int length,
                        @NotNull
                        @NotNull ClientSocketMonitorCommand monitor)

Writes a Crossfire Message on the socket, so it is sent to the server.

Parameters:

packet - the packet to be sent; it does not include the length bytes but only actual payload data

length - the length of packet; if the array is larger, excess data is ignored

monitor - the monitor command to send to script processes

connect

public void connect(@NotNull
                    @NotNull java.lang.String hostname,
                    int port)

Description copied from interface: ServerConnection

Attempts to connect the client to a server.

Specified by:

connect in interface ServerConnection

Parameters:

hostname - the hostname to connect to

port - the port to connect to

disconnect

public void disconnect(@NotNull
                       @NotNull java.lang.String reason)

Description copied from interface: ServerConnection

Disconnects from the server. Does nothing if not connected.

Specified by:

disconnect in interface ServerConnection

Parameters:

reason - the reason for the disconnect