Pinggy SDK - v0.1.3
    Preparing search index...

    Class Config

    Represents the configuration for a Pinggy tunnel. Handles setting up and managing tunnel options and arguments for the native addon.

    Implements

    • Config
    Index

    Constructors

    • Creates a new Config instance and initializes it with the provided options.

      Parameters

      • addon: PinggyNative

        The native addon instance.

      • Optionaloptions: PinggyOptions = {}

        The tunnel configuration options.

      Returns Config

    Methods

    • Gets the current argument string for the tunnel configuration.

      Returns null | string

      The argument string, or null if unavailable.

    • Gets the current force configuration setting.

      Returns null | boolean

      The force setting, or null if unavailable.

    • Gets the current server address.

      Returns null | string

      The server address, or null if unavailable.

    • Gets the current SNI server name.

      Returns null | string

      The SNI server name, or null if unavailable.

    • Gets the current authentication token.

      Returns null | string

      The authentication token, or null if unavailable.

    • Prepares and sets the argument string for the native config, based on options.

      Parameters

      • configRef: number

        The native config reference.

      • options: PinggyOptions

        The tunnel configuration options.

      Returns void

    • Sets the force configuration for the tunnel. When enabled, forces the tunnel to use specific settings or bypass certain restrictions.

      Parameters

      • force: boolean

        Whether to enable force mode.

      Returns void

    • Sets the server address for the tunnel.

      Parameters

      • Optionaladdress: string = "a.pinggy.io:443"

        The server address.

      Returns void

    • Sets the authentication token for the tunnel.

      Parameters

      • token: string

        The authentication token.

      Returns void

    Properties

    configRef: number

    Reference to the native config object.