1<?xml version="1.0" encoding="UTF-8"?> 2 3<!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.2//EN' 4'http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd'[ 5 <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> 6]> 7 8<book lang="en"> 9<bookinfo> 10 <title>Common Data Structures (libcds)</title> 11 <author><firstname>Václav</firstname><surname>Kubart</surname></author> 12 <abstract><para>Description of CDS (Common Data Structures) library. 13 </para></abstract> 14</bookinfo> 15 16<preface><title>Preface</title> 17<para>This library contains many useful functions and data structures. It is 18possible to use it with Sip Express Router (SER) or without it. In the first case it 19is able to use some internal SER's data types like strings. 20</para> 21 22<section><title>Conventions</title> 23<para>There is list of conventions used in this library: 24<itemizedlist> 25 <listitem><para>data types (structures, enums, ...) have their names with suffix 26 <quote>_t</quote> (<structname>dstring_t</structname>, 27 <structname>str_t</structname>, ...)</para></listitem> 28 <listitem><para>many functions have prefix according to data structure on 29 which are operating (like <function>dstr_append</function> which operates on 30 <structname>dstring_t</structname> data structure)</para></listitem> 31 <listitem><para>most functions return 0 as successful result and nonzero 32 value as error</para></listitem> 33</itemizedlist> 34</para> 35</section> 36 37<section id="libcds.dependencies"><title>Dependencies</title> 38<para>This library depends only on standard C libraries and needs no other 39external libraries.</para> 40</section> 41 42</preface> 43 44<part><title>Reference</title> 45<include xmlns="http://www.w3.org/2001/XInclude" href="memory.xml"/> 46<include xmlns="http://www.w3.org/2001/XInclude" href="sstr.xml"/> 47<include xmlns="http://www.w3.org/2001/XInclude" href="dstring.xml"/> 48<include xmlns="http://www.w3.org/2001/XInclude" href="serialization.xml"/> 49<include xmlns="http://www.w3.org/2001/XInclude" href="sync.xml"/> 50<include xmlns="http://www.w3.org/2001/XInclude" href="msg_queue.xml"/> 51</part> 52 53</book> 54