// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. import type { IDaemonClientCaps } from './DaemonClientCaps'; import type { IDaemonRawModeChangedMessage, IDaemonSetRawModeMessage, IDaemonStdinEndMessage, IDaemonStdinReadyMessage, IDaemonTerminalPolicyMessage } from './DaemonInteractiveControl'; import type { IDaemonShutdownAckMessage, IDaemonShutdownMessage } from './DaemonLifecycleControl'; import type { IDaemonPingPayload, IDaemonPongMessage } from './DaemonPongMessage'; import type { DaemonProtocolErrorCode } from './DaemonProtocolError'; import type { IDaemonProtocolVersion } from './DaemonProtocolVersion'; import type { IDaemonRequestQueuePositionMessage } from './DaemonRequestAdmission'; import type { IDaemonRequestCancelMessage, IDaemonRequestRejectedMessage, IDaemonRequestResultMessage, IDaemonRequestStartMessage, IDaemonRequestStartedMessage } from './DaemonRequestControl'; /** The empty payload of control messages that carry no data. @beta */ export type DaemonEmptyPayload = Record; /** The first frame a client sends on a new connection. @beta */ export interface IDaemonHelloMessage { readonly kind: 'hello'; readonly payload: { readonly protocolVersion: IDaemonProtocolVersion }; } /** The server's accepting reply to a compatible `hello`. @beta */ export interface IDaemonHelloAckMessage { readonly kind: 'helloAck'; readonly payload: { readonly protocolVersion: IDaemonProtocolVersion; readonly sessionId: string; }; } /** Subscribes the connection with the given client capabilities. @beta */ export interface IDaemonSubscribeMessage { readonly kind: 'subscribe'; readonly payload: IDaemonClientCaps; } /** Ends this connection's subscription. @beta */ export interface IDaemonUnsubscribeMessage { readonly kind: 'unsubscribe'; readonly payload: DaemonEmptyPayload; } /** A liveness probe. @beta */ export interface IDaemonPingMessage { readonly kind: 'ping'; readonly payload: IDaemonPingPayload; } /** A protocol error sent on the wire. @beta */ export interface IDaemonErrorMessage { readonly kind: 'error'; readonly payload: { readonly code: DaemonProtocolErrorCode; readonly message: string; }; } /** * The union of every control message carried by a `0x01` control-json frame. * * @remarks * Every variant has the uniform `{ kind, payload }` shape, so reads of `kind` * stay monomorphic and the payload type is discriminated by `kind`. * @beta */ export type DaemonControlMessage = | IDaemonHelloMessage | IDaemonHelloAckMessage | IDaemonSubscribeMessage | IDaemonUnsubscribeMessage | IDaemonPingMessage | IDaemonPongMessage | IDaemonShutdownMessage | IDaemonShutdownAckMessage | IDaemonErrorMessage | IDaemonSetRawModeMessage | IDaemonStdinEndMessage | IDaemonStdinReadyMessage | IDaemonRawModeChangedMessage | IDaemonTerminalPolicyMessage | IDaemonRequestQueuePositionMessage | IDaemonRequestStartMessage | IDaemonRequestStartedMessage | IDaemonRequestCancelMessage | IDaemonRequestRejectedMessage | IDaemonRequestResultMessage;