Closes the connection to Union Server.
The disconnect() method is not normally intended for direct use.
Permanently disables this object.
Returns the host on which the connection will be opened or has been opened.
The host name or ip, as a string.
Returns the port on which the connection will be opened or has been opened.
A number from 1 to 65535.
Returns the host that was requested for this connection via setServer(). If that host is a load balancing DNS server, the actual host used for the connection (as returned by getHost()) might differ from the requested host.
The requested host name or ip, as a string.
Returns this connection's send-delay. For details, see setSendDelay().
Returns the type of the connection, as one of the types specified by the ConnectionType class.
A string representing the connection type.
Indicates whether this connection is currently in a "ready" state.
Indicates whether this connection is considered valid. Valid connections are those that are currently in a "ready" state, or are currently disconnected but successfully achieved a "ready" state in the most recent connection attempt.
Assigns the Orbiter object for which this IConnection will provide server communication services. This method is invoked automatically by the ConnectionManager when the Connection object is added to the ConnectionManager's connection list.
Increases or decreases the connection's batch-message send rate, or disables batch-sending entirely. Orbiter's HTTPConnection class uses a batch-message-sending system that reduces server load and client-side HTTP-request volume. In the default configuration, when an HTTPConnection sends messages via an HTTP request to Union Server, it starts a countdown known as the "send-countdown". The duration of the send-countdown is known as the "send-delay" (configurable via the setSendDelay() method). Until both the send-countdown expires and the response to the HTTP request is received, all outbound messages are queued. The queue is flushed when both the outbound HTTP request has completed and the send-countdown (if any) has expired.
Orbiter's batch-message-sending system is part of Union's "binary request" HTTP communications model, which balances two principles: on one hand, for maximum responsiveness, Orbiter always maintains an open HTTP request to Union Server (used to receive incoming messages from the server); on the other hand, for maximum efficiency, when an outgoing HTTP response is already pending, Orbiter never sends another request, and when no outgoing HTTP response is pending, Orbiter never sends messages to Union Server more frequently than the specified send-delay.
The default send-delay is defined by HTTPConnection.DEFAULT_SEND_DELAY, and is appropriate for the vast majority of applications. However, applications that require a reduced server load can opt for less frequent message delivery by increasing the send-delay. Conversely, applications that require maximum responsiveness can opt for more frequent message delivery by decreasing the send-delay, or by setting the send-delay to -1, which disables the message queue entirely. When the message queue is disabled, a new outgoing HTTP request will be opened any time there are messages to send and there is no outgoing request already pending.
Warning: disabling the send-delay or setting it to a value lower than 200 milliseconds can result high server load. When setting send-delay to a custom value, be sure to test application behaviour thoroughly.
The batched message send-delay, in milliseconds. Defaults to HTTPConnection.DEFAULT_SEND_DELAY.
Transmits the client hello to the server, bypassing the usual send call because the first request has no session id, so the Binary Request Communication Model cannot yet be used.
The default send-delay used for new HTTPConnection objects. For details, see setSendDelay.