ucar.unidata.collab

Class Client

java.lang.Object

ucar.unidata.collab.Client

Direct Known Subclasses:

CollabClient

public class Client
extends java.lang.Object

A generic client object.

Author:

Metapps development team

Constructor Summary

Constructors

Constructor and Description
Client() Instantiates a new client.
Client(java.net.Socket socket) Instantiates a new client.
Client(java.lang.String host) Create a new Client connection, connection to the given hostname which is of the form: hostname[:optional port number].
Client(java.lang.String host, int thePort) Create a new Client connection, connection to the given hostname which is of the form: hostname[:optional port number].

Method Summary

Modifier and Type	Method and Description
void	close() _more_
void	debug(java.lang.String msg) Debug
java.lang.String	getHostname() Get the Hostname property.
boolean	getOkToReceive() Get the OkToReceive property.
boolean	getOkToSend() Get the OkToSend property.
boolean	getValid() Get the Valid property.
protected void	handleServerMessage(java.lang.String message) Handle the message rcvd from the server.
boolean	isConnectionOk() Is this client currently connected.
protected void	logException(java.lang.String msg, java.lang.Exception exc) Log exception.
static void	main(java.lang.String[] args) The main method.
protected java.lang.String	read() Read.
void	setHostname(java.lang.String value) Set the Hostname property.
void	setOkToReceive(boolean value) Set the OkToReceive property.
void	setOkToSend(boolean value) Set the OkToSend property.
void	setValid(boolean value) Set the Valid property.
java.lang.String	toString()
void	write(java.lang.String message) Write.

Methods inherited from class java.lang.Object

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

Constructor Detail

Client

public Client()

Instantiates a new client.

Client

public Client(java.lang.String host)

Create a new Client connection, connection to the given hostname which is of the form: hostname[:optional port number]. If alsoCreateServer is true then also create a server.

Parameters:

host - the host

Client

public Client(java.lang.String host,
              int thePort)

Create a new Client connection, connection to the given hostname which is of the form: hostname[:optional port number]. If alsoCreateServer is true then also create a server.

Parameters:

host - the host

thePort - the the port

Client

public Client(java.net.Socket socket)
       throws java.io.IOException

Instantiates a new client.

Parameters:

socket - the socket

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

Method Detail

debug

public void debug(java.lang.String msg)

Debug

Parameters:

msg - debug message

isConnectionOk

public boolean isConnectionOk()

Is this client currently connected.

Returns:

Is this client currently connected.

handleServerMessage

protected void handleServerMessage(java.lang.String message)

Handle the message rcvd from the server.

Parameters:

message - message from server

read

protected java.lang.String read()
                         throws java.io.IOException

Read.

Returns:

the string

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

close

public void close()

_more_

write

public void write(java.lang.String message)

Write.

Parameters:

message - the message

logException

protected void logException(java.lang.String msg,
                            java.lang.Exception exc)

Log exception.

Parameters:

msg - the msg

exc - the exc

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setHostname

public void setHostname(java.lang.String value)

Set the Hostname property.

Parameters:

value - The new value for Hostname

getHostname

public java.lang.String getHostname()

Get the Hostname property.

Returns:

The Hostname

setValid

public void setValid(boolean value)

Set the Valid property.

Parameters:

value - The new value for Valid

getValid

public boolean getValid()

Get the Valid property.

Returns:

The Valid

setOkToSend

public void setOkToSend(boolean value)

Set the OkToSend property.

Parameters:

value - The new value for OkToSend

getOkToSend

public boolean getOkToSend()

Get the OkToSend property.

Returns:

The OkToSend

setOkToReceive

public void setOkToReceive(boolean value)

Set the OkToReceive property.

Parameters:

value - The new value for OkToReceive

getOkToReceive

public boolean getOkToReceive()

Get the OkToReceive property.

Returns:

The OkToReceive

main

public static void main(java.lang.String[] args)

The main method.

Parameters:

args - the arguments