Function openSession

Parameters

• payload: {
      apiEndpoint: string | URL;
      apiToken: string;
      capabilities: ("Retransmission" | "Segmentation")[];
      destination: string;
      forwardPath: {
          Hops?: number;
          IntermediatePath?: string[];
      };
      listenHost: string;
      protocol: "udp" | "tcp";
      responseBuffer: string;
      returnPath: {
          Hops?: number;
          IntermediatePath?: string[];
      };
      target: {
          Plain: string;
      };
      timeout?: number;
  }

  • apiEndpoint: string | URL

    The API endpoint for authentication.

  • apiToken: string

    The API token for authentication.

  • capabilities: ("Retransmission" | "Segmentation")[]

  • destination: string

  • forwardPath: {
        Hops?: number;
        IntermediatePath?: string[];
    }

    • Optional Hops?: number

    • Optional IntermediatePath?: string[]

  • listenHost: string

  • protocol: "udp" | "tcp"

  • responseBuffer: string

  • returnPath: {
        Hops?: number;
        IntermediatePath?: string[];
    }

    • Optional Hops?: number

    • Optional IntermediatePath?: string[]

  • target: {
        Plain: string;
    }

    • Plain: string

  • Optional timeout?: number

    optional timeout for the requests