kamailio/lib/cds/doc/str_t.xml

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<refentry id="str_t">

<refmeta><refentrytitle>str_t</refentrytitle>
<manvolnum>3</manvolnum></refmeta>

<refnamediv><refname>str_t</refname>
<refpurpose>data structure for string representation</refpurpose>
</refnamediv>

<refsynopsisdiv><synopsis>
#include &lt;cds/sstr.h&gt;

outside of SIP Express Router:

typedef struct {
	char *s;
	int len;
} str_t;

inside of SIP Express Router:

typedef str str_t;

</synopsis></refsynopsisdiv>

<refsect1><title>Description</title>
<para>This structure represents string. If compiled with SER it is defined using 
SER string defined elsewhere: <programlisting>typedef str str_t;</programlisting>
</para>
<para>Otherwise it is defined as structure containing pointer to data buffer and
length of this buffer.
</para> 
</refsect1>

<refsect1><title>See Also</title>
<para><xref linkend="str_dup"/>, <xref linkend="str_clear"/>, 
<xref linkend="str_free_content"/>,	<xref linkend="str_free"/>
<xref linkend="str_other"/>
</para>
</refsect1>

</refentry>