mirror of https://github.com/sipwise/kamailio.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
54 lines
2.0 KiB
54 lines
2.0 KiB
<?xml version="1.0" encoding="UTF-8"?>
|
|
|
|
<!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.2//EN'
|
|
'http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd'[
|
|
<!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED">
|
|
]>
|
|
|
|
<book lang="en">
|
|
<bookinfo>
|
|
<title>Common Data Structures (libcds)</title>
|
|
<author><firstname>Václav</firstname><surname>Kubart</surname></author>
|
|
<abstract><para>Description of CDS (Common Data Structures) library.
|
|
</para></abstract>
|
|
</bookinfo>
|
|
|
|
<preface><title>Preface</title>
|
|
<para>This library contains many useful functions and data structures. It is
|
|
possible to use it with Sip Express Router (SER) or without it. In the first case it
|
|
is able to use some internal SER's data types like strings.
|
|
</para>
|
|
|
|
<section><title>Conventions</title>
|
|
<para>There is list of conventions used in this library:
|
|
<itemizedlist>
|
|
<listitem><para>data types (structures, enums, ...) have their names with suffix
|
|
<quote>_t</quote> (<structname>dstring_t</structname>,
|
|
<structname>str_t</structname>, ...)</para></listitem>
|
|
<listitem><para>many functions have prefix according to data structure on
|
|
which are operating (like <function>dstr_append</function> which operates on
|
|
<structname>dstring_t</structname> data structure)</para></listitem>
|
|
<listitem><para>most functions return 0 as successful result and nonzero
|
|
value as error</para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</section>
|
|
|
|
<section id="libcds.dependencies"><title>Dependencies</title>
|
|
<para>This library depends only on standard C libraries and needs no other
|
|
external libraries.</para>
|
|
</section>
|
|
|
|
</preface>
|
|
|
|
<part><title>Reference</title>
|
|
<include xmlns="http://www.w3.org/2001/XInclude" href="memory.xml"/>
|
|
<include xmlns="http://www.w3.org/2001/XInclude" href="sstr.xml"/>
|
|
<include xmlns="http://www.w3.org/2001/XInclude" href="dstring.xml"/>
|
|
<include xmlns="http://www.w3.org/2001/XInclude" href="serialization.xml"/>
|
|
<include xmlns="http://www.w3.org/2001/XInclude" href="sync.xml"/>
|
|
<include xmlns="http://www.w3.org/2001/XInclude" href="msg_queue.xml"/>
|
|
</part>
|
|
|
|
</book>
|