Server | typescript

Interface Server

Hierarchy

Server
- Server

Index

Properties

connections

connections: number

maxConnections

maxConnections: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addContext

addContext(hostName: string, credentials: object): void

Inherited from Server.addContext
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3194
Parameters
- hostName: string
- credentials: object
  - ca: string
  - cert: string
  - key: string
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

Inherited from Server.addListener

Overrides Server.addListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3210
events.EventEmitter
1. tlsClientError
2. newSession
3. OCSPRequest
4. resumeSession
5. secureConnection
Parameters
- event: string
- listener: Function
Returns this
Inherited from Server.addListener

Overrides Server.addListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3211
Parameters
- event: "tlsClientError"
- listener: function
  - - (err: Error, tlsSocket: TLSSocket): void
    - Parameters
      - err: Error
      - tlsSocket: TLSSocket
      Returns void
Returns this
Inherited from Server.addListener

Overrides Server.addListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3212
Parameters
- event: "newSession"
- listener: function
  - - (sessionId: any, sessionData: any, callback: function): void
    - Parameters
      - sessionId: any
      - sessionData: any
      - callback: function
        
        (err: Error, resp: Buffer): void
        
        Parameters
        
        err: Error
        
        resp: Buffer
        
        Returns void
      Returns void
Returns this
Inherited from Server.addListener

Overrides Server.addListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3213
Parameters
- event: "OCSPRequest"
- listener: function
  - - (certificate: Buffer, issuer: Buffer, callback: Function): void
    - Parameters
      - certificate: Buffer
      - issuer: Buffer
      - callback: Function
      Returns void
Returns this
Inherited from Server.addListener

Overrides Server.addListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3214
Parameters
- event: "resumeSession"
- listener: function
  - - (sessionId: any, callback: function): void
    - Parameters
      - sessionId: any
      - callback: function
        
        (err: Error, sessionData: any): void
        
        Parameters
        
        err: Error
        
        sessionData: any
        
        Returns void
      Returns void
Returns this
Inherited from Server.addListener

Overrides Server.addListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3215
Parameters
- event: "secureConnection"
- listener: function
  - - (tlsSocket: TLSSocket): void
    - Parameters
      - tlsSocket: TLSSocket
      Returns void
Returns this

address

address(): object

Inherited from Server.address

Overrides Server.address
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3193
Returns object
- address: string
- family: string
- port: number

close

close(callback?: Function): Server

Inherited from Server.close

Overrides Server.close
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3192
Parameters
- Optional callback: Function
Returns Server

emit

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

Inherited from Server.emit

Overrides Server.emit
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3217
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Inherited from Server.emit

Overrides Server.emit
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3218
Parameters
- event: "tlsClientError"
- err: Error
- tlsSocket: TLSSocket
Returns boolean
Inherited from Server.emit

Overrides Server.emit
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3219
Parameters
- event: "newSession"
- sessionId: any
- sessionData: any
- callback: function
  - - (err: Error, resp: Buffer): void
    - Parameters
      - err: Error
      - resp: Buffer
      Returns void
Returns boolean
Inherited from Server.emit

Overrides Server.emit
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3220
Parameters
- event: "OCSPRequest"
- certificate: Buffer
- issuer: Buffer
- callback: Function
Returns boolean
Inherited from Server.emit

Overrides Server.emit
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3221
Parameters
- event: "resumeSession"
- sessionId: any
- callback: function
  - - (err: Error, sessionData: any): void
    - Parameters
      - err: Error
      - sessionData: any
      Returns void
Returns boolean
Inherited from Server.emit

Overrides Server.emit
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3222
Parameters
- event: "secureConnection"
- tlsSocket: TLSSocket
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:627
Returns (string | symbol)[]

getConnections

getConnections(cb: function): void

Inherited from Server.getConnections
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:2091
Parameters
- cb: function
  - - (error: Error, count: number): void
    - Parameters
      - error: Error
      - count: number
      Returns void
Returns void

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:624
Returns number

listen

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

Inherited from Server.listen
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:2080
Parameters
- port: number
- Optional hostname: string
- Optional backlog: number
- Optional listeningListener: Function
Returns Server
Inherited from Server.listen
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:2081
Parameters
- port: number
- Optional hostname: string
- Optional listeningListener: Function
Returns Server
Inherited from Server.listen
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:2082
Parameters
- port: number
- Optional backlog: number
- Optional listeningListener: Function
Returns Server
Inherited from Server.listen
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:2083
Parameters
- port: number
- Optional listeningListener: Function
Returns Server
Inherited from Server.listen
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:2084
Parameters
- path: string
- Optional backlog: number
- Optional listeningListener: Function
Returns Server
Inherited from Server.listen
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:2085
Parameters
- path: string
- Optional listeningListener: Function
Returns Server
Inherited from Server.listen
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:2086
Parameters
- options: ListenOptions
- Optional listeningListener: Function
Returns Server
Inherited from Server.listen
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:2087
Parameters
- handle: any
- Optional backlog: number
- Optional listeningListener: Function
Returns Server
Inherited from Server.listen
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:2088
Parameters
- handle: any
- Optional listeningListener: Function
Returns Server

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:628
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:625
Parameters
- event: string | symbol
Returns Function[]

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

Inherited from Server.on

Overrides Server.on
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3224
Parameters
- event: string
- listener: Function
Returns this
Inherited from Server.on

Overrides Server.on
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3225
Parameters
- event: "tlsClientError"
- listener: function
  - - (err: Error, tlsSocket: TLSSocket): void
    - Parameters
      - err: Error
      - tlsSocket: TLSSocket
      Returns void
Returns this
Inherited from Server.on

Overrides Server.on
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3226
Parameters
- event: "newSession"
- listener: function
  - - (sessionId: any, sessionData: any, callback: function): void
    - Parameters
      - sessionId: any
      - sessionData: any
      - callback: function
        
        (err: Error, resp: Buffer): void
        
        Parameters
        
        err: Error
        
        resp: Buffer
        
        Returns void
      Returns void
Returns this
Inherited from Server.on

Overrides Server.on
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3227
Parameters
- event: "OCSPRequest"
- listener: function
  - - (certificate: Buffer, issuer: Buffer, callback: Function): void
    - Parameters
      - certificate: Buffer
      - issuer: Buffer
      - callback: Function
      Returns void
Returns this
Inherited from Server.on

Overrides Server.on
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3228
Parameters
- event: "resumeSession"
- listener: function
  - - (sessionId: any, callback: function): void
    - Parameters
      - sessionId: any
      - callback: function
        
        (err: Error, sessionData: any): void
        
        Parameters
        
        err: Error
        
        sessionData: any
        
        Returns void
      Returns void
Returns this
Inherited from Server.on

Overrides Server.on
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3229
Parameters
- event: "secureConnection"
- listener: function
  - - (tlsSocket: TLSSocket): void
    - Parameters
      - tlsSocket: TLSSocket
      Returns void
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

Inherited from Server.once

Overrides Server.once
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3231
Parameters
- event: string
- listener: Function
Returns this
Inherited from Server.once

Overrides Server.once
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3232
Parameters
- event: "tlsClientError"
- listener: function
  - - (err: Error, tlsSocket: TLSSocket): void
    - Parameters
      - err: Error
      - tlsSocket: TLSSocket
      Returns void
Returns this
Inherited from Server.once

Overrides Server.once
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3233
Parameters
- event: "newSession"
- listener: function
  - - (sessionId: any, sessionData: any, callback: function): void
    - Parameters
      - sessionId: any
      - sessionData: any
      - callback: function
        
        (err: Error, resp: Buffer): void
        
        Parameters
        
        err: Error
        
        resp: Buffer
        
        Returns void
      Returns void
Returns this
Inherited from Server.once

Overrides Server.once
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3234
Parameters
- event: "OCSPRequest"
- listener: function
  - - (certificate: Buffer, issuer: Buffer, callback: Function): void
    - Parameters
      - certificate: Buffer
      - issuer: Buffer
      - callback: Function
      Returns void
Returns this
Inherited from Server.once

Overrides Server.once
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3235
Parameters
- event: "resumeSession"
- listener: function
  - - (sessionId: any, callback: function): void
    - Parameters
      - sessionId: any
      - callback: function
        
        (err: Error, sessionData: any): void
        
        Parameters
        
        err: Error
        
        sessionData: any
        
        Returns void
      Returns void
Returns this
Inherited from Server.once

Overrides Server.once
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3236
Parameters
- event: "secureConnection"
- listener: function
  - - (tlsSocket: TLSSocket): void
    - Parameters
      - tlsSocket: TLSSocket
      Returns void
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

Inherited from Server.prependListener

Overrides Server.prependListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3238
Parameters
- event: string
- listener: Function
Returns this
Inherited from Server.prependListener

Overrides Server.prependListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3239
Parameters
- event: "tlsClientError"
- listener: function
  - - (err: Error, tlsSocket: TLSSocket): void
    - Parameters
      - err: Error
      - tlsSocket: TLSSocket
      Returns void
Returns this
Inherited from Server.prependListener

Overrides Server.prependListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3240
Parameters
- event: "newSession"
- listener: function
  - - (sessionId: any, sessionData: any, callback: function): void
    - Parameters
      - sessionId: any
      - sessionData: any
      - callback: function
        
        (err: Error, resp: Buffer): void
        
        Parameters
        
        err: Error
        
        resp: Buffer
        
        Returns void
      Returns void
Returns this
Inherited from Server.prependListener

Overrides Server.prependListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3241
Parameters
- event: "OCSPRequest"
- listener: function
  - - (certificate: Buffer, issuer: Buffer, callback: Function): void
    - Parameters
      - certificate: Buffer
      - issuer: Buffer
      - callback: Function
      Returns void
Returns this
Inherited from Server.prependListener

Overrides Server.prependListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3242
Parameters
- event: "resumeSession"
- listener: function
  - - (sessionId: any, callback: function): void
    - Parameters
      - sessionId: any
      - callback: function
        
        (err: Error, sessionData: any): void
        
        Parameters
        
        err: Error
        
        sessionData: any
        
        Returns void
      Returns void
Returns this
Inherited from Server.prependListener

Overrides Server.prependListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3243
Parameters
- event: "secureConnection"
- listener: function
  - - (tlsSocket: TLSSocket): void
    - Parameters
      - tlsSocket: TLSSocket
      Returns void
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

Inherited from Server.prependOnceListener

Overrides Server.prependOnceListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3245
Parameters
- event: string
- listener: Function
Returns this
Inherited from Server.prependOnceListener

Overrides Server.prependOnceListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3246
Parameters
- event: "tlsClientError"
- listener: function
  - - (err: Error, tlsSocket: TLSSocket): void
    - Parameters
      - err: Error
      - tlsSocket: TLSSocket
      Returns void
Returns this
Inherited from Server.prependOnceListener

Overrides Server.prependOnceListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3247
Parameters
- event: "newSession"
- listener: function
  - - (sessionId: any, sessionData: any, callback: function): void
    - Parameters
      - sessionId: any
      - sessionData: any
      - callback: function
        
        (err: Error, resp: Buffer): void
        
        Parameters
        
        err: Error
        
        resp: Buffer
        
        Returns void
      Returns void
Returns this
Inherited from Server.prependOnceListener

Overrides Server.prependOnceListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3248
Parameters
- event: "OCSPRequest"
- listener: function
  - - (certificate: Buffer, issuer: Buffer, callback: Function): void
    - Parameters
      - certificate: Buffer
      - issuer: Buffer
      - callback: Function
      Returns void
Returns this
Inherited from Server.prependOnceListener

Overrides Server.prependOnceListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3249
Parameters
- event: "resumeSession"
- listener: function
  - - (sessionId: any, callback: function): void
    - Parameters
      - sessionId: any
      - callback: function
        
        (err: Error, sessionData: any): void
        
        Parameters
        
        err: Error
        
        sessionData: any
        
        Returns void
      Returns void
Returns this
Inherited from Server.prependOnceListener

Overrides Server.prependOnceListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:3250
Parameters
- event: "secureConnection"
- listener: function
  - - (tlsSocket: TLSSocket): void
    - Parameters
      - tlsSocket: TLSSocket
      Returns void
Returns this

ref

ref(): Server

Inherited from Server.ref
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:2092
Returns Server

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:622
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:621
Parameters
- event: string | symbol
- listener: Function
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:623
Parameters
- n: number
Returns this

unref

unref(): Server

Inherited from Server.unref
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:2093
Returns Server

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in workspace/scion-scxml-platform/projects/SCION/node_modules/@types/node/index.d.ts:613
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc

Hierarchy

Index

Properties

Methods

Properties

connections

maxConnections

Static defaultMaxListeners

Methods

addContext

Parameters

hostName: string

credentials: object

ca: string

cert: string

key: string

Returns void

addListener

Parameters

event: string

listener: Function

Returns this

Parameters

event: "tlsClientError"

listener: function

Parameters

err: Error

tlsSocket: TLSSocket

Returns void

Returns this

Parameters

event: "newSession"

listener: function

Parameters

sessionId: any

sessionData: any

callback: function

Parameters

err: Error

resp: Buffer

Returns void

Returns void

Returns this

Parameters

event: "OCSPRequest"

listener: function

Parameters

certificate: Buffer

issuer: Buffer

callback: Function

Returns void

Returns this

Parameters

event: "resumeSession"

listener: function

Parameters

sessionId: any

callback: function

Parameters

err: Error

sessionData: any

Returns void

Returns void

Returns this

Parameters

event: "secureConnection"

listener: function

Parameters

tlsSocket: TLSSocket

Returns void

Returns this

address

Returns object

address: string

family: string

port: number

close

Parameters

Optional callback: Function

Returns Server