Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

  • new Server(secureConnectionListener?: function): Server
  • new Server(options: TlsOptions, secureConnectionListener?: function): Server

Properties

connections

connections: number

listening

listening: boolean

maxConnections

maxConnections: number

Methods

addContext

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

    Parameters

    Returns void

addListener

  • addListener(event: string, listener: function): this
  • addListener(event: "tlsClientError", listener: function): this
  • addListener(event: "newSession", listener: function): this
  • addListener(event: "OCSPRequest", listener: function): this
  • addListener(event: "resumeSession", listener: function): this
  • addListener(event: "secureConnection", listener: function): this
  • addListener(event: "keylog", listener: function): this
  • events.EventEmitter

    1. tlsClientError
    2. newSession
    3. OCSPRequest
    4. resumeSession
    5. secureConnection
    6. keylog

    Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "tlsClientError"
    • listener: function

    Returns this

  • Parameters

    • event: "newSession"
    • listener: function
        • (sessionId: Buffer, sessionData: Buffer, callback: function): void

    Returns this

  • Parameters

    • event: "OCSPRequest"
    • listener: function
        • (certificate: Buffer, issuer: Buffer, callback: function): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "resumeSession"
    • listener: function
        • (sessionId: Buffer, callback: function): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "secureConnection"
    • listener: function

    Returns this

  • Parameters

    Returns this

address

close

  • close(callback?: function): this
  • Parameters

    • Optional callback: function
        • Parameters

          Returns void

    Returns this

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • emit(event: "tlsClientError", err: Error, tlsSocket: TLSSocket): boolean
  • emit(event: "newSession", sessionId: Buffer, sessionData: Buffer, callback: function): boolean
  • emit(event: "OCSPRequest", certificate: Buffer, issuer: Buffer, callback: function): boolean
  • emit(event: "resumeSession", sessionId: Buffer, callback: function): boolean
  • emit(event: "secureConnection", tlsSocket: TLSSocket): boolean
  • emit(event: "keylog", line: Buffer, tlsSocket: TLSSocket): boolean
  • Parameters

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

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    • event: "OCSPRequest"
    • certificate: Buffer
    • issuer: Buffer
    • callback: function

    Returns boolean

  • Parameters

    • event: "resumeSession"
    • sessionId: Buffer
    • callback: function

    Returns boolean

  • Parameters

    • event: "secureConnection"
    • tlsSocket: TLSSocket

    Returns boolean

  • Parameters

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>
  • Returns Array<string | symbol>

getConnections

  • getConnections(cb: function): void
  • Parameters

    • cb: function
        • (error: Error | null, count: number): void
        • Parameters

          • error: Error | null
          • count: number

          Returns void

    Returns void

getMaxListeners

  • getMaxListeners(): number

getTicketKeys

  • Returns the session ticket keys.

    Returns Buffer

listen

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

    • Optional port: number
    • Optional hostname: string
    • Optional backlog: number
    • Optional listeningListener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • Optional port: number
    • Optional hostname: string
    • Optional listeningListener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • Optional port: number
    • Optional backlog: number
    • Optional listeningListener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • Optional port: number
    • Optional listeningListener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • path: string
    • Optional backlog: number
    • Optional listeningListener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • path: string
    • Optional listeningListener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • options: ListenOptions
    • Optional listeningListener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • handle: any
    • Optional backlog: number
    • Optional listeningListener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • handle: any
    • Optional listeningListener: function
        • (): void
        • Returns void

    Returns this

listenerCount

  • listenerCount(event: string | symbol): number
  • Parameters

    • event: string | symbol

    Returns number

listeners

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

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: function): this
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string, listener: function): this
  • on(event: "tlsClientError", listener: function): this
  • on(event: "newSession", listener: function): this
  • on(event: "OCSPRequest", listener: function): this
  • on(event: "resumeSession", listener: function): this
  • on(event: "secureConnection", listener: function): this
  • on(event: "keylog", listener: function): this
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "tlsClientError"
    • listener: function

    Returns this

  • Parameters

    • event: "newSession"
    • listener: function
        • (sessionId: Buffer, sessionData: Buffer, callback: function): void

    Returns this

  • Parameters

    • event: "OCSPRequest"
    • listener: function
        • (certificate: Buffer, issuer: Buffer, callback: function): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "resumeSession"
    • listener: function
        • (sessionId: Buffer, callback: function): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "secureConnection"
    • listener: function

    Returns this

  • Parameters

    Returns this

once

  • once(event: string, listener: function): this
  • once(event: "tlsClientError", listener: function): this
  • once(event: "newSession", listener: function): this
  • once(event: "OCSPRequest", listener: function): this
  • once(event: "resumeSession", listener: function): this
  • once(event: "secureConnection", listener: function): this
  • once(event: "keylog", listener: function): this
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "tlsClientError"
    • listener: function

    Returns this

  • Parameters

    • event: "newSession"
    • listener: function
        • (sessionId: Buffer, sessionData: Buffer, callback: function): void

    Returns this

  • Parameters

    • event: "OCSPRequest"
    • listener: function
        • (certificate: Buffer, issuer: Buffer, callback: function): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "resumeSession"
    • listener: function
        • (sessionId: Buffer, callback: function): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "secureConnection"
    • listener: function

    Returns this

  • Parameters

    Returns this

prependListener

  • prependListener(event: string, listener: function): this
  • prependListener(event: "tlsClientError", listener: function): this
  • prependListener(event: "newSession", listener: function): this
  • prependListener(event: "OCSPRequest", listener: function): this
  • prependListener(event: "resumeSession", listener: function): this
  • prependListener(event: "secureConnection", listener: function): this
  • prependListener(event: "keylog", listener: function): this
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "tlsClientError"
    • listener: function

    Returns this

  • Parameters

    • event: "newSession"
    • listener: function
        • (sessionId: Buffer, sessionData: Buffer, callback: function): void

    Returns this

  • Parameters

    • event: "OCSPRequest"
    • listener: function
        • (certificate: Buffer, issuer: Buffer, callback: function): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "resumeSession"
    • listener: function
        • (sessionId: Buffer, callback: function): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "secureConnection"
    • listener: function

    Returns this

  • Parameters

    Returns this

prependOnceListener

  • prependOnceListener(event: string, listener: function): this
  • prependOnceListener(event: "tlsClientError", listener: function): this
  • prependOnceListener(event: "newSession", listener: function): this
  • prependOnceListener(event: "OCSPRequest", listener: function): this
  • prependOnceListener(event: "resumeSession", listener: function): this
  • prependOnceListener(event: "secureConnection", listener: function): this
  • prependOnceListener(event: "keylog", listener: function): this
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "tlsClientError"
    • listener: function

    Returns this

  • Parameters

    • event: "newSession"
    • listener: function
        • (sessionId: Buffer, sessionData: Buffer, callback: function): void

    Returns this

  • Parameters

    • event: "OCSPRequest"
    • listener: function
        • (certificate: Buffer, issuer: Buffer, callback: function): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "resumeSession"
    • listener: function
        • (sessionId: Buffer, callback: function): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "secureConnection"
    • listener: function

    Returns this

  • Parameters

    Returns this

rawListeners

  • rawListeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

ref

  • ref(): this
  • 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
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

setSecureContext

  • The server.setSecureContext() method replaces the secure context of an existing server. Existing connections to the server are not interrupted.

    Parameters

    Returns void

setTicketKeys

  • setTicketKeys(keys: Buffer): void
  • The server.setSecureContext() method replaces the secure context of an existing server. Existing connections to the server are not interrupted.

    Parameters

    Returns void

unref

  • unref(): this
  • Returns this

Generated using TypeDoc