Type alias OpenSessionPayloadType

Type declaration

• apiEndpoint: string | URL

  The API endpoint for authentication.

• apiToken: string

  The API token for authentication.

• capabilities: ("Retransmission" | "Segmentation" | "RetransmissionAckOnly" | "NoDelay" | "NoRateControl")[]

• destination: string

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

  • Optional Hops?: number

  • Optional IntermediatePath?: string[]

• listenHost: string

• Optional maxClientSessions?: null | number

• Optional maxSurbUpstream?: string

• protocol: "udp" | "tcp"

• Optional responseBuffer?: string

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

  • Optional Hops?: number

  • Optional IntermediatePath?: string[]

• Optional sessionPool?: null | number

• target: {
      Plain: string;
  }

  • Plain: string

• Optional timeout?: number

  optional timeout for the requests