Function getSessions

  • getSessions(payload): Promise<{
        activeClients: string[];
        destination: string;
        forwardPath: {
            Hops?: number;
            IntermediatePath?: string[];
        };
        hoprMtu: number;
        ip: string;
        maxClientSessions: number;
        maxSurbUpstream?: null | string;
        port: number;
        protocol: "udp" | "tcp";
        responseBuffer?: null | string;
        returnPath: {
            Hops?: number;
            IntermediatePath?: string[];
        };
        sessionPool?: null | number;
        surbLen: number;
        target: string;
    }[]>

  • Get all sessions you set previously and their corresponding data.

    Parameters

    • payload: {
          apiEndpoint: string | URL;
          apiToken: string;
          protocol: "udp" | "tcp";
          timeout?: number;
      }
      • apiEndpoint: string | URL

        The API endpoint for authentication.

      • apiToken: string

        The API token for authentication.

      • protocol: "udp" | "tcp"
      • Optional timeout?: number

        optional timeout for the requests

    Returns Promise<{
        activeClients: string[];
        destination: string;
        forwardPath: {
            Hops?: number;
            IntermediatePath?: string[];
        };
        hoprMtu: number;
        ip: string;
        maxClientSessions: number;
        maxSurbUpstream?: null | string;
        port: number;
        protocol: "udp" | "tcp";
        responseBuffer?: null | string;
        returnPath: {
            Hops?: number;
            IntermediatePath?: string[];
        };
        sessionPool?: null | number;
        surbLen: number;
        target: string;
    }[]>

    An object with alias names as keys and the peerId associated with the alias.

    Throws

    An error that occurred while processing the request.

Settings

Member Visibility

Theme