NoteIn this context the EK80 Processor Unit is regarded as the "server". The EK80 program is the "server application". The program you make yourself for running on a local computer is referred to as the "client application".
ConnectRequest
The contents of the ConnectRequest message is shown below.
struct ConnectRequest
{
char Header[4]; // ”CON\0”
char ClientInfo[1024]; // ”eg Name: Simrad; Password:\0
};
Response
The EK80 server application will respond with a Response message. If the ConnectRequest command succeeded, it will contain at least the client identification. If the ConnectRequest command failed, it will contain an error message.
struct ConnectRequest
{
char Header[4]; // //”RES\0”
char Request[4]; // ”CON\0”
char MsgControl[22]; // ”\0”
char MsgResponse[1400]; // Response text containingresult of connection request
};The MsgResponse field consist of a ResultCode and Parameters.
|
1 |
The ResultCode contains the result of the ConnectRequest command. The following values are defined.
|
• |
S_OK: The operation was successful. |
|
• |
E_ACCESSDENIED: The operation failed due to unknown account or wrong password. |
|
• |
E_FAIL: The operation failed due to an unspecified error. |
|
|
2 |
The Parameters is a comma separated list of various "name:value" pairs that may be present. These parameters are only provided if the ConnectRequest was successful. The following values are defined.
|
• |
ClientID: This is the identification of the current client. The information is used in all further communication with the server application. |
|
• |
AccessLevel: This is the general access level for the current client. |
|
A successful connection will for example provide a MsgResponse message.
struct ConnectRequest
{
ResultCode:S_OK,
Parameters:{ClientID:1,AccessLevel:1}\0
};In case the ConnectRequest command fails, the ResponseField will contain a ResultInfo field. This field will contain text describing the failure.