@microsoft/dev-tunnels-ssh-tcp/tcpListenerFactory.d.ts

SSH TCP extensions library for Dev Tunnels

/// <reference types="node" />
import * as net from 'net';
import { CancellationToken } from 'vscode-jsonrpc';
export interface TcpListenerFactory {
    /**
     * Creates and starts a TCP listener for the specified local network address and port
     * number.
     *
     * @param remotePort The remote port that this local port will connect to (if known).
     * @param localIPAddress Local IP address to listen on.
     * @param localPort Requested local port to listen on, or 0 to use a random
     * available port number.
     * @param canChangeLocalPort True if the factory is allowed to select a different
     * local port number than the one that was requested; if false then the factory must either
     * use the requested port or throw an exception.</param>
     * @param cancellation">Cancellation token.</param>
     * @returns TCP listener object that has started listening.</returns>
     * @exception SocketException Creating or starting the listener failed.</exception>
     *
     * The `localIPAddress` may be any of the following values:
     *  - `IPAddress.Loopback`: Bind to IPv4 and IPv6 loopback interfaces.
     *  - `IPAddress.IPv6Loopback`: Bind to only the IPv6 loopback interfaces.
     *  - `IPAddress.Any`: Bind to all IPv4 and IPv6 interfaces.
     *  - `IPAddress.IPv6Any`: Bind to only IPv6 interfaces.
     *  - Any other IP address: Bind to the interface with the specified IP address.
     *
     * The factory implementation may choose an alternate port number instead of the requested
     * `localPort` value, for instance if the requested port is in-use or the
     * current process does not have permission to listen on it. In that case the caller will
     * obtain the actual port from the returned listener's `localEndpoint` property.
     */
    createTcpListener(remotePort: number | undefined, localIPAddress: string, localPort: number, canChangeLocalPort: boolean, cancellation?: CancellationToken): Promise<net.Server>;
}
export declare class DefaultTcpListenerFactory implements TcpListenerFactory {
    createTcpListener(remotePort: number | undefined, localIPAddress: string, localPort: number, canChangeLocalPort: boolean, cancellation?: CancellationToken): Promise<net.Server>;
}
//# sourceMappingURL=tcpListenerFactory.d.ts.map