com.sun.grizzly.filter
Interface Client

All Known Implementing Classes:

CustomProtocolClient

public interface Client

Client API for communicating with aServer.

Version:

1.0

Author:

John Vieten 16.09.2008

Method Summary

RemoteCall	callRemote() If callers want to make a method call to an server.
void	connect(java.net.InetSocketAddress address) Used to build up a connection to a server.
void	connect(java.net.InetSocketAddress address, java.net.InetSocketAddress proxy, java.lang.String userAgent, java.lang.String userName, java.lang.String pass) Used to build up a connection to a server over an proxy.
java.io.OutputStream	getOutputStream()
void	onMessageError(java.lang.String errorMsg) Gets called if some protocol sepecific error happens.
void	service(java.io.InputStream inputStream, java.io.OutputStream outputStream) An client can also be called by an server.
void	setIoExceptionHandler(IOExceptionHandler ioExceptionHandler)
void	start() Setup and starts the client
void	stop() Stops client

Method Detail

callRemote

RemoteCall callRemote()
                      throws java.io.IOException

If callers want to make a method call to an server.

Returns:

RemoteCall which gives caller a OutputStream for writing to server and an InputStream for getting the servers's reply

Throws:

java.io.IOException

getOutputStream

java.io.OutputStream getOutputStream()

Returns:

OutputStream for writing to server

service

void service(java.io.InputStream inputStream,
             java.io.OutputStream outputStream)

An client can also be called by an server.

Parameters:

inputStream - containing the server bytes

outputStream - client can reply to server's message

onMessageError

void onMessageError(java.lang.String errorMsg)

Gets called if some protocol sepecific error happens.

Parameters:

errorMsg -

connect

void connect(java.net.InetSocketAddress address)
             throws java.io.IOException

Used to build up a connection to a server. Method start() must have been called before.

Parameters:

address - server address

Throws:

java.io.IOException

connect

void connect(java.net.InetSocketAddress address,
             java.net.InetSocketAddress proxy,
             java.lang.String userAgent,
             java.lang.String userName,
             java.lang.String pass)
             throws java.io.IOException

Used to build up a connection to a server over an proxy. Method start() must have been called before.

Parameters:

address - server address

proxy - address

userAgent - proxy agent identifier

userName - if proxy needs authentification (otherwise null)

pass - if proxy needs authentification (otherwise null)

Throws:

java.io.IOException

start

void start()
           throws java.lang.Exception

Setup and starts the client

Throws:

java.lang.Exception

stop

void stop()
          throws java.lang.Exception

Stops client

Throws:

java.lang.Exception

setIoExceptionHandler

void setIoExceptionHandler(IOExceptionHandler ioExceptionHandler)