1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="loudmouth-lm-error">
<refmeta>
<refentrytitle>LmError</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LOUDMOUTH Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>LmError</refname><refpurpose>Error reporting.</refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="GQuark">GQuark</link> <link linkend="lm-error-quark">lm_error_quark</link> (void);
enum <link linkend="LmError">LmError</link>;
#define <link linkend="LM-ERROR-CAPS">LM_ERROR</link>
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="lm-error-quark"/>lm_error_quark ()</title>
<indexterm><primary>lm_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link> lm_error_quark (void);</programlisting>
<para>
-
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="LmError"/>enum LmError</title>
<indexterm><primary>LmError</primary></indexterm><programlisting>typedef enum {
LM_ERROR_CONNECTION_NOT_OPEN,
LM_ERROR_CONNECTION_OPEN,
LM_ERROR_AUTH_FAILED,
LM_ERROR_CONNECTION_FAILED
} LmError;
</programlisting>
<para>
Describes the problem of the error.
</para><variablelist role="enum">
<varlistentry>
<term><literal>LM_ERROR_CONNECTION_NOT_OPEN</literal></term>
<listitem><simpara>Connection not open when trying to send a message
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>LM_ERROR_CONNECTION_OPEN</literal></term>
<listitem><simpara>Connection is already open when trying to open it again.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>LM_ERROR_AUTH_FAILED</literal></term>
<listitem><simpara>Authentication failed while opening connection
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>LM_ERROR_CONNECTION_FAILED</literal></term>
<listitem><simpara>
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="LM-ERROR-CAPS"/>LM_ERROR</title>
<indexterm><primary>LM_ERROR</primary></indexterm><programlisting>#define LM_ERROR lm_error_quark ()
</programlisting>
<para>
Macro for getting the error quark.
</para></refsect2>
</refsect1>
</refentry>
|
