org.apache.guacamole.net

Interface GuacamoleSocket

All Known Implementing Classes:

ConfiguredGuacamoleSocket, FilteredGuacamoleSocket, InetGuacamoleSocket, SSLGuacamoleSocket

public interface GuacamoleSocket

Provides abstract socket-like access to a Guacamole connection.

Author:

Michael Jumper

Method Summary

Modifier and Type	Method and Description
void	close() Releases all resources in use by the connection represented by this GuacamoleSocket.
GuacamoleReader	getReader() Returns a GuacamoleReader which can be used to read from the Guacamole instruction stream associated with the connection represented by this GuacamoleSocket.
GuacamoleWriter	getWriter() Returns a GuacamoleWriter which can be used to write to the Guacamole instruction stream associated with the connection represented by this GuacamoleSocket.
boolean	isOpen() Returns whether this GuacamoleSocket is open and can be used for reading and writing.

Method Detail

getReader

GuacamoleReader getReader()

Returns a GuacamoleReader which can be used to read from the Guacamole instruction stream associated with the connection represented by this GuacamoleSocket.

Returns:

A GuacamoleReader which can be used to read from the Guacamole instruction stream.

getWriter

GuacamoleWriter getWriter()

Returns a GuacamoleWriter which can be used to write to the Guacamole instruction stream associated with the connection represented by this GuacamoleSocket.

Returns:

A GuacamoleWriter which can be used to write to the Guacamole instruction stream.

close

void close()
    throws GuacamoleException

Releases all resources in use by the connection represented by this GuacamoleSocket.

Throws:

GuacamoleException - If an error occurs while releasing resources.

isOpen

boolean isOpen()

Returns whether this GuacamoleSocket is open and can be used for reading and writing.

Returns:

true if this GuacamoleSocket is open, false otherwise.