Mercurial > irccd

comparison doc/doxygen/modules.cpp @ 809:8460b4a34191

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: reorganize namespaces, closes #952 @4h
author David Demelier <markand@malikania.fr>
date Fri, 16 Nov 2018 12:25:00 +0100
parents
children 06cc2f95f479
comparison
equal deleted inserted replaced
808:80bccab4a093 809:8460b4a34191
1 /*
2 * modules.cpp -- doxygen modules page
3 *
4 * Copyright (c) 2013-2018 David Demelier <markand@malikania.fr>
5 *
6 * Permission to use, copy, modify, and/or distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
9 *
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18
19 /**
20 * \defgroup daemon irccd::daemon
21 * \brief Module libirccd-daemon
22 */
23
24 /**
25 * \defgroup daemon-transports transports
26 * \ingroup daemon
27 * \brief Servers, clients and commands.
28 */
29
30 /**
31 * \defgroup daemon-servers servers
32 * \ingroup daemon
33 * \brief IRC server, events and functions.
34 */
35
36 /**
37 * \defgroup daemon-plugins plugins
38 * \ingroup daemon
39 * \brief Plugin objects and functions.
40 */
41
42 /**
43 * \defgroup daemon-loggers loggers
44 * \ingroup daemon
45 * \brief Log mechanism.
46 */
47
48 /**
49 * \defgroup daemon-loggers-sinks sinks
50 * \ingroup daemon-loggers
51 * \brief Predefined logger sinks.
52 */
53
54 /**
55 * \brief Specialized loggable traits.
56 * \defgroup daemon-loggers-traits traits
57 * \ingroup daemon-loggers
58 */
59
60
61 /**
62 * \defgroup daemon-rules rules
63 * \ingroup daemon
64 * \brief Rule objects.
65 */
66
67 /**
68 * \defgroup daemon-utilites utilities
69 * \ingroup daemon
70 * \brief Utilities.
71 */
72
73 /**
74 * \defgroup daemon-services services
75 * \ingroup daemon
76 * \brief Irccd services.
77 */
78
79 /**
80 * \defgroup ctl irccd::ctl
81 * \brief Module libirccd-ctl
82 */
83
84 /**
85 * \defgroup core irccd
86 * \brief Module libirccd
87 */
88
89 /**
90 * \defgroup core-networking networking
91 * \ingroup core
92 * \brief Networking support.
93 *
94 * Each irccd instance is controllable via sockets using JSON messages.
95 *
96 * This mechanism is offered via the triplet stream/acceptor/connector. Irccd
97 * uses different acceptors to wait for clients to connect and then construct
98 * a stream of it. Once ready, streams are ready to receive and send messages.
99 *
100 * On the client side (e.g. irccdctl), a generic connector is created to connect
101 * to the irccd instance. Once ready, a stream is also created and ready to
102 * perform the same receive and send messages.
103 *
104 * By default, irccd provides predefined implementations for TCP/IP, local unix
105 * sockets and optionally TLS over those.
106 */
107
108 /**
109 * \defgroup core-streams streams
110 * \ingroup core-networking
111 * \brief Generic I/O streams.
112 */
113
114 /**
115 * \defgroup core-acceptors acceptors
116 * \ingroup core-networking
117 * \brief Generic I/O acceptors.
118 */
119
120 /**
121 * \defgroup core-connectors connectors
122 * \ingroup core-networking
123 * \brief Generic I/O connectors.
124 */
125
126 /**
127 * \defgroup js irccd::js
128 * \brief Javascript support.
129 */
130
131 /**
132 * \defgroup js-api api
133 * \ingroup js
134 * \brief Javascript APIs.
135 */