Class RespServerContext

Hierarchy

EventEmitter
- RespServerContext

Implements

IServerContext

Constructors

constructor

new RespServerContext(host, port, commands): RespServerContext
Instantiate the server contect. Database ZERO is instantiated by default. Others will be dynamically added.
Parameters
- host: string
  The host or IP that we're listening to
- port: number
  The port we're listening to
- commands: CommandSuite
  An empty command suite
Returns RespServerContext
Overrides EventEmitter.constructor
- Defined in src/server/resp-server-context.ts:31

Properties

`Private` clients

clients: Dictionary<string, Socket> = ...

`Private` commands

commands: CommandSuite

An empty command suite

`Private` databases

databases: Dictionary<string, Database> = ...

`Private` host

host: string

The host or IP that we're listening to

`Private` logger

logger: Logger = ...

`Private` port

port: number

The port we're listening to

`Private` scripts

scripts: Dictionary<string, string> = ...

`Private` state

state: Dictionary<string, string> = ...

`Static` `Readonly` captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

`Static` captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

`Static` defaultMaxListeners

defaultMaxListeners: number

`Static` `Readonly` errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addClient

addClient(clientId, client): void
Parameters
- clientId: string
- client: Session
Returns void
Implementation of IServerContext.addClient
- Defined in src/server/resp-server-context.ts:87

addListener

addListener(event, listener): RespServerContext
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns RespServerContext
Implementation of IServerContext.addListener
Inherited from EventEmitter.addListener
- Defined in node_modules/@types/node/globals.d.ts:569

emit

emit(event, ...args): boolean
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Implementation of IServerContext.emit
Inherited from EventEmitter.emit
- Defined in node_modules/@types/node/globals.d.ts:579

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Implementation of IServerContext.eventNames
Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/globals.d.ts:584

flush

flush(): void
Returns void
Implementation of IServerContext.flush
- Defined in src/server/resp-server-context.ts:119

getClientCount

getClientCount(): number
Returns number
Implementation of IServerContext.getClientCount
- Defined in src/server/resp-server-context.ts:64

getClients

getClients(): Dictionary<string, Session>
Returns Dictionary<string, Session>
Implementation of IServerContext.getClients
- Defined in src/server/resp-server-context.ts:60

getCommand

getCommand(name): IRespCommand
Parameters
- name: string
Returns IRespCommand
Implementation of IServerContext.getCommand
- Defined in src/server/resp-server-context.ts:68

getDatabase

getDatabase(id): Database
The limit of 16 databases is enforced in the SELECT
Parameters
- id: number
  ordinal db number
Returns Database
Implementation of IServerContext.getDatabase
- Defined in src/server/resp-server-context.ts:103

getHost

getHost(): string
Returns string
Implementation of IServerContext.getHost
- Defined in src/server/resp-server-context.ts:52

getMaxListeners

getMaxListeners(): number
Returns number
Implementation of IServerContext.getMaxListeners
Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:576

getPort

getPort(): number
Returns number
Implementation of IServerContext.getPort
- Defined in src/server/resp-server-context.ts:56

getScript

getScript(sha1): string
Retrieve the lua script identified by the sha1
Parameters
- sha1: string
  previously calculated sha1
Returns string
Implementation of IServerContext.getScript
- Defined in src/server/resp-server-context.ts:145

getString

getString(sha1): string
Parameters
- sha1: string
Returns string
- Defined in src/server/resp-server-context.ts:115

getValue

getValue(key): any
Parameters
- key: string
Returns any
Implementation of IServerContext.getValue
- Defined in src/server/resp-server-context.ts:72

listenerCount

listenerCount(type): number
Parameters
- type: string | symbol
Returns number
Implementation of IServerContext.listenerCount
Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/globals.d.ts:580

listeners

listeners(event): Function[]
Parameters
- event: string | symbol
Returns Function[]
Implementation of IServerContext.listeners
Inherited from EventEmitter.listeners
- Defined in node_modules/@types/node/globals.d.ts:577

off

off(event, listener): RespServerContext
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns RespServerContext
Implementation of IServerContext.off
Inherited from EventEmitter.off
- Defined in node_modules/@types/node/globals.d.ts:573

on

on(event, listener): RespServerContext
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns RespServerContext
Implementation of IServerContext.on
Inherited from EventEmitter.on
- Defined in node_modules/@types/node/globals.d.ts:570

once

once(event, listener): RespServerContext
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns RespServerContext
Implementation of IServerContext.once
Inherited from EventEmitter.once
- Defined in node_modules/@types/node/globals.d.ts:571

prependListener

prependListener(event, listener): RespServerContext
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns RespServerContext
Implementation of IServerContext.prependListener
Inherited from EventEmitter.prependListener
- Defined in node_modules/@types/node/globals.d.ts:582

prependOnceListener

prependOnceListener(event, listener): RespServerContext
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns RespServerContext
Implementation of IServerContext.prependOnceListener
Inherited from EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/globals.d.ts:583

publish

publish(channel, message): number
Parameters
- channel: string
- message: string
Returns number
Implementation of IServerContext.publish
- Defined in src/server/resp-server-context.ts:40

putValue

putValue(key, value): void
Parameters
- key: string
- value: any
Returns void
Implementation of IServerContext.putValue
- Defined in src/server/resp-server-context.ts:76

rawListeners

rawListeners(event): Function[]
Parameters
- event: string | symbol
Returns Function[]
Implementation of IServerContext.rawListeners
Inherited from EventEmitter.rawListeners
- Defined in node_modules/@types/node/globals.d.ts:578

removeAllListeners

removeAllListeners(event?): RespServerContext
Parameters
- Optional event: string | symbol
Returns RespServerContext
Implementation of IServerContext.removeAllListeners
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/globals.d.ts:574

removeClient

removeClient(clientId): void
Parameters
- clientId: string
Returns void
Implementation of IServerContext.removeClient
- Defined in src/server/resp-server-context.ts:94

removeListener

removeListener(event, listener): RespServerContext
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns RespServerContext
Implementation of IServerContext.removeListener
Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/node/globals.d.ts:572

removeValue

removeValue(key): void
Parameters
- key: string
Returns void
Implementation of IServerContext.removeValue
- Defined in src/server/resp-server-context.ts:83

scriptExists

scriptExists(sha1): boolean
Check if a script exists
Parameters
- sha1: string
  sha1 of the script
Returns boolean
Implementation of IServerContext.scriptExists
- Defined in src/server/resp-server-context.ts:154

setMaxListeners

setMaxListeners(n): RespServerContext
Parameters
- n: number
Returns RespServerContext
Implementation of IServerContext.setMaxListeners
Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:575

setScript

setScript(code): string
Calculate and return the sha1 of code. Store the code using sha1 as the key.
Parameters
- code: string
  lua code script
Returns string
Implementation of IServerContext.setScript
- Defined in src/server/resp-server-context.ts:129

`Static` listenerCount

listenerCount(emitter, event): number
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number
Deprecated
since v4.0.0
Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:26

`Static` on

on(emitter, event): AsyncIterableIterator<any>
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>
Inherited from EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:23

`Static` once

once(emitter, event): Promise<any[]>
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:21
once(emitter, event): Promise<any[]>
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>
Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:22

Class RespServerContext

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

host: string

port: number

commands: CommandSuite

Returns RespServerContext

Properties

Private clients

Private commands

Private databases

Private host

Private logger

Private port

Private scripts

Private state

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

addClient

Parameters

clientId: string

client: Session

Returns void

addListener

Parameters

event: string | symbol

listener: ((...args) => void)

Parameters

Rest ...args: any[]

Returns void

Returns RespServerContext

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

flush

Returns void

getClientCount

Returns number

getClients

Returns Dictionary<string, Session>

getCommand

Parameters

name: string

Returns IRespCommand

getDatabase

Parameters

id: number

Returns Database

getHost

Returns string

getMaxListeners

Returns number

getPort

Returns number

getScript

Parameters

sha1: string

Returns string

getString

Parameters

sha1: string

Returns string

getValue

Parameters

key: string

Returns any

`Private` clients

`Private` commands

`Private` databases

`Private` host

`Private` logger

`Private` port

`Private` scripts

`Private` state

`Static` `Readonly` captureRejectionSymbol

`Static` captureRejections

`Static` defaultMaxListeners

`Static` `Readonly` errorMonitor

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` event: string | symbol