<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.5">
  <compounddef id="group__integer" kind="group">
    <compoundname>integer</compoundname>
    <title>Integer operations</title>
      <sectiondef kind="func">
      <memberdef kind="function" id="group__integer_1gab32a0cebd83b03fbf9e9c6c4afe8efd2" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_int_put</definition>
        <argsstring>(qdb_handle_t handle, const char *alias, qdb_int_t integer, qdb_time_t expiry_time)</argsstring>
        <name>qdb_int_put</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>alias</declname>
        </param>
        <param>
          <type><ref refid="group__client_1ga17492cb84da5466d0c742f0561df6597" kindref="member">qdb_int_t</ref></type>
          <declname>integer</declname>
        </param>
        <param>
          <type><ref refid="group__client_1ga4745ed10b405291a321ec7150368a4b1" kindref="member">qdb_time_t</ref></type>
          <declname>expiry_time</declname>
        </param>
        <briefdescription>
<para>Creates a new signed 64-bit integer. </para>        </briefdescription>
        <detaileddescription>
<para>Atomically creates an entry of the given alias and sets it to a cross-platform signed 64-bit integer. If the entry already exists, the function returns an error.</para><para>You can specify an expiry or use qdb_never_expires if you don&apos;t want the entry to expire.</para><para>If you want to create or update an entry use <ref refid="group__integer_1ga0fbe264da4dee45294b893f3146a2c28" kindref="member">qdb_int_update</ref>.</para><para>The value will be correctly translated independently of the endianness of the client&apos;s platform.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>alias</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a null-terminated UTF-8 string representing the alias of the entry.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>integer</parametername>
</parameternamelist>
<parameterdescription>
<para>The value to which the integer must be set.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>expiry_time</parametername>
</parameternamelist>
<parameterdescription>
<para>An optional absolute expiry time expressed in UTC UNIX epoch.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure. </para></simplesect>
<simplesect kind="see"><para><ref refid="group__integer_1ga0fbe264da4dee45294b893f3146a2c28" kindref="member">qdb_int_update</ref>, <ref refid="group__integer_1gad5d98664f4e7318e1ae95083b50bc227" kindref="member">qdb_int_get</ref>, <ref refid="group__integer_1ga1c2b514094983bffbfb0c9fdb3c9e822" kindref="member">qdb_int_add</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/integer.h" line="71" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__integer_1ga0fbe264da4dee45294b893f3146a2c28" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_int_update</definition>
        <argsstring>(qdb_handle_t handle, const char *alias, qdb_int_t integer, qdb_time_t expiry_time)</argsstring>
        <name>qdb_int_update</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>alias</declname>
        </param>
        <param>
          <type><ref refid="group__client_1ga17492cb84da5466d0c742f0561df6597" kindref="member">qdb_int_t</ref></type>
          <declname>integer</declname>
        </param>
        <param>
          <type><ref refid="group__client_1ga4745ed10b405291a321ec7150368a4b1" kindref="member">qdb_time_t</ref></type>
          <declname>expiry_time</declname>
        </param>
        <briefdescription>
<para>Creates or updates a signed 64-bit integer. </para>        </briefdescription>
        <detaileddescription>
<para>Atomically updates an entry of the given alias to the provided value. If the entry doesn&apos;t exist, it will be created. If the entry is not an integer, the function will return <ref refid="group__error_1gga365e768c3ca0f6387d8798eb98c40443a1ed20b3d0f469a2c89a88f2f62a435ab" kindref="member">qdb_e_incompatible_type</ref>.</para><para>You can specify an expiry time or use qdb_never_expires if you don&apos;t want the entry to expire.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>alias</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a null-terminated UTF-8 string representing the alias of the entry.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>integer</parametername>
</parameternamelist>
<parameterdescription>
<para>The value to which the integer must be set.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>expiry_time</parametername>
</parameternamelist>
<parameterdescription>
<para>An optional absolute expiry time expressed in UTC UNIX epoch.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure. </para></simplesect>
<simplesect kind="see"><para><ref refid="group__integer_1gab32a0cebd83b03fbf9e9c6c4afe8efd2" kindref="member">qdb_int_put</ref>, <ref refid="group__integer_1gad5d98664f4e7318e1ae95083b50bc227" kindref="member">qdb_int_get</ref>, <ref refid="group__integer_1ga1c2b514094983bffbfb0c9fdb3c9e822" kindref="member">qdb_int_add</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/integer.h" line="100" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__integer_1gad5d98664f4e7318e1ae95083b50bc227" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_int_get</definition>
        <argsstring>(qdb_handle_t handle, const char *alias, qdb_int_t *integer)</argsstring>
        <name>qdb_int_get</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>alias</declname>
        </param>
        <param>
          <type><ref refid="group__client_1ga17492cb84da5466d0c742f0561df6597" kindref="member">qdb_int_t</ref> *</type>
          <declname>integer</declname>
        </param>
        <briefdescription>
<para>Retrieves the value of a signed 64-bit integer. </para>        </briefdescription>
        <detaileddescription>
<para>Atomically retrieves the value of an existing 64-bit integer.</para><para>If the entry is not an integer, the function will return <ref refid="group__error_1gga365e768c3ca0f6387d8798eb98c40443a1ed20b3d0f469a2c89a88f2f62a435ab" kindref="member">qdb_e_incompatible_type</ref>.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>alias</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a null-terminated UTF-8 string representing the alias of the entry.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>integer</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to an integer that will receive the current value of the entry, if successful.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure. </para></simplesect>
<simplesect kind="see"><para><ref refid="group__integer_1gab32a0cebd83b03fbf9e9c6c4afe8efd2" kindref="member">qdb_int_put</ref>, <ref refid="group__integer_1ga0fbe264da4dee45294b893f3146a2c28" kindref="member">qdb_int_update</ref>, <ref refid="group__integer_1ga1c2b514094983bffbfb0c9fdb3c9e822" kindref="member">qdb_int_add</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/integer.h" line="124" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__integer_1ga1c2b514094983bffbfb0c9fdb3c9e822" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_int_add</definition>
        <argsstring>(qdb_handle_t handle, const char *alias, qdb_int_t addend, qdb_int_t *result)</argsstring>
        <name>qdb_int_add</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>alias</declname>
        </param>
        <param>
          <type><ref refid="group__client_1ga17492cb84da5466d0c742f0561df6597" kindref="member">qdb_int_t</ref></type>
          <declname>addend</declname>
        </param>
        <param>
          <type><ref refid="group__client_1ga17492cb84da5466d0c742f0561df6597" kindref="member">qdb_int_t</ref> *</type>
          <declname>result</declname>
        </param>
        <briefdescription>
<para>Atomically increases or decreases a signed 64-bit integer. </para>        </briefdescription>
        <detaileddescription>
<para>The specified entry will be atomically increased (or decreased) according to the given addend value:<itemizedlist>
<listitem><para>To increase the value, specify a positive addend</para></listitem><listitem><para>To decrease the value, specify a negative addend</para></listitem></itemizedlist>
</para><para>The function return the result of the operation.</para><para>The entry must already exist. If the entry is not an integer, the function will return <ref refid="group__error_1gga365e768c3ca0f6387d8798eb98c40443a1ed20b3d0f469a2c89a88f2f62a435ab" kindref="member">qdb_e_incompatible_type</ref>.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>alias</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a null-terminated UTF-8 string representing the alias of the entry.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>addend</parametername>
</parameternamelist>
<parameterdescription>
<para>The value to add to the existing value.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>result</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to an integer that will receive the current value of the entry, if successful.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure. </para></simplesect>
<simplesect kind="see"><para><ref refid="group__integer_1gab32a0cebd83b03fbf9e9c6c4afe8efd2" kindref="member">qdb_int_put</ref>, <ref refid="group__integer_1ga0fbe264da4dee45294b893f3146a2c28" kindref="member">qdb_int_update</ref>, <ref refid="group__integer_1gad5d98664f4e7318e1ae95083b50bc227" kindref="member">qdb_int_get</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/integer.h" line="155" column="1"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
  </compounddef>
</doxygen>
