Elastic Desktop Service:Windows plugin-based connection management SDK

WYSyncRequest

Executes a request synchronously and returns the result.

Signature

WYResponse WYSyncRequest(const char* key, const char* params);

Parameters

Return value

A WYResponse struct. code == 0 means success; any other value means failure. Call WYFreeResponse to release the response after use.

WYAsyncRequest

Executes a request asynchronously and invokes the callback when complete.

Signature

void WYAsyncRequest(const char* key, const char* params, void (*callback)(WYResponse));

Parameters

Remarks

WYAsyncRequest supports all keys that WYSyncRequest supports. Use it for listener registration so the callback receives events without blocking your thread.

WYFreeResponse

Releases the memory allocated for a WYResponse.

Signature

void WYFreeResponse(WYResponse& response);

Parameters

Remarks

Call this after every WYSyncRequest call and after processing each response in an async callback.

Initialize the SDK — WYInitialize

Call time: Before any other SDK operations.

Parameters (JSON)

Example

std::string directory = getDicOfSDK();
std::string config = "{\"partnerInfo\":{\"partner\":\"<your-company>\",\"partnerApp\":\"<your-app>\"}, \"launcherPath\":\"";
config.append(directory);
config.append("\\stream_launcher.exe\"}");

WYResponse value = SyncRequest("WYInitialize", config.c_str());
FreeResponse(value);
// value.code == 0 means initialization succeeded

Run the SDK — WYRun

Call time: After WYInitialize, before connecting to any cloud resource.

Parameters: None

Example

WYResponse value = SyncRequest("WYRun", NULL);
int runCode = value.code;
FreeResponse(value);
// runCode == 0 means the SDK is running

Destroy the SDK — WYUninitialize

Call time: When shutting down; after disconnecting all sessions and deregistering all listeners.

Parameters: None

Example

WYResponse value = SyncRequest("WYUninitialize", NULL);
FreeResponse(value);

Connect to a cloud computer or application — WYCreateConnect

Call time: After WYRun.

Parameters (JSON)

Example — open a cloud computer

{
  "operation": "openDesktop",
  "bizParam": {
    "ticket": "<connection-ticket>",
    "desktopId": "ecd-7nvbz4ccjly95xxxx",
    "desktopName": "Alice's cloud computer",
    "osType": "windows"
  },
  "partnerInfo": {
    "partner": "<your-company>",
    "partnerApp": "<your-app>"
  },
  "extInfo": {
    "language": "zh",
    "cloudDpi": 150,
    "fullscreen": true,
    "isVpc": true,
    "hideFloatingBall": true,
    "proxy": {
      "type": "system",
      "host": "127.x.x.x",
      "port": 50550,
      "account": "",
      "password": ""
    }
  }
}

WYResponse value = SyncRequest("WYCreateConnect", connectParams.c_str());
FreeResponse(value);

Example — open a cloud application

std::string params = "{\"operation\":\"openApp\","
    "\"bizParam\":{\"ticket\":\"<ticket>\","
    "\"appInstanceGroupId\":\"<group-id>\","
    "\"appName\":\"<app-name>\","
    "\"osType\":\"Windows\"}}";

WYResponse value = SyncRequest("WYCreateConnect", params.c_str());
FreeResponse(value);

Disconnect — WYDisconnect

Call time: After the session is established, when you want to close it.

Parameters (JSON)

Example

std::string params = "{\"connectId\":\"<desktop-id>\"}";
WYResponse value = SyncRequest("WYDisconnect", params.c_str());
FreeResponse(value);

Register a listener — WYRegisterListener

Call time: After WYRun.

Register callbacks to receive SDK logs, errors, and connection status events.

Example — listen for log output

AsyncRequest("WYRegisterListener", "{\"tag\": \"onOutputLog\"}", [](WYResponse value) {
    printf("%s\n", value.content);
});

Example — listen for errors

AsyncRequest("WYRegisterListener", "{\"tag\": \"onErrorCode\"}", [](WYResponse value) {
    int code = value.code;
    if (code == 200 || code == 201 || code == 202) {
        // The communication service has failed. Stop the process and restart it.
        // Alternatively, you can uninstall the SDK and reload it, but reloading WYSDK.dll
        // without restarting the process leaves static residuals.
    }
    printf("Error callback tag %s code %d\n", value.requestParams, code);
});

Example — listen for connection status changes

// Register before calling WYCreateConnect for the same connectId.
std::string params = "{\"tag\": \"onStatusChange\", \"connectId\":\"<desktop-id>\"}";
AsyncRequest("WYRegisterListener", params.c_str(), [](WYResponse value) {
    printf("Status changed: %s\n", value.content);
});

Deregister a listener — WYUnregisterListener

Use the same tag and connectId you passed to WYRegisterListener.

Example

std::string params = "{\"tag\": \"onStatusChange\", \"connectId\":\"<desktop-id>\"}";
WYResponse value = SyncRequest("WYUnregisterListener", params.c_str());
FreeResponse(value);

To deregister the log and error listeners (no connectId required):

WYResponse unLog   = SyncRequest("WYUnregisterListener", "{\"tag\": \"onOutputLog\"}");
FreeResponse(unLog);

WYResponse unError = SyncRequest("WYUnregisterListener", "{\"tag\": \"onErrorCode\"}");
FreeResponse(unError);

Query cloud computer information — enumConnections

Returns a JSON array describing all active cloud computer and application connections.

WYResponse value = SyncRequest("enumConnections", NULL);
printf("Connections: %s\n", value.content);
FreeResponse(value);

Response format

{
    "connection":    "<connect-id>",
    "connectionPid": 27324,
    "partner":       "<your-company>",
    "partnerApp":    "<your-app>",
    "processId":     8696,
    "status":        "start"
}

status is either "start" (session active) or "exit" (session ended). connectionPid is the PID of the cloud computer process.

Get the device UUID — uuid

WYResponse value = SyncRequest("uuid", NULL);
printf("UUID: %s\n", value.content);
FreeResponse(value);

Get the SDK version — sdkVersion

WYResponse value = SyncRequest("sdkVersion", NULL);
printf("Version: %s\n", value.content);
FreeResponse(value);

Open the feedback page — feedback

WYResponse value = SyncRequest("feedback", NULL);
FreeResponse(value);

Open the version update page — upgrade

WYResponse value = SyncRequest("upgrade", NULL);
FreeResponse(value);