com.uc4.communication

Interface AEConnection

All Known Implementing Classes:

Connection, WebSocketConnection

public interface AEConnection

Interface for a connection to the Automation Engine.

Method Summary

Modifier and Type	Method and Description
ConnectionAttributes	getSessionInfo() Returns information about the current UC4 Session.
java.lang.String	sendRequest(XMLRequest sendableMessage, IResponseHandler handler) Sends an message to the UC4 Server.
void	sendRequestAndWait(XMLRequest sendableMessage) Sends a message to the UC4 Server and waits for the response.

Method Detail

getSessionInfo

ConnectionAttributes getSessionInfo()

Returns information about the current UC4 Session.

Returns:

Session information

sendRequest

java.lang.String sendRequest(XMLRequest sendableMessage,
                             IResponseHandler handler)
                      throws java.io.IOException

Sends an message to the UC4 Server.

After the request is sent to the UC4 Server the method call returns immediately. When the response to this request arrives the IResponseHandler will be called.

Parameters:

sendableMessage - Object which implements the XMLRequest Interface

handler - Response Handler

Returns:

Request Number as String. This ID can be used to cancel the pending request.

Throws:

java.io.IOException - If an I/O error occurs

sendRequestAndWait

void sendRequestAndWait(XMLRequest sendableMessage)
                 throws java.io.IOException

Sends a message to the UC4 Server and waits for the response. This method blocks until the response from the UC4 Server is arrived.

Parameters:

sendableMessage - XML request

Throws:

java.io.IOException - If an I/O error occurs