Skip to content
This repository was archived by the owner on May 22, 2020. It is now read-only.

Port Discovery Protocol

Ricardo De Peña edited this page Jul 14, 2017 · 7 revisions

Port discovery is the mechanism where the Runtime transmits its WS Port information to interested parties. On each successful launch, once the socket server has obtained a port the Runtime will publish port Information via two mechanisms:

WMCopyData:

If a window with a class name OPENFIN_ADAPTER_WINDOW is found it will receive a WMCopyData message with the following payload:

{
    version: string,
    sslPort: number (defaults to -1),
    port: number,
    requestedVersion: string (example: "stable", "beta", "alpha"),
    securityRealm: string,
    runtimeInformationChannel: string,
    options: object (example: { "enable-multi-runtime": true, "v":1 }
}

Named Pipes

If the runtime-information-channel-v6 argument was passed during launch then its value will be used as the pipe name for a chromeIpc send message containing the following payload:

{
    action: "runtime-information",
    payload: {
        version: string,
        sslPort: number (defaults to -1),
        port: number,
        requestedVersion: string (example: "stable", "beta", "alpha"),
        securityRealm: string,
        runtimeInformationChannel: string,
        options: object (example: { "enable-multi-runtime": true, "v":1 }
    }
}

Clone this wiki locally