:orphan: .. index:: pair: group; TAPI to manage memcached .. _doxid-group__tapi__memcached: TAPI to manage memcached ======================== .. toctree:: :hidden: enum_tapi_mamcached_proto.rst enum_tapi_mamcached_verbose.rst struct_tapi_memcached_app.rst struct_tapi_memcached_opt.rst Overview ~~~~~~~~ TAPI to manage *memcached*. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`tapi_memcached_app` :ref:`tapi_memcached_app`; typedef enum :ref:`tapi_mamcached_proto` :ref:`tapi_mamcached_proto_t`; typedef enum :ref:`tapi_mamcached_verbose` :ref:`tapi_mamcached_verbose_t`; typedef struct :ref:`tapi_memcached_opt` :ref:`tapi_memcached_opt`; // enums enum :ref:`tapi_mamcached_proto`; enum :ref:`tapi_mamcached_verbose`; // structs struct :ref:`tapi_memcached_app`; struct :ref:`tapi_memcached_opt`; // global variables const struct sockaddr_in :ref:`zero_sockaddr`; const :ref:`tapi_memcached_opt` :ref:`tapi_memcached_default_opt`; // global functions :ref:`te_errno` :ref:`tapi_memcached_create`(:ref:`tapi_job_factory_t`* factory, const :ref:`tapi_memcached_opt`* opt, :ref:`tapi_memcached_app`** app); :ref:`te_errno` :ref:`tapi_memcached_start`(const :ref:`tapi_memcached_app`* app); :ref:`te_errno` :ref:`tapi_memcached_wait`(const :ref:`tapi_memcached_app`* app, int timeout_ms); :ref:`te_errno` :ref:`tapi_memcached_stop`(const :ref:`tapi_memcached_app`* app); :ref:`te_errno` :ref:`tapi_memcached_kill`(const :ref:`tapi_memcached_app`* app, int signum); :ref:`te_errno` :ref:`tapi_memcached_destroy`(:ref:`tapi_memcached_app`* app); .. _details-group__tapi__memcached: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ TAPI to manage *memcached*. Copyright (C) 2022-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; tapi_memcached_app .. _doxid-group__tapi__memcached_1ga7928ef435cb661cb09746b55598c639e: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_memcached_app` tapi_memcached_app memcached tool information. .. index:: pair: typedef; tapi_mamcached_proto_t .. _doxid-group__tapi__memcached_1gac61bd08b0d0f5345ca14e293087eea9b: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_mamcached_proto` tapi_mamcached_proto_t Representation of possible values for memcached::protocol option. .. index:: pair: typedef; tapi_mamcached_verbose_t .. _doxid-group__tapi__memcached_1ga2293656d27dd40f0931feb09f8714ee2: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`tapi_mamcached_verbose` tapi_mamcached_verbose_t Representation of possible values for memcached::verbose option. .. index:: pair: typedef; tapi_memcached_opt .. _doxid-group__tapi__memcached_1ga05d536419058a6b943d62b69819eef4a: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_memcached_opt` tapi_memcached_opt Specific memcached options. Global Variables ---------------- .. index:: pair: variable; zero_sockaddr .. _doxid-group__tapi__memcached_1ga8fcbe30c41e10ded18c58f44f77645d7: .. ref-code-block:: cpp :class: doxyrest-title-code-block const struct sockaddr_in zero_sockaddr Constant for sockaddr "0.0.0.0:0" initialization. Can be used when there is a need to use localhost or zero port. .. index:: pair: variable; tapi_memcached_default_opt .. _doxid-group__tapi__memcached_1ga1b85287dad7b2c8ef8cad319135549a4: .. ref-code-block:: cpp :class: doxyrest-title-code-block const :ref:`tapi_memcached_opt` tapi_memcached_default_opt Default memcached options initializer. Global Functions ---------------- .. index:: pair: function; tapi_memcached_create .. _doxid-group__tapi__memcached_1gae5a74d73b834bf7da36308d57561be4d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_memcached_create(:ref:`tapi_job_factory_t`* factory, const :ref:`tapi_memcached_opt`* opt, :ref:`tapi_memcached_app`** app) Create memcached app. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - factory - Job factory. * - opt - memcached options. * - app - memcached app handle. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_memcached_start .. _doxid-group__tapi__memcached_1ga6dd62988ef1e9c2d3ae072de324660f3: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_memcached_start(const :ref:`tapi_memcached_app`* app) Start memcached. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - memcached app handle. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_memcached_wait .. _doxid-group__tapi__memcached_1gac6b0b4894b40f155518b10958435c552: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_memcached_wait(const :ref:`tapi_memcached_app`* app, int timeout_ms) Wait for memcached completion. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - memcached app handle. * - timeout_ms - Wait timeout in milliseconds. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_memcached_stop .. _doxid-group__tapi__memcached_1ga0190d780d45d5c0129cde8aba909cbb0: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_memcached_stop(const :ref:`tapi_memcached_app`* app) Stop memcached. It can be started over with :ref:`tapi_memcached_start() `. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - memcached app handle. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_memcached_kill .. _doxid-group__tapi__memcached_1ga9d4b373088bfd6cf90ae465b2b2f28ca: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_memcached_kill(const :ref:`tapi_memcached_app`* app, int signum) Send a signal to memcached. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - memcached app handle. * - signum - Signal to send. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_memcached_destroy .. _doxid-group__tapi__memcached_1ga6b28ce312d102d3c45cd3ed0efb71a59: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_memcached_destroy(:ref:`tapi_memcached_app`* app) Destroy memcached. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - memcached app handle. .. rubric:: Returns: Status code.