Index (eu.ill:webx-relay 1.0.0 API)

B C D E F G H I M O P R S T V W
All Classes and Interfaces|All Packages|Serialized Form

B

bytes() - Method in class eu.ill.webx.model.SessionId: Returns the raw binary session Id

C

cleanupSessions() - Method in class eu.ill.webx.relay.WebXHost: Ensures that there are no empty sessions
ClientConnector - Class in eu.ill.webx.transport: The ClientConnector provides an interface to the REP-REQ ZMQ socket to make requests to the WebX Router or Engine.
clientId() - Method in record class eu.ill.webx.model.ClientIdentifier: Returns the value of the clientId record component.
ClientIdentifier - Record Class in eu.ill.webx.model: Encapsulates data representing a unique client in a WebX Engine
ClientIdentifier(long, int) - Constructor for record class eu.ill.webx.model.ClientIdentifier: Creates an instance of a ClientIdentifier record class.
clientIdString() - Method in record class eu.ill.webx.model.ClientIdentifier: Returns a hex representation of the client Id
clientIndex() - Method in record class eu.ill.webx.model.ClientIdentifier: Returns the value of the clientIndex record component.
clientIndexString() - Method in record class eu.ill.webx.model.ClientIdentifier: Returns the hex representation of the client Index
CLOSE - Enum constant in enum class eu.ill.webx.model.Message.Type: A Close message (used internally)
CloseMessage() - Constructor for class eu.ill.webx.model.Message.CloseMessage: Default constructor
compareTo(Message) - Method in class eu.ill.webx.model.Message: Comparison function.
connect(WebXHostConfiguration, WebXClientConfiguration) - Method in class eu.ill.webx.WebXTunnel: Connects to a WebX Engine on a specific host/port and connects the client to a WebX Session.
connect(String, int, int, boolean, MessageSubscriber.MessageHandler) - Method in class eu.ill.webx.transport.Transport: Starts the connection to the different ZQM sockets of the server.
Connect(WebXHostConfiguration, WebXClientConfiguration) - Static method in class eu.ill.webx.WebXTunnel: Static method to create a WebXTunnel, connect to the host and create a client.
ConnectionData - Record Class in eu.ill.webx.model: Encapsulates connection data returned by the client connector and used to connect all the sockets.
ConnectionData(int, int) - Constructor for record class eu.ill.webx.model.ConnectionData: Returned from a standalone WebX Engine with the ports of the publisher and subscriber sockets
ConnectionData(int, int, int, String) - Constructor for record class eu.ill.webx.model.ConnectionData: Creates an instance of a ConnectionData record class.
connectToHost(WebXHostConfiguration) - Method in class eu.ill.webx.relay.WebXRelay: Connects to a WebX Host (if a connection hasn't already been made).
createClient(ClientIdentifier) - Method in class eu.ill.webx.relay.WebXSession: Creates a new WebXClient object with a unique Client Identifier and adds it to the clients list.
CURSOR - Enum constant in enum class eu.ill.webx.model.Message.Type: A cursor message

D

data() - Method in record class eu.ill.webx.model.SocketResponse: Returns the value of the data record component.
disconnect() - Method in class eu.ill.webx.transport.Transport: Disconnects all ZMQ sockets and waits for any associated threads to terminate.
disconnect() - Method in class eu.ill.webx.WebXTunnel: Disconnects the client from the WebX Session: message sent to the WebX Engine do disconnect the client.
DISCONNECT - Enum constant in enum class eu.ill.webx.model.Message.Type: A disconnect message

E

equals(Object) - Method in record class eu.ill.webx.model.ClientIdentifier: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class eu.ill.webx.model.ConnectionData: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class eu.ill.webx.model.SessionId: Equality comparison comparing the upper and lower long values of the session Id
equals(Object) - Method in record class eu.ill.webx.model.SocketResponse: Indicates whether some other object is "equal to" this one.
eu.ill.webx - package eu.ill.webx
eu.ill.webx.exceptions - package eu.ill.webx.exceptions
eu.ill.webx.model - package eu.ill.webx.model
eu.ill.webx.relay - package eu.ill.webx.relay
eu.ill.webx.transport - package eu.ill.webx.transport
eu.ill.webx.utils - package eu.ill.webx.utils

F

ForExistingSession(String) - Static method in class eu.ill.webx.WebXClientConfiguration: Returns a configuration containing a sessionId.
ForLogin(String, String) - Static method in class eu.ill.webx.WebXClientConfiguration: Returns a configuration containing login details default screen size (1920x1024) and keyboard layout ("gb") are used.
ForLogin(String, String, Integer, Integer) - Static method in class eu.ill.webx.WebXClientConfiguration: Returns a configuration containing login details, screen size.
ForLogin(String, String, Integer, Integer, String) - Static method in class eu.ill.webx.WebXClientConfiguration: Returns a configuration containing login details, screen size and keyboard layout.
ForStandaloneSession() - Static method in class eu.ill.webx.WebXClientConfiguration: Returns a configuration for a standalone session.
fromByteArray(byte[]) - Static method in class eu.ill.webx.utils.HexString: Converts byte data to hex string
fromByteArray(byte[], int) - Static method in class eu.ill.webx.utils.HexString: Converts byte data to hex string using a maximum length of the data

G

getClientCount() - Method in class eu.ill.webx.relay.WebXHost: Returns the total number of clients connected
getClientCount() - Method in class eu.ill.webx.relay.WebXSession: Returns the number of connected clients to the session
getClientIdentifier() - Method in class eu.ill.webx.relay.WebXClient: Returns the client identifier
getConnectionId() - Method in class eu.ill.webx.WebXTunnel: Returns the connection Id of the client: corresponds to the session Id of the WebX Engine
getData() - Method in class eu.ill.webx.model.Message: Returns the raw data
getHostname() - Method in class eu.ill.webx.relay.WebXHost: Returns the hostname
getHostname() - Method in class eu.ill.webx.WebXHostConfiguration: Returns the hostname
getInstance() - Static method in class eu.ill.webx.relay.WebXRelay: Returns the singleton instance
getKeyboardLayout() - Method in class eu.ill.webx.WebXClientConfiguration: Returns the keyboard layout
getMessage() - Method in class eu.ill.webx.relay.WebXClient: Blocking method, waiting for a message to be sent from the server.
getPassword() - Method in class eu.ill.webx.WebXClientConfiguration: Returns the password
getPort() - Method in class eu.ill.webx.relay.WebXHost: Returns the principal (client connector) port of the host
getPort() - Method in class eu.ill.webx.WebXHostConfiguration: Returns the connector port
getScreenHeight() - Method in class eu.ill.webx.WebXClientConfiguration: Returns the screen height
getScreenWidth() - Method in class eu.ill.webx.WebXClientConfiguration: Returns the screen width
getSessionId() - Method in class eu.ill.webx.relay.WebXClient: Returns the session Id
getSessionId() - Method in class eu.ill.webx.relay.WebXSession: Returns the session Id
getSessionId() - Method in class eu.ill.webx.WebXClientConfiguration: Returns the session Id
getSocketTimeoutMs() - Method in class eu.ill.webx.WebXHostConfiguration: Returns the socket timeout in milliseconds
getStringData() - Method in class eu.ill.webx.model.Message: Returns the data as a string
getType() - Method in class eu.ill.webx.model.Message: Returns the message type
getUsername() - Method in class eu.ill.webx.WebXClientConfiguration: Returns the username

H

hashCode() - Method in record class eu.ill.webx.model.ClientIdentifier: Returns a hash code value for this object.
hashCode() - Method in record class eu.ill.webx.model.ConnectionData: Returns a hash code value for this object.
hashCode() - Method in class eu.ill.webx.model.SessionId: Returns the hashcode of the session Id generated from the lower and upper long values
hashCode() - Method in record class eu.ill.webx.model.SocketResponse: Returns a hash code value for this object.
hexString() - Method in class eu.ill.webx.model.SessionId: Returns the hex representation of the session Id
HexString - Class in eu.ill.webx.utils: Utility class to convert binary bytearrays into hexadecimal strings and vice versa.
HexString() - Constructor for class eu.ill.webx.utils.HexString: Default constructor

I

InstructionPublisher - Class in eu.ill.webx.transport: The instruction publisher publishes instructions asynchronously to the WebX Engine (passing by the router if not in standalone).
interrupt() - Method in class eu.ill.webx.relay.WebXSessionValidator: Interrupts the session validator thread
INTERRUPT - Enum constant in enum class eu.ill.webx.model.Message.Type: An interrupt message (used internally)
InterruptMessage(String) - Constructor for class eu.ill.webx.model.Message.InterruptMessage: Constructor with a message on why the interrupt is generated
isConnected() - Method in class eu.ill.webx.relay.WebXClient: Returns true if state is connected
isConnected() - Method in class eu.ill.webx.transport.Transport: Returns true if connected
isConnected() - Method in class eu.ill.webx.WebXTunnel: Returns true if the client is connected
isRunning() - Method in class eu.ill.webx.relay.WebXSessionValidator: Returns true when running
isStandalone() - Method in class eu.ill.webx.WebXHostConfiguration: Returns true if the relay is running in standalone mode

M

Message - Class in eu.ill.webx.model: Encapsulates the raw binary message data from a WebX Engine.
Message(byte[]) - Constructor for class eu.ill.webx.model.Message: The public constructor of a Message taking raw message data.
Message.CloseMessage - Class in eu.ill.webx.model: Creates a Close message (used internally)
Message.InterruptMessage - Class in eu.ill.webx.model: Creates a Interrupt message (used internally)
Message.Type - Enum Class in eu.ill.webx.model: Enum defining the type of the message
MessageSubscriber - Class in eu.ill.webx.transport: The message subscriber connects to the ZMQ message publisher of the WebX Router (or Engine if in standalone) and forwards them immediately to a handler (managed in the WebXHost).
MessageSubscriber.MessageHandler - Interface in eu.ill.webx.transport: Interface used to handle the callback when a message arrives
MOUSE - Enum constant in enum class eu.ill.webx.model.Message.Type: A mouse movement message

O

onClientConnection(WebXClientConfiguration) - Method in class eu.ill.webx.relay.WebXHost: Called when a client connects.
onClientDisconnect(WebXHost) - Method in class eu.ill.webx.relay.WebXRelay: Called when a client disconnects so that we can perform cleanup operations (close the host connection if no clients are connected)
onClientDisconnected(WebXClient) - Method in class eu.ill.webx.relay.WebXHost: Called when a client disconnects.
onClientDisconnected(WebXClient) - Method in class eu.ill.webx.relay.WebXSession: Called when a client disconnects.
onDisconnected() - Method in class eu.ill.webx.relay.WebXClient: Called by the session when the client is disconneted.
onMessage(byte[]) - Method in class eu.ill.webx.relay.WebXClient: Called when a message from the server is destined to this client.
onMessage(byte[]) - Method in class eu.ill.webx.relay.WebXSession: Called when the WebX Engine for this session has sent a message.
onMessage(byte[]) - Method in interface eu.ill.webx.transport.MessageSubscriber.MessageHandler: Called when a message arrives from the server
OTHER - Enum constant in enum class eu.ill.webx.model.Message.Type: Any other message

P

publisherPort() - Method in record class eu.ill.webx.model.ConnectionData: Returns the value of the publisherPort record component.

R

read() - Method in class eu.ill.webx.WebXTunnel: Blocking call to get next message from the Client.
run() - Method in class eu.ill.webx.relay.WebXSessionValidator: Main method called when the Thread executes.

S

sendInstruction(byte[]) - Method in class eu.ill.webx.relay.WebXClient: Sends a message to the instruction publisher.
sendInstruction(byte[]) - Method in class eu.ill.webx.relay.WebXSession: Sends a binary instruction to the transport layer
sendInstruction(byte[]) - Method in class eu.ill.webx.transport.Transport: Sends an instruction to the WebX server
sendRequest(String) - Method in class eu.ill.webx.transport.Transport: Sends a synchronous request to the server using either the client connector or session channel depending on whether the server is running in standalone or not
serverPublicKey() - Method in record class eu.ill.webx.model.ConnectionData: Returns the value of the serverPublicKey record component.
SessionChannel - Class in eu.ill.webx.transport: The Session Channel provides an encrypted socket to connect initiate and create sessions with the WebX Router.
SessionId - Class in eu.ill.webx.model: Encapsulates the binary session Id value.
SessionId(byte[]) - Constructor for class eu.ill.webx.model.SessionId: Constructor taking raw binary session Id data.
SessionId(String) - Constructor for class eu.ill.webx.model.SessionId: Constructor with a hex string representation of the binary session Id.
sessionPort() - Method in record class eu.ill.webx.model.ConnectionData: Returns the value of the sessionPort record component.
SocketResponse - Record Class in eu.ill.webx.model: Encapsulates the binary data of a ZMQ REQ-REP socket response
SocketResponse(byte[]) - Constructor for record class eu.ill.webx.model.SocketResponse: Creates an instance of a SocketResponse record class.
start() - Method in class eu.ill.webx.relay.WebXSession: Starts the session validator thread (pings the session - either to the WebX Engine or via the WebX Router - to ensure it is running correctly)
start() - Method in class eu.ill.webx.relay.WebXSessionValidator: Starts the session validator thread
startSession(WebXClientConfiguration) - Method in class eu.ill.webx.transport.Transport: Sends a request to the session channel to start a new session with connection credentials
stop() - Method in class eu.ill.webx.relay.WebXSession: Stops the session validator thread and waits for it to join.
subscriberPort() - Method in record class eu.ill.webx.model.ConnectionData: Returns the value of the subscriberPort record component.

T

toByteArray(String, int) - Static method in class eu.ill.webx.utils.HexString: Converts from a hexadecimal string to a byte array.
toDebugString(byte[]) - Static method in class eu.ill.webx.utils.HexString: Converts byte data to a hex string using full length of byte data.
toDebugString(byte[], int) - Static method in class eu.ill.webx.utils.HexString: Converts byte data to hex string using a fixed maximum length of data The data is formatted for easier debugging.
toString() - Method in record class eu.ill.webx.model.ClientIdentifier: Returns a string representation of this record class.
toString() - Method in record class eu.ill.webx.model.ConnectionData: Returns a string representation of this record class.
toString() - Method in record class eu.ill.webx.model.SocketResponse: Converts the data to string if not null
Transport - Class in eu.ill.webx.transport: Wraps all ZMQ sockets into a single interface.
Transport() - Constructor for class eu.ill.webx.transport.Transport: Default constructor

V

valueOf(String) - Static method in enum class eu.ill.webx.model.Message.Type: Returns the enum constant of this class with the specified name.
values() - Static method in enum class eu.ill.webx.model.Message.Type: Returns an array containing the constants of this enum class, in the order they are declared.

W

WebXClient - Class in eu.ill.webx.relay: Provides a connection point between specific web client and a session.
WebXClientConfiguration - Class in eu.ill.webx: Provides client connection configuration.
WebXClientException - Exception Class in eu.ill.webx.exceptions: A general client exception thrown when methods to the client-facing classes (ie Tunnel and Client) are called and the state of the client is not valid.
WebXClientException(String) - Constructor for exception class eu.ill.webx.exceptions.WebXClientException: Constructor with an error message
WebXConnectionException - Exception Class in eu.ill.webx.exceptions: Exception thrown when a problem occurs while trying to connect to a host or connect a client.
WebXConnectionException(String) - Constructor for exception class eu.ill.webx.exceptions.WebXConnectionException: Constructor with error message
WebXConnectionInterruptException - Exception Class in eu.ill.webx.exceptions: Thrown when the connection is interrupted either explicitly by the Relay due to another problem or from a thread interrupt.
WebXConnectionInterruptException(String) - Constructor for exception class eu.ill.webx.exceptions.WebXConnectionInterruptException: Constructor with an error message
WebXDisconnectedException - Exception Class in eu.ill.webx.exceptions: Thrown when the host is not connected
WebXDisconnectedException() - Constructor for exception class eu.ill.webx.exceptions.WebXDisconnectedException: Default constructor
WebXDisconnectedException(String) - Constructor for exception class eu.ill.webx.exceptions.WebXDisconnectedException: Constructor with additional error message
WebXException - Exception Class in eu.ill.webx.exceptions: General WebX Exception
WebXException() - Constructor for exception class eu.ill.webx.exceptions.WebXException: Default constructor
WebXException(String) - Constructor for exception class eu.ill.webx.exceptions.WebXException: Constructor with message
WebXException(String, Throwable) - Constructor for exception class eu.ill.webx.exceptions.WebXException: Constructor with message and cause
WebXHost - Class in eu.ill.webx.relay: Provides connection to a WebXRouter or standalone WebXEngine.
WebXHostConfiguration - Class in eu.ill.webx: Provides host configuration parameters
WebXHostConfiguration(String, Integer) - Constructor for class eu.ill.webx.WebXHostConfiguration: Standard host connection parameters with hostname and port
WebXHostConfiguration(String, Integer, boolean) - Constructor for class eu.ill.webx.WebXHostConfiguration: Connection parameters including the standalone flag: Standalone server is not running with a router so connection is direct to a running WebX-Engine
WebXHostConfiguration(String, Integer, Integer) - Constructor for class eu.ill.webx.WebXHostConfiguration: Connection parameters including override for the default socket timeout running WebX-Engine
WebXRelay - Class in eu.ill.webx.relay: Central creation and storage of WebXHosts.
WebXSession - Class in eu.ill.webx.relay: Encapsulates a particular WebX X11 session, identified by a unique sessionId.
WebXSessionValidator - Class in eu.ill.webx.relay: Separate thread to ping a session to ensure it is still running.
WebXTunnel - Class in eu.ill.webx: The WebXTunnel provides the main entry point to connecting to a WebX Host.
WebXTunnel() - Constructor for class eu.ill.webx.WebXTunnel: Default constructor of a tunnel
write(byte[]) - Method in class eu.ill.webx.WebXTunnel: Writes data to the WebX Engine, sending instructions from the client.

B C D E F G H I M O P R S T V W
All Classes and Interfaces|All Packages|Serialized Form