Class PortForwarder

constructor

• new PortForwarder(options: Config): PortForwarder

  Creates a new instance of the port forwarding service

  Parameters

  • options: Config

  Returns PortForwarder

Readonlyinterfaces

Readonlyoptions

Readonlyserver

Readonlysessions

ip

• get ip(): string

  Returns our listening interface

  Returns string

port

• get port(): number

  Returns our listening port

  Returns number

timeout

• get timeout(): number

  Returns out timeout

  Returns number

forward

• forward(
      socket: Socket,
      ip: string,
      port: number,
      timeout?: number,
      keepAlive?: undefined | boolean,
  ): Promise<boolean>

  Creates a connection to the specified IP and port and then pipes it back and forth to the specified socket

  Parameters

  • socket: Socket
  • ip: string
  • port: number
  • timeout: number = ...
  • keepAlive: undefined | boolean = ...

  Returns Promise<boolean>

getConnections

• getConnections(): Promise<number>

  Returns the current connections to the server

  Returns Promise<number>

list

• list(): Promise<Session[]>

  Returns the list of current sessions

  Returns Promise<Session[]>

on

• on(event: "error", listener: (error: Error, ...args: any[]) => void): this

  Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

  server.on('connection', (stream) => {
    console.log('someone connected!');
  });
  Copy

  Returns a reference to the EventEmitter, so that calls can be chained.

  By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

  import { EventEmitter } from 'node:events';
  const myEE = new EventEmitter();
  myEE.on('foo', () => console.log('a'));
  myEE.prependListener('foo', () => console.log('b'));
  myEE.emit('foo');
  // Prints:
  //   b
  //   a
  Copy

  Parameters

  • event: "error"
  • listener: (error: Error, ...args: any[]) => void

    The callback function

  Returns this

  Since

  v0.1.101

• on(event: "listening", listener: (ip: string, port: number) => void): this

  Parameters

  • event: "listening"
  • listener: (ip: string, port: number) => void

  Returns this

• on(event: "close", listener: () => void): this

  Parameters

  • event: "close"
  • listener: () => void

  Returns this

• on(event: "connection", listener: (socket: Socket, port: number) => void): this

  Parameters

  • event: "connection"
  • listener: (socket: Socket, port: number) => void

  Returns this

• on(
      event: "forward",
      listener: (
          remoteAddress: string,
          remotePort: number,
          forwardAddress: string,
          forwardPort: number,
      ) => void,
  ): this

  Parameters

  • event: "forward"
  • listener: (
        remoteAddress: string,
        remotePort: number,
        forwardAddress: string,
        forwardPort: number,
    ) => void

  Returns this

start

• start(): Promise<void>

  Starts the server

  Returns Promise<void>

stop

• stop(): Promise<void>

  Stops the server

  Returns Promise<void>