Class Tunnel

constructor

• new Tunnel(
      addon: PinggyNative,
      configRef: number,
      pinggyOptions: PinggyOptions,
  ): Tunnel

  Creates a new Tunnel instance and initializes it with the provided config reference.

  Parameters

  • addon: PinggyNative

    The native addon instance.
  • configRef: number

    The reference to the native config object.
  • pinggyOptions: PinggyOptions

  Returns Tunnel

getLatestUsage

• getLatestUsage(): null | TunnelUsageType

  Returns null | TunnelUsageType

getStatus

• getStatus(): TunnelStatus

  Returns TunnelStatus

getTunnelGreetMessage

• getTunnelGreetMessage(): string[]

  Returns string[]

getTunnelUsages

• getTunnelUsages(): string

  Returns string

getUrls

• getUrls(): string[]

  Gets the list of public URLs for the tunnel.

  Returns string[]

  The list of public tunnel URLs.

getWebDebuggerPort

• getWebDebuggerPort(): null | number

  Returns null | number

setAdditionalForwardingCallback

• setAdditionalForwardingCallback(
      callback: (
          bindAddress: string,
          forwardToAddr: string,
          errorMessage: null | string,
      ) => void,
  ): void

  Parameters

  • callback: (
        bindAddress: string,
        forwardToAddr: string,
        errorMessage: null | string,
    ) => void

  Returns void

setAuthenticatedCallback

• setAuthenticatedCallback(callback: (message: string) => void): void

  Parameters

  • callback: (message: string) => void

  Returns void

setPrimaryForwardingCallback

• setPrimaryForwardingCallback(
      callback: (message: string, address?: string[]) => void,
  ): void

  Parameters

  • callback: (message: string, address?: string[]) => void

  Returns void

setTunnelDisconnectedCallback

• setTunnelDisconnectedCallback(
      callback: (error: string, messages: string[]) => void,
  ): void

  Parameters

  • callback: (error: string, messages: string[]) => void

  Returns void

setTunnelErrorCallback

• setTunnelErrorCallback(
      callback: (errorNo: number, error: string, recoverable: boolean) => void,
  ): void

  Parameters

  • callback: (errorNo: number, error: string, recoverable: boolean) => void

  Returns void

setUsageUpdateCallback

• setUsageUpdateCallback(callback: (usage: TunnelUsageType) => void): void

  Parameters

  • callback: (usage: TunnelUsageType) => void

  Returns void

start

• start(): Promise<string[]>

  Starts the tunnel, handles authentication and forwarding, and returns the public URLs.

  Returns Promise<string[]>

  Resolves with the list of public tunnel URLs.

  Throws

  If tunnel connection or forwarding fails.

startTunnelUsageUpdate

• startTunnelUsageUpdate(): void

  Returns void

startWebDebugging

• startWebDebugging(listeningPort: number): Promise<void>

  Starts web debugging for the tunnel on the specified local port.

  Parameters

  • listeningPort: number

    The local port to start web debugging on.

  Returns Promise<void>

  Resolves when web debugging is started.

  Throws

  If web debugging fails to start.

stopTunnelUsageUpdate

• stopTunnelUsageUpdate(): void

  Returns void

tunnelIsActive

• tunnelIsActive(): boolean

  Checks if the tunnel is currently active.

  Returns boolean

  True if the tunnel is active, false otherwise.

tunnelRequestAdditionalForwarding

• tunnelRequestAdditionalForwarding(
      remoteAddress: string,
      localAddress: string,
  ): Promise<void>

  Requests additional forwarding for the tunnel.

  Parameters

  • remoteAddress: string

    The remote address to forward from.
  • localAddress: string

    The local address to forward to.

  Returns Promise<void>

  Resolves when additional forwarding is set up.

  Throws

  If additional forwarding fails.

tunnelStop

• tunnelStop(): boolean

  Stops the tunnel and cleans up resources.

  Returns boolean

  True if the tunnel was stopped successfully, false otherwise.

  Throws

  If stopping the tunnel fails.

authenticated

primaryForwardingDone

status

tunnelRef