Signal K
    Preparing search index...

    Interface SubscribeMessage

    A message to allow a client to subscribe for data updates from a signalk server

    SignalK Specification: Subscription Protocol

    interface SubscribeMessage {
        context: Context | RelativePositionOrigin;
        subscribe: (
            | { minPeriod?: undefined; period?: number; policy?: "fixed" } & {
                format?: "delta";
                path?: Path;
            }
            | { minPeriod?: number; period?: undefined; policy?: "instant" } & {
                format?: "delta";
                path?: Path;
            }
        )[];
        announceNewPaths?: boolean;
    }
    Index

    Properties

    context subscribe announceNewPaths?

    Properties

    context: Context | RelativePositionOrigin

    The context path for all subsequent paths, usually a vessel's path.

    subscribe: (
        | { minPeriod?: undefined; period?: number; policy?: "fixed" } & {
            format?: "delta";
            path?: Path;
        }
        | { minPeriod?: number; period?: undefined; policy?: "instant" } & {
            format?: "delta";
            path?: Path;
        }
    )[]

    An array of paths to subscribe to, with optional criteria

    Type declaration

    • { minPeriod?: undefined; period?: number; policy?: "fixed" } & {
          format?: "delta";
          path?: Path;
      }
      • OptionalminPeriod?: undefined

        If policy=immediate or ideal, consecutive messages will be buffered until minPeriod has expired so the receiver is not swamped.

      • Optionalperiod?: number

        The subscription will be sent every period millisecs.

      • Optionalpolicy?: "fixed"
        • fixed - Send the last known values every period.
        • inline - Send all changes as fast as they are received, but no faster than minPeriod. With this policy the client has an immediate copy of the current state of the server.
      • Optionalformat?: "delta"

        The signal K format to use for the message. Only delta is currently supported. See Signal K Data Model

      • Optionalpath?: Path

        The path to subscribe to.

    • { minPeriod?: number; period?: undefined; policy?: "instant" } & {
          format?: "delta";
          path?: Path;
      }
      • OptionalminPeriod?: number
      • Optionalperiod?: undefined
      • Optionalpolicy?: "instant"
      • Optionalformat?: "delta"

        The signal K format to use for the message. Only delta is currently supported. See Signal K Data Model

      • Optionalpath?: Path

        The path to subscribe to.

    announceNewPaths?: boolean

    When true, the server will send cached values for ALL paths matching the context filter once (for discovery), plus announce any new paths that appear later. This allows clients using granular subscriptions to discover available paths without subscribing to everything continuously.

    On This Page

    Properties