Mercurial > irccd

annotate extern/libircclient/include/libirc_options.h @ 83:f1a3026027f1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
CMake: fix invalid creation of pkg-config file ending in permanent CMake re-run
author David Demelier <markand@malikania.fr>
date Thu, 31 Mar 2016 14:07:53 +0200
parents 1158cffe5a5e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * Copyright (C) 2004-2012 George Yunaev gyunaev@ulduzsoft.com
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * This library is free software; you can redistribute it and/or modify it
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 * under the terms of the GNU Lesser General Public License as published by
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * the Free Software Foundation; either version 3 of the License, or (at your
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * option) any later version.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 *
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 * This library is distributed in the hope that it will be useful, but WITHOUT
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * License for more details.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 */
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 #ifndef INCLUDE_IRC_OPTIONS_H
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 #define INCLUDE_IRC_OPTIONS_H
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 #ifndef IN_INCLUDE_LIBIRC_H
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #error This file should not be included directly, include just libircclient.h
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #endif
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 /*!
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 * enables additional debug output
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 * \ingroup options
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 */
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 #define LIBIRC_OPTION_DEBUG (1 << 1)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 /*! \brief allows to strip origins automatically.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 *
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 * For every IRC server event, the event origin is sent in standard form:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 * nick!host\@ircserver, i.e. like tim!home\@irc.freenet.org. Such origins
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 * can not be used in IRC commands, and need to be stripped (i.e. host and
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 * server part should be cut off) before using. This can be done either
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 * explicitly, by calling irc_target_get_nick(), or implicitly for all the
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 * events - by setting this option with irc_option_set().
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 * \ingroup options
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 */
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 #define LIBIRC_OPTION_STRIPNICKS (1 << 2)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
39
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 /*! \brief Disables the certificate verification for SSL connections
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 *
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 * By default the SSL connection authenticy is ensured by verifying that the certificate
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 * presented by the server is signed by a known trusted certificate authority. Since those
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 * typically cost money, some IRC servers use the self-signed certificates. They provide the
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 * benefits of the SSL connection but since they are not signed by the Certificate Authority,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 * their authencity cannot be verified. This option, if set, disables the certificate
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 * verification - the library will accept any certificate presented by the server.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 *
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 * This option must be set before the irc_connect function is called.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 * \ingroup options
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 */
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 #define LIBIRC_OPTION_SSL_NO_VERIFY (1 << 3)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
54
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
55
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 #endif /* INCLUDE_IRC_OPTIONS_H */