Interface ClientSocket

Hierarchy

  • Socket
    • ClientSocket

Properties

IP: string
IPV4: string
_attemptedAuthentication: boolean
_chunk: {
    clear: (() => void);
    recieve: Buffer;
    remaining: number;
}

Type declaration

  • clear: (() => void)
      • (): void
      • Returns void

  • recieve: Buffer
  • remaining: number
_kickInProcess: boolean
allowHalfOpen: boolean
bufferSize: number
bytesRead: number
bytesWritten: number
connecting: boolean
destroyed: boolean
keepalive: {
    keepAliveTime: number;
    kickIdlePlayer: (() => void);
    restartTimer: (() => void);
    timer: Timeout;
}

Type declaration

  • keepAliveTime: number
  • kickIdlePlayer: (() => void)
      • (): void
      • Returns void

  • restartTimer: (() => void)
      • (): void
      • Returns void

  • timer: Timeout
localAddress: string
localPort: number
player: Player
readable: boolean
readableEncoding: BufferEncoding
readableEnded: boolean
readableFlowing: boolean
readableHighWaterMark: number
readableLength: number
readableObjectMode: boolean
readyState: SocketReadyState

This property represents the state of the connection as a string.

See

Since

v0.5.0

remoteAddress?: string
remoteFamily?: string
remotePort?: number
timeout?: number

The socket timeout in milliseconds as set by socket.setTimeout(). It is undefined if a timeout has not been set.

Since

v10.7.0

writable: boolean
writableEnded: boolean
writableFinished: boolean
writableHighWaterMark: number
writableLength: number
writableObjectMode: boolean

Methods

  • Returns AsyncIterableIterator<any>

  • Parameters

    • error: Error
    • callback: ((error: Error) => void)
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns void

  • Parameters

    • callback: ((error?: Error) => void)
        • (error?: Error): void
        • Parameters

          • Optional error: Error

          Returns void

    Returns void

  • Parameters

    • size: number

    Returns void

  • Parameters

    • chunk: any
    • encoding: string
    • callback: ((error?: Error) => void)
        • (error?: Error): void
        • Parameters

          • Optional error: Error

          Returns void

    Returns void

  • Parameters

    • chunks: {
          chunk: any;
          encoding: string;
      }[]
    • callback: ((error?: Error) => void)
        • (error?: Error): void
        • Parameters

          • Optional error: Error

          Returns void

    Returns void

  • events.EventEmitter

    1. close
    2. connect
    3. data
    4. drain
    5. end
    6. error
    7. lookup
    8. timeout

    Parameters

    • event: string
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "close"
    • listener: ((had_error: boolean) => void)
        • (had_error: boolean): void
        • Parameters

          • had_error: boolean

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "connect"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "data"
    • listener: ((data: Buffer) => void)
        • (data: Buffer): void
        • Parameters

          • data: Buffer

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "error"
    • listener: ((err: Error) => void)
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "lookup"
    • listener: ((err: Error, address: string, family: string | number, host: string) => void)
        • (err: Error, address: string, family: string | number, host: string): void
        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "ready"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "timeout"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Returns string | AddressInfo

  • Parameters

    • options: SocketConnectOpts
    • Optional connectionListener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • port: number
    • host: string
    • Optional connectionListener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • port: number
    • Optional connectionListener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • path: string
    • Optional connectionListener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Returns void

  • Parameters

    • Optional error: Error

    Returns ClientSocket

  • Parameters

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

    Returns boolean

  • Parameters

    • event: "close"
    • had_error: boolean

    Returns boolean

  • Parameters

    • event: "connect"

    Returns boolean

  • Parameters

    • event: "data"
    • data: Buffer

    Returns boolean

  • Parameters

    • event: "drain"

    Returns boolean

  • Parameters

    • event: "end"

    Returns boolean

  • Parameters

    • event: "error"
    • err: Error

    Returns boolean

  • Parameters

    • event: "lookup"
    • err: Error
    • address: string
    • family: string | number
    • host: string

    Returns boolean

  • Parameters

    • event: "ready"

    Returns boolean

  • Parameters

    • event: "timeout"

    Returns boolean

  • Parameters

    • Optional cb: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • buffer: string | Uint8Array
    • Optional cb: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • str: string | Uint8Array
    • Optional encoding: string
    • Optional cb: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Returns (string | symbol)[]

  • Returns number

  • Returns boolean

  • Parameters

    • type: string | symbol

    Returns number

  • Parameters

    • event: string | symbol

    Returns Function[]

  • Parameters

    • event: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientSocket

  • Parameters

    • event: string
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "close"
    • listener: ((had_error: boolean) => void)
        • (had_error: boolean): void
        • Parameters

          • had_error: boolean

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "connect"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "data"
    • listener: ((data: Buffer) => void)
        • (data: Buffer): void
        • Parameters

          • data: Buffer

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "error"
    • listener: ((err: Error) => void)
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "lookup"
    • listener: ((err: Error, address: string, family: string | number, host: string) => void)
        • (err: Error, address: string, family: string | number, host: string): void
        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "ready"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "timeout"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: string
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "close"
    • listener: ((had_error: boolean) => void)
        • (had_error: boolean): void
        • Parameters

          • had_error: boolean

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "connect"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "data"
    • listener: ((data: Buffer) => void)
        • (data: Buffer): void
        • Parameters

          • data: Buffer

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "error"
    • listener: ((err: Error) => void)
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "lookup"
    • listener: ((err: Error, address: string, family: string | number, host: string) => void)
        • (err: Error, address: string, family: string | number, host: string): void
        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "ready"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "timeout"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Returns ClientSocket

  • Type Parameters

    • T extends WritableStream<T>

    Parameters

    • destination: T
    • Optional options: {
          end?: boolean;
      }
      • Optional end?: boolean

    Returns T

  • Parameters

    • event: string
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "close"
    • listener: ((had_error: boolean) => void)
        • (had_error: boolean): void
        • Parameters

          • had_error: boolean

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "connect"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "data"
    • listener: ((data: Buffer) => void)
        • (data: Buffer): void
        • Parameters

          • data: Buffer

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "error"
    • listener: ((err: Error) => void)
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "lookup"
    • listener: ((err: Error, address: string, family: string | number, host: string) => void)
        • (err: Error, address: string, family: string | number, host: string): void
        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "ready"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "timeout"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: string
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "close"
    • listener: ((had_error: boolean) => void)
        • (had_error: boolean): void
        • Parameters

          • had_error: boolean

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "connect"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "data"
    • listener: ((data: Buffer) => void)
        • (data: Buffer): void
        • Parameters

          • data: Buffer

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "error"
    • listener: ((err: Error) => void)
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "lookup"
    • listener: ((err: Error, address: string, family: string | number, host: string) => void)
        • (err: Error, address: string, family: string | number, host: string): void
        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "ready"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "timeout"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

  • Parameters

    • event: string | symbol

    Returns Function[]

  • Parameters

    • Optional size: number

    Returns any

  • Returns void

  • Parameters

    • Optional event: string | symbol

    Returns ClientSocket

  • Parameters

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

    Returns ClientSocket

  • Parameters

    • event: "data"
    • listener: ((chunk: any) => void)
        • (chunk: any): void
        • Parameters

          • chunk: any

          Returns void

    Returns ClientSocket

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "readable"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Parameters

    • event: "error"
    • listener: ((err: Error) => void)
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns ClientSocket

  • Parameters

    • event: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientSocket

  • Returns ClientSocket

  • Parameters

    • encoding: string

    Returns ClientSocket

  • Parameters

    • Optional encoding: string

    Returns ClientSocket

  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns ClientSocket

  • Parameters

    • n: number

    Returns ClientSocket

  • Parameters

    • Optional noDelay: boolean

    Returns ClientSocket

  • Parameters

    • timeout: number
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns ClientSocket

  • Returns void

  • Parameters

    • Optional destination: WritableStream

    Returns ClientSocket

  • Returns void

  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding

    Returns void

  • Parameters

    • oldStream: ReadableStream

    Returns ClientSocket

  • Parameters

    • buffer: string | Uint8Array
    • Optional cb: ((err?: Error) => void)
        • (err?: Error): void
        • Parameters

          • Optional err: Error

          Returns void

    Returns boolean

  • Parameters

    • str: string | Uint8Array
    • Optional encoding: string
    • Optional cb: ((err?: Error) => void)
        • (err?: Error): void
        • Parameters

          • Optional err: Error

          Returns void

    Returns boolean