Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Server

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Server(options?: object): Server

Properties

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

connections

connections: number

Returns the current number of concurrent connections on the server.

localAddress

localAddress: string

localPort

localPort: number

maxConnections

maxConnections: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remoteFamily

remoteFamily: string

remotePort

remotePort: number

writable

writable: boolean

Static EventEmitter

EventEmitter: EventEmitter

Static defaultMaxListeners

defaultMaxListeners: number

Methods

_read

  • _read(size: number): void

_write

  • _write(chunk: any, encoding: string, callback: Function): void

addContext

  • The server.addContext() method adds a secure context that will be used if the client request's SNS hostname matches the supplied hostname (or wildcard).

    Parameters

    • hostName: string
    • options: SecureContextOptions

      An object containing any of the possible properties from the tls.createSecureContext() options arguments

    Returns void

addListener

  • addListener(event: string, listener: function)

address

  • address(): object

close

  • close(callback?: function)

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void

destroy

  • destroy(): void

emit

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

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void

eventNames

  • eventNames(): string[]

getConnections

  • getConnections(cb: function): void

getMaxListeners

  • getMaxListeners(): number

getTicketKeys

isPaused

  • isPaused(): boolean

listen

  • listen(port: number, hostname?: string, backlog?: number, listeningListener?: Function)
  • listen(port: number, hostname?: string, listeningListener?: Function)
  • listen(port: number, backlog?: number, listeningListener?: Function)
  • listen(port: number, listeningListener?: Function)
  • listen(path: string, backlog?: number, listeningListener?: Function)
  • listen(path: string, listeningListener?: Function)
  • listen(handle: any, backlog?: number, listeningListener?: Function)
  • listen(handle: any, listeningListener?: Function)
  • listen(options: ListenOptions, listeningListener?: Function)

listenerCount

  • listenerCount(event: string): number

listeners

  • listeners(event: string): Array<function>

on

  • on(event: string, listener: function)

once

  • once(event: string, listener: function)

pause

  • pause()

pipe

  • pipe<T>(destination: T, options?: object): T

prependListener

  • prependListener(event: string, listener: function)

prependOnceListener

  • prependOnceListener(event: string, listener: function)

push

  • push(chunk: any, encoding?: string): boolean

read

  • read(size?: number): any

ref

  • ref()

removeAllListeners

  • removeAllListeners(event?: string)

removeListener

  • removeListener(event: string, listener: function)

resume

  • resume()

setDefaultEncoding

  • setDefaultEncoding(encoding: string)

setEncoding

  • setEncoding(encoding: string)

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void

setMaxListeners

  • setMaxListeners(n: number)

setNoDelay

  • setNoDelay(noDelay?: boolean): void

setTicketKeys

  • setTicketKeys(keys: Buffer): void

  • Updates the keys for encryption/decryption of the TLS Session Tickets.

    Note: The key's Buffer should be 48 bytes long. See ticketKeys option in tls.createServer for more information on how it is used.

    Note: Changes to the ticket keys are effective only for future server connections. Existing or currently pending server connections will use the previous keys.

    Parameters

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void

unpipe

  • unpipe<T>(destination?: T): void

unref

  • unref()

unshift

  • unshift(chunk: any): void

wrap

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void

Static listenerCount

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

Generated using TypeDoc