@iobroker/db-base 4.0.21 → 4.1.0-alpha.0-20220819-74ceeddc

package/build/lib/redisHandler.d.ts

@@ -0,0 +1,165 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import type { Socket } from 'net';
+import { EventEmitter } from 'events';
+import type { InternalLogger } from '@iobroker/js-controller-common/tools';
+declare type NestedArray<T> = T[] | NestedArray<T>[];
+interface RedisHandlerOptions {
+    log: InternalLogger;
+    logScope?: string;
+    handleAsBuffers: boolean;
+    enhancedLogging?: boolean;
+}
+interface MultiCallElement {
+    responseIds: ResponseId[];
+    execCalled: boolean;
+    responseCount: number;
+    responseMap: Map<ResponseId, Buffer | null>;
+    execId?: ResponseId;
+}
+interface FullMultiCallElement extends MultiCallElement {
+    execId: ResponseId;
+}
+declare type ResponseId = number | null;
+/**
+ * Class to handle a redis connection and provide events to react on for
+ * all incoming Redis commands
+ */
+export declare class RedisHandler extends EventEmitter {
+    private readonly socket;
+    private readonly logScope;
+    private readonly handleBuffers;
+    private readonly options;
+    private readonly log;
+    private readonly socketId;
+    private initialized;
+    private stop;
+    private readonly activeMultiCalls;
+    private readonly writeQueue;
+    private readonly resp;
+    /**
+     * Initialize and register all data handlers to send out events on new commands
+     * @param socket Network Socket/Connection
+     * @param options options objects, currently mainly for logger
+     */
+    constructor(socket: Socket, options: RedisHandlerOptions);
+    /**
+     * Handle one incoming command, assign responseId and emit event to be handled
+     * @param data Array RESP data
+     * @private
+     */
+    _handleCommand(data: any[]): void;
+    /**
+     * Check if the response to a certain command can be send out directly or
+     * if it needs to wait till earlier responses are ready
+     * @param responseId ID of the response
+     * @param data Buffer to send out
+     * @private
+     */
+    _sendQueued(responseId: ResponseId, data: Buffer): void;
+    /**
+     * Really write out a response to the network connection
+     * @param data Buffer to send out
+     * @private
+     */
+    _write(data: Buffer): void;
+    /**
+     * Guard to make sure a response is valid to be sent out
+     * @param responseId ID of the response
+     * @param data Buffer to send out
+     */
+    sendResponse(responseId: ResponseId, data: Buffer): void;
+    /**
+     * Close network connection
+     */
+    close(): void;
+    /**
+     * Return if socket/handler active or closed
+     * @returns is Handler/Connection active (not closed)
+     */
+    isActive(): boolean;
+    /**
+     * Encode RESP's Null value to RESP buffer and send out
+     * @param responseId ID of the response
+     */
+    sendNull(responseId: ResponseId): void;
+    /**
+     * Encode RESP's Null Array value to RESP buffer and send out
+     * @param responseId ID of the response
+     */
+    sendNullArray(responseId: ResponseId): void;
+    /**
+     * Encode string to RESP buffer and send out
+     * @param responseId ID od the response
+     * @param str String to encode
+     */
+    sendString(responseId: ResponseId, str: string): void;
+    /**
+     * Encode error object to RESP buffer and send out
+     * @param responseId ID of the response
+     * @param error Error object with error details to send out
+     */
+    sendError(responseId: ResponseId, error: Error): void;
+    /**
+     * Encode integer to RESP buffer and send out
+     * @param responseId ID of the response
+     * @param num Integer to send out
+     */
+    sendInteger(responseId: ResponseId, num: number): void;
+    /**
+     * Encode RESP's bulk string to RESP buffer and send out
+     * @param responseId ID of the response
+     * @param str String to send out
+     */
+    sendBulk(responseId: ResponseId, str: string): void;
+    /**
+     * Encode RESP's bulk buffer to RESP buffer.
+     * @param responseId ID of the response
+     * @param buf Buffer to send out
+     */
+    sendBufBulk(responseId: ResponseId, buf: Buffer): void;
+    /**
+     * Encode an Array depending on the type of the elements
+     * @param arr Array to encode
+     * @returns Array with Buffers with encoded values
+     */
+    encodeRespArray(arr: unknown[]): NestedArray<Buffer>;
+    /**
+     * Encode a array values to buffers and send out
+     * @param responseId ID of the response
+     * @param arr Array to send out
+     */
+    sendArray(responseId: ResponseId, arr: any[]): void;
+    /**
+     * Handles a 'multi' command
+     *
+     * @private
+     */
+    _handleMulti(): void;
+    /**
+     * Handles an 'exec' command
+     *
+     * @param {number} responseId ID of the response
+     * @private
+     */
+    _handleExec(responseId: ResponseId): void;
+    /**
+     * Builds up the exec response and sends it
+     * @param multiObj the multi object to send out
+     *
+     * @private
+     */
+    _sendExecResponse(multiObj: FullMultiCallElement): void;
+    /**
+     * Handles a multi response
+     *
+     * @param responseId ID of the response
+     * @param index index of the multi call
+     * @param buf buffer to include in response
+     * @private
+     */
+    _handleMultiResponse(responseId: ResponseId, index: number, buf: Buffer): void;
+}
+export {};
+//# sourceMappingURL=redisHandler.d.ts.map

package/build/lib/redisHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"redisHandler.d.ts","sourceRoot":"","sources":["../../src/lib/redisHandler.ts"],"names":[],"mappings":";;;AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,KAAK,CAAC;AAGlC,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAE3E,aAAK,WAAW,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;AAE7C,UAAU,mBAAmB;IAEzB,GAAG,EAAE,cAAc,CAAC;IAEpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,eAAe,EAAE,OAAO,CAAC;IAEzB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC7B;AAcD,UAAU,gBAAgB;IAEtB,WAAW,EAAE,UAAU,EAAE,CAAC;IAE1B,UAAU,EAAE,OAAO,CAAC;IAEpB,aAAa,EAAE,MAAM,CAAC;IAEtB,WAAW,EAAE,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC;IAE5C,MAAM,CAAC,EAAE,UAAU,CAAC;CACvB;AAED,UAAU,oBAAqB,SAAQ,gBAAgB;IAEnD,MAAM,EAAE,UAAU,CAAC;CACtB;AAGD,aAAK,UAAU,GAAG,MAAM,GAAG,IAAI,CAAC;AAEhC;;;GAGG;AACH,qBAAa,YAAa,SAAQ,YAAY;IAC1C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAU;IACxC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsB;IAC9C,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAiB;IACrC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,WAAW,CAAU;IAC7B,OAAO,CAAC,IAAI,CAAU;IACtB,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAqB;IACtD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAsB;IACjD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAM;IAE3B;;;;OAIG;gBACS,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB;IAgExD;;;;OAIG;IACH,cAAc,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI;IAmEjC;;;;;;OAMG;IACH,WAAW,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IA8CvD;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAI1B;;;;OAIG;IACH,YAAY,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAmBxD;;OAEG;IACH,KAAK,IAAI,IAAI;IAMb;;;OAGG;IACH,QAAQ,IAAI,OAAO;IAInB;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAWtC;;;OAGG;IACH,aAAa,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAW3C;;;;OAIG;IACH,UAAU,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAWrD;;;;OAIG;IACH,SAAS,CAAC,UAAU,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI;IAarD;;;;OAIG;IACH,WAAW,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAWtD;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAWnD;;;;OAIG;IACH,WAAW,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAWtD;;;;OAIG;IACH,eAAe,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC;IAmBpD;;;;OAIG;IACH,SAAS,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;IAWnD;;;;OAIG;IACH,YAAY,IAAI,IAAI;IASpB;;;;;OAKG;IACH,WAAW,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAgBzC;;;;;OAKG;IACH,iBAAiB,CAAC,QAAQ,EAAE,oBAAoB,GAAG,IAAI;IAUvD;;;;;;;OAOG;IACH,oBAAoB,CAAC,UAAU,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;CAWjF"}