com.kapowtech.robosuite.api.java.rql.engine.remote.socket

Class SocketBasedRQLProtocol

java.lang.Object

com.kapowtech.robosuite.api.java.rql.engine.remote.socket.SocketBasedRQLProtocol

All Implemented Interfaces:

RQLProtocol

Direct Known Subclasses:

SocketBasedObjectRQLProtocol, SocketBasedXMLRQLProtocol

public abstract class SocketBasedRQLProtocol
extends java.lang.Object
implements RQLProtocol

Abstract base class for all socket based protocols.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHost() Returns the host name to connect to.
int	getPort() Returns the port number that RoboServer listens on.
int	getSocketTimeout() Returns the socket timeout value (in milliseconds).
java.lang.String	toString() Returns a human readable string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kapowtech.robosuite.api.java.rql.engine.remote.RQLProtocol

newRQLSession

Method Detail

getHost

public java.lang.String getHost()

Returns the host name to connect to. A RoboServer running on the same machine will have a host name of localhost.

Returns:

the host name to connect to

getPort

public int getPort()

Returns the port number that RoboServer listens on. RoboServers default listen port is 50000.

Returns:

the port number that RoboServer listens on

getSocketTimeout

public int getSocketTimeout()

Returns the socket timeout value (in milliseconds). This is the maximum length of time the socket will block, while waiting for a reply from RoboServer.

This property corresponds to the SO_TIMEOUT option in the underlying socket. If set to 0, it means the socket never times out.

Returns:

the socket timeout value (in milliseconds).

toString

public java.lang.String toString()

Returns a human readable string representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

a human readable string representation of this object.