Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TcpProxy

A TCP proxy.

Hierarchy

  • EventEmitter
    • TcpProxy

Implements

  • Disposable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Initializes a new instance of that class.

    Parameters

    • controller: Controller

      The underlying controller.

    • port: number

      The TCP port.

    • entry: ProxyEntry

      The underlying entry.

    • index: number

      The zero-based index of that proxy.

    Returns TcpProxy

Properties

Private _COMMANDS_ID

_COMMANDS_ID: number = ++nextCommandsId

Private _CONTROLLER

_CONTROLLER: Controller

Private _ENTRY

_ENTRY: ProxyEntry

Private _INDEX

_INDEX: number

Private _PORT

_PORT: number

Private _button

_button: vscode.StatusBarItem

Private _buttonCommand

_buttonCommand: vscode.Disposable

Private _globalScriptState

_globalScriptState: Object

Private _isInitialized

_isInitialized: boolean = false

Private _server

_server: Server

Private _statistics

_statistics: ProxyStatistics

Private _trace

_trace: TraceEntry[]

Private _traceWriterState

_traceWriterState: any

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

controller

  • Gets the underlying controller.

    Returns Controller

defaultButtonColor

  • get defaultButtonColor(): "#ffffff" | "#808080"

  • Gets the default button color.

    Returns "#ffffff" | "#808080"

entry

  • Gets the underlying entry.

    Returns ProxyEntry

index

  • get index(): number

  • Gets the zero-based index of that proxy.

    Returns number

isInitialized

  • get isInitialized(): boolean

  • Gets if the proxy has been initialized or not.

    Returns boolean

isRunning

  • get isRunning(): boolean

  • Gets if proxy is running or not.

    Returns boolean

isTracing

  • get isTracing(): boolean

  • Gets if the proxy is current in trace mode or not.

    Returns boolean

name

  • get name(): string

  • Gets the (display) name of that proxy.

    Returns string

port

  • get port(): number

  • The TCP port.

    Returns number

trace

  • Gets the current trace.

    Returns TraceEntry[]

Methods

addListener

  • addListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

dispose

  • dispose(): void
  • inheritdoc

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

init

  • init(): Promise<void>

  • Initailizes that proxy.

    Returns Promise<void>

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

once

  • once(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

openTraceInNewTab

  • openTraceInNewTab(index?: number): Promise<void>

  • Opens all trace items or a specific one in a new tab.

    Parameters

    • Optional index: number

    Returns Promise<void>

prependListener

  • prependListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

showTraceActions

  • showTraceActions(): Promise<void>

  • Shows trace actions.

    Returns Promise<void>

start

  • start(): Promise<boolean>

  • Starts the proxy.

    Returns Promise<boolean>

    The promise that indicates if operation was successful or not.

stop

  • stop(): Promise<boolean>

  • Stops the proxy.

    Returns Promise<boolean>

    The promise that indicates if operation was successful or not.

toggleTrace

  • Toggles trace state.

    Returns Promise<TraceEntry[]>

    The promise with the current trace.

traceEntryToString

  • Converts a trace entry to a string.

    Parameters

    Returns string

    The entry as string.

Protected updateButton

  • updateButton(): void

  • Updates the underlying button.

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc