Interface ESPLocalControlSessionOptions

Per-connection session details passed to ESPLocalControlAdapterInterface.connect. The protocomm handshake endpoint differs per local-control protocol, so the transport tells the native layer which paths to use instead of the adapter hardcoding them.

Adapters built against an earlier SDK simply ignore the extra argument and keep using their built-in default paths.

interface ESPLocalControlSessionOptions {
    protocol: string;
    sessionPath: string;
    versionKey: string;
    versionPath: string;
}

Properties

protocol sessionPath versionKey versionPath

Properties

protocol

protocol: string

Protocol tag, one of ESPLocalControlProtocol.

sessionPath

sessionPath: string

Protocomm session-security endpoint, e.g. rmaker_local_ctrl/session.

versionKey

versionKey: string

Root key to read in the version response when probing the security scheme version, e.g. rmaker_local_ctrl for {"rmaker_local_ctrl": {…}}.

versionPath

versionPath: string

Version/service-info endpoint, e.g. rmaker_local_ctrl/version.

Settings

Member Visibility

On This Page

Properties