:orphan: .. index:: pair: group; redis-server tool TAPI (tapi_redis_srv) .. _doxid-group__tapi__redis__srv: redis-server tool TAPI (tapi_redis_srv) ======================================= .. toctree:: :hidden: enum_tapi_redis_srv_loglevel.rst enum_tapi_redis_srv_rdl.rst struct_tapi_redis_srv_app.rst struct_tapi_redis_srv_opt.rst Overview ~~~~~~~~ TAPI to handle redis-server tool. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`tapi_redis_srv_app` :ref:`tapi_redis_srv_app`; typedef enum :ref:`tapi_redis_srv_loglevel` :ref:`tapi_redis_srv_loglevel`; typedef enum :ref:`tapi_redis_srv_rdl` :ref:`tapi_redis_srv_rdl`; typedef struct :ref:`tapi_redis_srv_opt` :ref:`tapi_redis_srv_opt`; // enums enum :ref:`tapi_redis_srv_loglevel`; enum :ref:`tapi_redis_srv_rdl`; // structs struct :ref:`tapi_redis_srv_app`; struct :ref:`tapi_redis_srv_opt`; // global variables const :ref:`tapi_redis_srv_opt` :ref:`tapi_redis_srv_default_opt`; // global functions :ref:`te_errno` :ref:`tapi_redis_srv_create`(:ref:`tapi_job_factory_t`* factory, :ref:`tapi_redis_srv_opt`* opt, :ref:`tapi_redis_srv_app`** app); :ref:`te_errno` :ref:`tapi_redis_srv_start`(const :ref:`tapi_redis_srv_app`* app); :ref:`te_errno` :ref:`tapi_redis_srv_wait`(const :ref:`tapi_redis_srv_app`* app, int timeout_ms); :ref:`te_errno` :ref:`tapi_redis_srv_stop`(const :ref:`tapi_redis_srv_app`* app); :ref:`te_errno` :ref:`tapi_redis_srv_kill`(const :ref:`tapi_redis_srv_app`* app, int signum); :ref:`te_errno` :ref:`tapi_redis_srv_destroy`(:ref:`tapi_redis_srv_app`* app); // macros #define :target:`TAPI_REDIS_SRV_TIMEOUT_MS` .. _details-group__tapi__redis__srv: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ TAPI to handle redis-server tool. Copyright (C) 2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; tapi_redis_srv_app .. _doxid-group__tapi__redis__srv_1ga55c05992b0747e7eb6818474deaa0b1c: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_redis_srv_app` tapi_redis_srv_app Redis-server tool information. .. index:: pair: typedef; tapi_redis_srv_loglevel .. _doxid-group__tapi__redis__srv_1ga77cf886b12c76b3530bdb5eaf230af60: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_redis_srv_loglevel` tapi_redis_srv_loglevel Representation of possible values for loglevel option. .. index:: pair: typedef; tapi_redis_srv_rdl .. _doxid-group__tapi__redis__srv_1ga8fef64f88db1113b4a3fc9c03e41317d: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_redis_srv_rdl` tapi_redis_srv_rdl Representation of possible values for repl_diskless_load option. .. index:: pair: typedef; tapi_redis_srv_opt .. _doxid-group__tapi__redis__srv_1gaabc405a7df5db978dec8b2e73772b577: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_redis_srv_opt` tapi_redis_srv_opt Redis-server configuration options. Global Variables ---------------- .. index:: pair: variable; tapi_redis_srv_default_opt .. _doxid-group__tapi__redis__srv_1ga06bee42a8409bc96c32690a3d34464a7: .. ref-code-block:: cpp :class: doxyrest-title-code-block const :ref:`tapi_redis_srv_opt` tapi_redis_srv_default_opt Redis-server configuration file default options. Global Functions ---------------- .. index:: pair: function; tapi_redis_srv_create .. _doxid-group__tapi__redis__srv_1ga66ae732be41243eb5c5437162f6938de: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_redis_srv_create(:ref:`tapi_job_factory_t`* factory, :ref:`tapi_redis_srv_opt`* opt, :ref:`tapi_redis_srv_app`** app) Create redis-server configuration file on TA. Create redis-server app. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - factory - job factory * - opt - redis-server options * - app - redis-server app handle .. rubric:: Returns: Status code. .. index:: pair: function; tapi_redis_srv_start .. _doxid-group__tapi__redis__srv_1gac5c4b758871fcdedf5120cb0318113bb: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_redis_srv_start(const :ref:`tapi_redis_srv_app`* app) Start redis-server. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - redis-server app handle .. rubric:: Returns: Status code. .. index:: pair: function; tapi_redis_srv_wait .. _doxid-group__tapi__redis__srv_1ga7c0ed04611c7a56cff6aef06e3a3b349: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_redis_srv_wait(const :ref:`tapi_redis_srv_app`* app, int timeout_ms) Wait for redis-server completion. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - redis-server app handle * - timeout_ms - wait timeout in milliseconds .. rubric:: Returns: Status code. .. index:: pair: function; tapi_redis_srv_stop .. _doxid-group__tapi__redis__srv_1ga3564ee4e3284bb4757231c781f3f0eed: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_redis_srv_stop(const :ref:`tapi_redis_srv_app`* app) Stop redis-server. It can be started over with :ref:`tapi_redis_srv_start `. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - redis-server app handle .. rubric:: Returns: Status code. .. index:: pair: function; tapi_redis_srv_kill .. _doxid-group__tapi__redis__srv_1gac85ec7179fb8db94bf304bf17b235dcb: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_redis_srv_kill(const :ref:`tapi_redis_srv_app`* app, int signum) Send a signal to redis-server. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - redis-server app handle * - signum - signal to send .. rubric:: Returns: Status code. .. index:: pair: function; tapi_redis_srv_destroy .. _doxid-group__tapi__redis__srv_1gaa26bfde26a8648b2ff719c745c237905: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_redis_srv_destroy(:ref:`tapi_redis_srv_app`* app) Destroy redis-server. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - redis app handle .. rubric:: Returns: Status code.