A B C D E F G H I K M N O P R S T U _

A

addCommand(Command) - Method in class com.msi.network.server.CommandProcessor

Adds the specified command to the end of the list.

adminServer - Static variable in class com.msi.network.server.adminTCPServer

Describe variable adminServer here.

adminTCPServer - class com.msi.network.server.adminTCPServer.

The adminTCPServer is a TCPServer that contains another TCPServer.

adminTCPServer(int, int) - Constructor for class com.msi.network.server.adminTCPServer

Set up the internal state and startup using the given port.

B

backlog - Variable in class com.msi.network.connection.TCPInterface

builders - Static variable in class com.msi.network.server.RHFactory

C

Command - class com.msi.network.server.Command.

Defines the common API for server commands.

Command(String) - Constructor for class com.msi.network.server.Command

Set the minimum required state for command execution.

CommandProcessor - class com.msi.network.server.CommandProcessor.

Control the flow of processing server commands.

CommandProcessor() - Constructor for class com.msi.network.server.CommandProcessor

ConnGetlineException - exception com.msi.network.connection.ConnGetlineException.

ConnGetlineException - error when reading from a connection.

ConnGetlineException() - Constructor for class com.msi.network.connection.ConnGetlineException

Creates a new ConnGetlineException instance.

ConnGetlineException(String) - Constructor for class com.msi.network.connection.ConnGetlineException

Creates a new ConnGetlineException instance.

ConnGetlineException(String, Throwable) - Constructor for class com.msi.network.connection.ConnGetlineException

Creates a new ConnGetlineException instance.

ConnGetlineException(Throwable) - Constructor for class com.msi.network.connection.ConnGetlineException

Creates a new ConnGetlineException instance.

ConnPutlineException - exception com.msi.network.connection.ConnPutlineException.

ConnPutlineException - error writing to connection.

ConnPutlineException() - Constructor for class com.msi.network.connection.ConnPutlineException

Creates a new ConnPutlineException instance.

ConnPutlineException(String) - Constructor for class com.msi.network.connection.ConnPutlineException

Creates a new ConnPutlineException instance.

ConnPutlineException(String, Throwable) - Constructor for class com.msi.network.connection.ConnPutlineException

Creates a new ConnPutlineException instance.

ConnPutlineException(Throwable) - Constructor for class com.msi.network.connection.ConnPutlineException

Creates a new ConnPutlineException instance.

ConnReadTOException - exception com.msi.network.connection.ConnReadTOException.

ConnReadTOException - error when reading from a connection.

ConnReadTOException() - Constructor for class com.msi.network.connection.ConnReadTOException

Creates a new ConnReadTOException instance.

ConnReadTOException(String) - Constructor for class com.msi.network.connection.ConnReadTOException

Creates a new ConnReadTOException instance.

ConnReadTOException(String, Throwable) - Constructor for class com.msi.network.connection.ConnReadTOException

Creates a new ConnReadTOException instance.

ConnReadTOException(Throwable) - Constructor for class com.msi.network.connection.ConnReadTOException

Creates a new ConnReadTOException instance.

Connection - interface com.msi.network.connection.Connection.

Defines the methods necessary to communicate over the ServiceInterface with the client.

ConnectionConstants - interface com.msi.network.connection.ConnectionConstants.

ConnectionException - exception com.msi.network.connection.ConnectionException.

Base exception for all Connection errors.

ConnectionException() - Constructor for class com.msi.network.connection.ConnectionException

Creates a new ConnectionException instance.

ConnectionException(String) - Constructor for class com.msi.network.connection.ConnectionException

Creates a new ConnectionException instance.

ConnectionException(String, Throwable) - Constructor for class com.msi.network.connection.ConnectionException

Creates a new ConnectionException instance.

ConnectionException(Throwable) - Constructor for class com.msi.network.connection.ConnectionException

Creates a new ConnectionException instance.

clientAddress - Variable in class com.msi.network.connection.TCPConnection

clientConnection - interface com.msi.network.connection.clientConnection.

Defines the methods necessary to communicate as a client with a server via TCP or UDP (subclassed).

clientPort - Variable in class com.msi.network.connection.TCPConnection

clientServer - Static variable in class com.msi.network.server.adminTCPServer

Describe variable clientServer here.

clientTCPConnection - class com.msi.network.connection.clientTCPConnection.

Describe class clientTCPConnection here.

clientTCPConnection(InetAddress, int) - Constructor for class com.msi.network.connection.clientTCPConnection

Opens a connection to the specified system and port combination.

close() - Method in interface com.msi.network.connection.Connection

Shut down cleanly.

close() - Method in interface com.msi.network.connection.ServiceInterface

Shut down cleanly.

close() - Method in class com.msi.network.connection.TCPConnection

Close the connection freeing any system resources.

close() - Method in class com.msi.network.connection.TCPInterface

close -

close() - Method in interface com.msi.network.connection.clientConnection

Shut down cleanly.

close() - Method in class com.msi.network.connection.clientTCPConnection

Close out the connection to the server and free any system resources.

com.msi.network.connection - package com.msi.network.connection

com.msi.network.server - package com.msi.network.server

conn - Variable in class com.msi.network.connection.TCPConnection

conn - Socket that is connected to the client.

conn - Variable in class com.msi.network.server.RequestHandler

conn - connection this RequestHandler uses for client communication.

connTO - Variable in class com.msi.network.connection.TCPConnection

connTO - Variable in class com.msi.network.connection.TCPInterface

connectionClosed() - Method in class com.msi.network.connection.TCPInterface

closeConnection - close the previously allocated connection, adjusting the number of openConnections accordingly.

D

defaultBacklog - Static variable in interface com.msi.network.connection.ConnectionConstants

defaultBacklog - default value for low level communications queueing of new request(or)s.

defaultMaxConnections - Static variable in interface com.msi.network.connection.ConnectionConstants

defaultMaxConnections - max connections allowed on an interface.

defaultMaxServers - Static variable in interface com.msi.network.server.ServerConstants

defaultMaxServers - maximum number of servers before holding off requests.

destination - Variable in class com.msi.network.connection.clientTCPConnection

E

endsWith(String, String) - Method in class com.msi.network.connection.TCPConnection

Check in a case insensitive manner that the supplied string ends with the suffix.

exceptionName - Static variable in class com.msi.network.connection.ConnGetlineException

exceptionName - Static variable in class com.msi.network.connection.ConnReadTOException

F

finalize() - Method in class com.msi.network.connection.clientTCPConnection

Make sure we close the connection if anything bad happens.

finalize() - Method in class com.msi.network.server.TCPServer

Describe finalize method here.

G

getAdminServer() - Static method in class com.msi.network.server.adminTCPServer

Allow access to the admin server.

getBacklog() - Method in class com.msi.network.connection.TCPInterface

Get the value of backlog.

getClientAddress() - Method in interface com.msi.network.connection.Connection

Provide the client internet address.

getClientAddress() - Method in class com.msi.network.connection.TCPConnection

Describe getClientAddress method here.

getClientPort() - Method in interface com.msi.network.connection.Connection

Provide the client port.

getClientPort() - Method in class com.msi.network.connection.TCPConnection

Describe getClientPort method here.

getClientServer() - Static method in class com.msi.network.server.adminTCPServer

Allow access to the client server.

getCommandHelp() - Method in class com.msi.network.server.CommandProcessor

Scan the list of commands retrieving each help string.

getConnTO() - Method in class com.msi.network.connection.TCPConnection

Get the value of connTO.

getConnTO() - Method in class com.msi.network.connection.TCPInterface

Get the value of connTO.

getConnection() - Method in interface com.msi.network.connection.ServiceInterface

Retrieve a valid connection.

getConnection() - Method in class com.msi.network.connection.TCPInterface

getConnection -

getHello() - Method in class com.msi.network.server.CommandProcessor

Get the value of hello.

getLine() - Method in interface com.msi.network.connection.Connection

Reads from the low level communications channel.

getLine(long) - Method in interface com.msi.network.connection.Connection

Reads from the low level communications channel timing out after the specified time.

getLine() - Method in class com.msi.network.connection.TCPConnection

Read what the client has to write, stripping any leading whitespace and dropping the eol marker(s).

getLine(long) - Method in class com.msi.network.connection.TCPConnection

Read what the client has to write, stripping any leading whitespace and dropping the eol marker(s).

getLine() - Method in interface com.msi.network.connection.clientConnection

Reads from the low level communications channel.

getLine() - Method in class com.msi.network.connection.clientTCPConnection

Gets a line of output from the TCP/IP server.

getMaxConnections() - Method in class com.msi.network.connection.TCPInterface

Gets the value of maxConnections

getMaxServers() - Method in class com.msi.network.server.TCPServer

Get the value of maxServers.

getNoCommand() - Method in class com.msi.network.server.CommandProcessor

Get the value of noCommand.

getOpenConnections() - Method in class com.msi.network.connection.TCPInterface

Gets the value of openConnections

getPort() - Method in class com.msi.network.connection.TCPInterface

Gets the value of port

getReadTO() - Method in class com.msi.network.server.CommandProcessor

Get the value of readTO.

getRequestHandler(int) - Static method in class com.msi.network.server.RHFactory

The server uses this method to create a the requestHandler needed to service client requests on the specified port.

getResponse() - Method in class com.msi.network.server.Command

Get the value of _response.

getServerPort() - Method in interface com.msi.network.connection.Connection

Provide the server port often used as ID.

getServerPort() - Method in class com.msi.network.connection.TCPConnection

Describe getServerPort method here.

getServerPort() - Method in interface com.msi.network.connection.clientConnection

Provide the server port often used as ID.

getServerPort() - Method in class com.msi.network.connection.clientTCPConnection

Return the server port associated with this connection.

getSock() - Method in class com.msi.network.connection.TCPInterface

Gets the value of sock

H

hello - Variable in class com.msi.network.server.CommandProcessor

When a client connects, this String is returned.

I

init() - Method in interface com.msi.network.connection.Connection

Make sure everything is set up and ready to run.

init() - Method in class com.msi.network.connection.TCPConnection

Create a connection and set up the input stream

insertCommand(Command) - Method in class com.msi.network.server.CommandProcessor

Insert the specified command at the beginning of the list.

instream - Variable in class com.msi.network.connection.TCPConnection

instream -

interfaceController - Variable in class com.msi.network.connection.TCPConnection

isIsSSL() - Method in class com.msi.network.connection.TCPInterface

Get the value of isSSL.

isIsSSL() - Method in class com.msi.network.server.TCPServer

Get the value of isSSL.

isLast() - Method in class com.msi.network.server.Command

When a command terminates a client session true is returned.

isOnLine() - Method in class com.msi.network.server.TCPServer

Return the current value of the onLine status.

isSSL - Variable in class com.msi.network.connection.TCPInterface

isSSL - Variable in class com.msi.network.server.TCPServer

isSSL indicates/controls whether this is an SSL (secure) or non-SSL server.

isValid() - Method in class com.msi.network.server.Command

Verifies the client supplied information against this command.

K

kicker - Variable in class com.msi.network.server.TCPServer

kicker - thread management.

M

makeServerSocket(int, int, boolean) - Method in class com.msi.network.connection.TCPInterface

maxConnections - Variable in class com.msi.network.connection.TCPInterface

maxServers - Variable in class com.msi.network.server.TCPServer

maxServers - maximum before holding off on requests

N

newRH() - Method in interface com.msi.network.server.RHBuilder

Part of the application that creates and initializes a request handler for the server.

noCommand - Variable in class com.msi.network.server.CommandProcessor

If the client sends an unsupported command, this String is returned.

O

onLine - Variable in class com.msi.network.server.TCPServer

openConnections - Variable in class com.msi.network.connection.TCPInterface

P

port - Variable in class com.msi.network.connection.TCPInterface

port - Variable in class com.msi.network.connection.clientTCPConnection

port - Variable in class com.msi.network.server.TCPServer

port - for the interface.

processCommand(String, Connection, CommandProcessor) - Method in class com.msi.network.server.Command

Set the command, and if it is valid do the right thing.

processCommand(Connection) - Method in class com.msi.network.server.Command

To be over-ridden in the sub-class implementing the specific command.

processRequest() - Method in class com.msi.network.server.CommandProcessor

Read a client command line and step through the command array.

processRequest() - Method in class com.msi.network.server.RequestHandler

This method is the entry point for the server to request an operation be performed by the application on behalf of the client.

putLine(String) - Method in interface com.msi.network.connection.Connection

Sends a single line back to the client.

putLine(String, InetAddress, int) - Method in interface com.msi.network.connection.Connection

Sends a single line back to the client.

putLine(String) - Method in class com.msi.network.connection.TCPConnection

Send information back to the client one line at a time.

putLine(String, InetAddress, int) - Method in class com.msi.network.connection.TCPConnection

This supports external submission of the recipient address, which allows us to send datagrams to multiple clients across a single port.

putLine(String) - Method in interface com.msi.network.connection.clientConnection

Sends a single line back to the client.

putLine(String) - Method in class com.msi.network.connection.clientTCPConnection

Send a line to the server.

R

RHBuilder - interface com.msi.network.server.RHBuilder.

This defines the methods necessary for a request handler builder that can be used by the request handler factory.

RHConnectionException - exception com.msi.network.server.RHConnectionException.

An RHConnectionException is thrown when a requestHandler connection is null or a non-read, non-write error occurs.

RHConnectionException() - Constructor for class com.msi.network.server.RHConnectionException

Creates a new RHConnectionException instance.

RHConnectionException(String) - Constructor for class com.msi.network.server.RHConnectionException

Creates a new RHConnectionException instance.

RHConnectionException(String, Throwable) - Constructor for class com.msi.network.server.RHConnectionException

Creates a new RHConnectionException instance.

RHConnectionException(Throwable) - Constructor for class com.msi.network.server.RHConnectionException

Creates a new RHConnectionException instance.

RHException - exception com.msi.network.server.RHException.

Base exception for all RequestHandler errors.

RHException() - Constructor for class com.msi.network.server.RHException

Creates a new RHException instance.

RHException(String) - Constructor for class com.msi.network.server.RHException

Creates a new RHException instance.

RHException(String, Throwable) - Constructor for class com.msi.network.server.RHException

Creates a new RHException instance.

RHException(Throwable) - Constructor for class com.msi.network.server.RHException

Creates a new RHException instance.

RHFactory - class com.msi.network.server.RHFactory.

This is a gateway class that allows the application to register a capability for a requesthandler object to be constructed and for a requesthandler based server to create these application requesthandlers as needed.

RHFactory() - Constructor for class com.msi.network.server.RHFactory

RHReadException - exception com.msi.network.server.RHReadException.

An RHReadException is thrown when a requestHandler cannot read the connection.

RHReadException() - Constructor for class com.msi.network.server.RHReadException

Creates a new RHReadException instance.

RHReadException(String) - Constructor for class com.msi.network.server.RHReadException

Creates a new RHReadException instance.

RHReadException(String, Throwable) - Constructor for class com.msi.network.server.RHReadException

Creates a new RHReadException instance.

RHReadException(Throwable) - Constructor for class com.msi.network.server.RHReadException

Creates a new RHReadException instance.

RHWriteException - exception com.msi.network.server.RHWriteException.

An RHWriteException is thrown when a requestHandler cannot write the connection.

RHWriteException() - Constructor for class com.msi.network.server.RHWriteException

Creates a new RHWriteException instance.

RHWriteException(String) - Constructor for class com.msi.network.server.RHWriteException

Creates a new RHWriteException instance.

RHWriteException(String, Throwable) - Constructor for class com.msi.network.server.RHWriteException

Creates a new RHWriteException instance.

RHWriteException(Throwable) - Constructor for class com.msi.network.server.RHWriteException

Creates a new RHWriteException instance.

RequestHandler - class com.msi.network.server.RequestHandler.

A request handler provides a single method for servicing a request and providing a response.

RequestHandler() - Constructor for class com.msi.network.server.RequestHandler

read(byte[], long) - Method in interface com.msi.network.connection.Connection

Read an array-full of data timing out in the specified period.

read(byte[]) - Method in interface com.msi.network.connection.Connection

Read an array-full of data.

read(byte[], long) - Method in class com.msi.network.connection.TCPConnection

Reads all the client input regardless of line breaks.

read(byte[]) - Method in class com.msi.network.connection.TCPConnection

Reads all the client input regardless of line breaks.

readTO - Variable in class com.msi.network.server.CommandProcessor

Milliseconds to wait before closing the connection.

registerBuilder(RHBuilder, int) - Static method in class com.msi.network.server.RHFactory

The application uses this method to register its requesthandler builders with the factory.

reset() - Method in interface com.msi.network.connection.Connection

Flush, close and re-init.

reset() - Method in class com.msi.network.connection.TCPConnection

reset -

run() - Method in class com.msi.network.server.RequestHandler

Main processing loop for a command session.

run() - Method in class com.msi.network.server.TCPServer

Main control loop of the thread, calls runServer to perform the actual server operations.

runServer(Connection) - Method in class com.msi.network.server.TCPServer

Create a new requestHandler thread passing the connection and start the thread.

S

ServerConstants - interface com.msi.network.server.ServerConstants.

ServiceInterface - interface com.msi.network.connection.ServiceInterface.

Models the interface used by the server to field client requests.

serverPort - Variable in class com.msi.network.connection.TCPConnection

serverSamplePeriod - Static variable in interface com.msi.network.server.ServerConstants

serverSamplePeriod - millis to sleep between attempts/checks.

setBacklog(int) - Method in class com.msi.network.connection.TCPInterface

Set the value of backlog.

setConnTO(long) - Method in class com.msi.network.connection.TCPConnection

Set the value of connTO.

setConnTO(long) - Method in class com.msi.network.connection.TCPInterface

Set the value of connTO.

setConnection(Connection) - Method in class com.msi.network.server.RequestHandler

Set up the connection for this client/server session.

setHello(String) - Method in class com.msi.network.server.CommandProcessor

Set the value of hello.

setIsSSL(boolean) - Method in class com.msi.network.connection.TCPInterface

Set the value of isSSL.

setIsSSL(boolean) - Method in class com.msi.network.server.TCPServer

Set the value of isSSL.

setMaxConnections(int) - Method in class com.msi.network.connection.TCPInterface

Sets the value of maxConnections

setMaxServers(int) - Method in class com.msi.network.server.TCPServer

Set the value of maxServers.

setNoCommand(String) - Method in class com.msi.network.server.CommandProcessor

Set the value of noCommand.

setOnLine(boolean) - Method in class com.msi.network.server.TCPServer

Set the value of the online status.

setOpenConnections(int) - Method in class com.msi.network.connection.TCPInterface

Sets the value of openConnections

setPort(int) - Method in class com.msi.network.connection.TCPInterface

Sets the value of port

setReadTO(long) - Method in class com.msi.network.server.CommandProcessor

Set the value of readTO.

setResponse(String) - Method in class com.msi.network.server.Command

Set the value of _response.

setSock(ServerSocket) - Method in class com.msi.network.connection.TCPInterface

Sets the value of sock

sock - Variable in class com.msi.network.connection.TCPInterface

start() - Method in class com.msi.network.server.TCPServer

Spawn a thread if needed and open the server socket.

statsString() - Method in class com.msi.network.connection.TCPInterface

statsString - present the current state as a String.

statsString() - Method in class com.msi.network.server.TCPServer

statsString - present the current state as a String.

stop() - Method in class com.msi.network.server.TCPServer

Cleanup and shutdown.

T

TCP - Static variable in interface com.msi.network.connection.ServiceInterface

Describe constant TCP here.

TCPConnection - class com.msi.network.connection.TCPConnection.

TCPConnection - a TCP/IP socket connection.

TCPConnection(ServerSocket, TCPInterface) - Constructor for class com.msi.network.connection.TCPConnection

Creates a new TCPConnection instance.

TCPConnection(ServerSocket, TCPInterface, long) - Constructor for class com.msi.network.connection.TCPConnection

Creates a new TCPConnection instance.

TCPInterface - class com.msi.network.connection.TCPInterface.

A ServiceInterface support the TCP/IP protocol.

TCPInterface() - Constructor for class com.msi.network.connection.TCPInterface

TCPInterface(int, int) - Constructor for class com.msi.network.connection.TCPInterface

TCPInterface -

TCPInterface(int, int, boolean) - Constructor for class com.msi.network.connection.TCPInterface

Creates a new TCPInterface instance.

TCPInterface(int, int, long) - Constructor for class com.msi.network.connection.TCPInterface

TCPInterface -

TCPInterface(int, int, long, boolean) - Constructor for class com.msi.network.connection.TCPInterface

Creates a new TCPInterface instance.

TCPServer - class com.msi.network.server.TCPServer.

TCPServer implements a multi-threaded ServerSocket based server.

TCPServer() - Constructor for class com.msi.network.server.TCPServer

Creates a new TCPServer instance.

TCPServer(int) - Constructor for class com.msi.network.server.TCPServer

Set up the internal state.

TCPServer(int, boolean) - Constructor for class com.msi.network.server.TCPServer

Creates a new TCPServer instance.

TCPServer(int, int) - Constructor for class com.msi.network.server.TCPServer

Creates a new TCPServer instance.

TCPServer(int, int, boolean) - Constructor for class com.msi.network.server.TCPServer

Creates a new TCPServer instance.

TCPServer(int, int, long) - Constructor for class com.msi.network.server.TCPServer

Creates a new TCPServer instance.

TCPServer(int, int, long, boolean) - Constructor for class com.msi.network.server.TCPServer

Creates a new TCPServer instance.

TCPif - Variable in class com.msi.network.server.TCPServer

TCPif - communications channel to client.

toString() - Method in class com.msi.network.server.CommandProcessor

Provide a debug string.

U

UDP - Static variable in interface com.msi.network.connection.ServiceInterface

Describe constant UDP here.

usage() - Method in class com.msi.network.server.Command

Provide a description of the Request Handler syntax and usage.

_

_cSock - Variable in class com.msi.network.connection.clientTCPConnection

_commandInput - Variable in class com.msi.network.server.Command

Describe variable _commandInput here.

_commandProcessor - Variable in class com.msi.network.server.Command

Describe variable _commandProcessor here.

_commands - Variable in class com.msi.network.server.CommandProcessor

Describe variable _commands here.

_in - Variable in class com.msi.network.connection.clientTCPConnection

_name - Variable in class com.msi.network.server.Command

Each command has a unique string name.

_out - Variable in class com.msi.network.connection.clientTCPConnection

_response - Variable in class com.msi.network.server.Command

The response sent to the client including all punctuation.

_tokes - Variable in class com.msi.network.server.Command

Describe variable _tokes here.

A B C D E F G H I K M N O P R S T U _