Class RespServer

The redis server. Manages client request/response cycle.

Listens, by default, to env.DEFAULT_HOST (localhost) on port env.DEFAULT_PORT (6379)

Hierarchy

EventEmitter
- RespServer

Constructors

constructor

new RespServer(): RespServer
Returns RespServer
Overrides EventEmitter.constructor
- Defined in src/server/resp-server.ts:38

Properties

`Private` logger

logger: Logger = ...

`Private` server

server: Server = ...

`Private` serverContext

serverContext: IServerContext

`Static` `Private` DEFAULT_HOST

DEFAULT_HOST: string = ...

`Static` `Private` DEFAULT_PORT

DEFAULT_PORT: string | number = ...

`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

addListener

addListener(event, listener): RespServer
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns RespServer
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
Inherited from EventEmitter.emit
- Defined in node_modules/@types/node/globals.d.ts:579

eventNames

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

getMaxListeners

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

listenerCount

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

listeners

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

off

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

on

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

once

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

`Private` parseArray

parseArray(message, session): DefaultRequest
Parameters
- message: ArrayRedisToken
- session: Session
Returns DefaultRequest
- Defined in src/server/resp-server.ts:238

`Private` parseLine

parseLine(message, session): DefaultRequest
Parameters
- message: UnknownRedisToken
- session: Session
Returns DefaultRequest
- Defined in src/server/resp-server.ts:250

`Private` parseMessage

parseMessage(message, session): IRequest
Parameters
- message: ArrayRedisToken
- session: Session
Returns IRequest
- Defined in src/server/resp-server.ts:211

prependListener

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

prependOnceListener

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

rawListeners

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

receive

receive(session, message): void
Receive the client request, convert it to RESP format, dispatch the request then respond to the client.

Probably too busy. Should be refactored.
Parameters
- session: Session
  The client session (including socket)
- message: any
  The client request
Returns void
- Defined in src/server/resp-server.ts:60

`Private` registerConnection

registerConnection(socket): void
Register a client socket connection
Parameters
- socket: any
  client socket
Returns void
- Defined in src/server/resp-server.ts:131

removeAllListeners

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

removeListener

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

setMaxListeners

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

start

start(): void
Start the redis server

Returns void
- Defined in src/server/resp-server.ts:96

stop

stop(): Promise<void>
Stop the redis server

Returns Promise<void>
- Defined in src/server/resp-server.ts:121

`Private` toParams

toParams(message): string[]
Parameters
- message: ArrayRedisToken
Returns string[]
- Defined in src/server/resp-server.ts:264

`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 RespServer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns RespServer

Properties

Private logger

Private server

Private serverContext

Static Private DEFAULT_HOST

Static Private DEFAULT_PORT

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

addListener

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns RespServer

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

listenerCount

Parameters

type: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

off

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns RespServer

on

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns RespServer

once

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns RespServer

Private parseArray

Parameters

message: ArrayRedisToken

session: Session

Returns DefaultRequest

Private parseLine

Parameters

message: UnknownRedisToken

session: Session

Returns DefaultRequest

Private parseMessage

`Private` logger

`Private` server

`Private` serverContext

`Static` `Private` DEFAULT_HOST

`Static` `Private` DEFAULT_PORT

`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[]

`Private` parseArray

`Private` parseLine

`Private` parseMessage

`Rest` ...args: any[]

`Rest` ...args: any[]

`Private` registerConnection

`Optional` event: string | symbol

`Rest` ...args: any[]

`Private` toParams

`Static` listenerCount

`Static` on

`Static` once