com.realtime.crossfire.jxclient.server.socket

Class ClientSocket

java.lang.Object

com.realtime.crossfire.jxclient.server.socket.ClientSocket

public class ClientSocket
extends java.lang.Object

A socket that processes incoming data.

 final ClientSocket clientSocket = new ClientSocket(...);
 clientSocket.writePacket(...);
 clientSocket.disconnect();
 

Constructor Summary

Constructors

Constructor and Description
ClientSocket(@NotNull Model model, @Nullable com.realtime.crossfire.jxclient.util.DebugWriter debugProtocol) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addClientSocketListener(@NotNull ClientSocketListener clientSocketListener) Adds a ClientSocketListener to be notified.
void	connect(@NotNull java.lang.String host, int port) Connects to a server.
void	disconnect(@NotNull java.lang.String reason, boolean isError) Terminates the connection.
void	removeClientSocketListener(@NotNull ClientSocketListener clientSocketListener) Removes a ClientSocketListener to be notified.
void	start() Starts operation.
void	stop() Stops operation.
void	writePacket(byte[] buf, int len, @NotNull ClientSocketMonitorCommand monitor) Writes a packet.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientSocket

public ClientSocket(@NotNull
                    @NotNull Model model,
                    @Nullable
                    @Nullable com.realtime.crossfire.jxclient.util.DebugWriter debugProtocol)
             throws java.io.IOException

Creates a new instance.

Parameters:

model - the model to update

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

Throws:

java.io.IOException - if the socket cannot be created

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)

Adds a ClientSocketListener to be notified.

Parameters:

clientSocketListener - the client socket listener to add

removeClientSocketListener

public void removeClientSocketListener(@NotNull
                                       @NotNull ClientSocketListener clientSocketListener)

Removes a ClientSocketListener to be notified.

Parameters:

clientSocketListener - the client socket listener to remove

connect

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

Connects to a server. Disconnects an existing connection if necessary.

Parameters:

host - the host to connect to

port - the port to connect to

disconnect

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

Terminates the connection. Does nothing if not connected.

Parameters:

reason - the reason for the disconnect

isError - whether the disconnect is unexpected

writePacket

public void writePacket(byte[] buf,
                        int len,
                        @NotNull
                        @NotNull ClientSocketMonitorCommand monitor)

Writes a packet. The packet contents must not change until this function has returned.

This function may be called even if the socket has been closed. In this case he packet is discarded.

Parameters:

buf - the packet to send

len - the number of bytes to send

monitor - the monitor command to send to script processes