summaryrefslogtreecommitdiffstats
path: root/src/network/doc/src/qtnetwork.qdoc
blob: 57b0210b7f804ae159494dce0283aa3fc623a00d (plain)
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
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \page qtnetwork-index.html
    \title Qt Network
    \brief Provides networking capabilities

    Qt Network provides a set of APIs for programming applications that use
    TCP/IP. Operations such as requests, cookies, and sending data over HTTP
    are handled by various C++ classes.

    \include module-use.qdocinc using qt module
    \snippet CMakeLists.txt 0

    See also the \l{Build with CMake} overview.

    \section2 Building with qmake

    Add \c network to the \c QT variable:

    \snippet snippets.pro 0

    \section1 Articles and Guides

    These articles contain information about Qt Network setup and about
    applications with networking capabilities.
    \list
    \li \l{Network Programming with Qt} - Programming applications with networking capabilities
    \li \l{Secure Sockets Layer (SSL) Classes} - Classes for secure communication over network sockets
    \endlist

    \section1 API Reference
    These are links to the API reference materials.
    \list
    \li \l{Qt Network C++ Classes}{C++ Classes}
    \endlist

    \section1 Licenses and Attributions

    Qt Network is available under commercial licenses from \l{The Qt Company}.
    In addition, it is available under the
    \l{GNU Lesser General Public License, version 3}, or
    the \l{GNU General Public License, version 2}.
    See \l{Qt Licensing} for further details.

    Qt Network can use the \l{OpenSSL Toolkit} as a backend. The library is then
    linked against OpenSSL in a way that requires compliance with the \l{OpenSSL
    License}. To allow linking OpenSSL with Qt Network under the GPL, following
    exceptions to the GPL do apply:

    \badcode
    In addition, as a special exception, the copyright holders listed above give
    permission to link the code of its release of Qt with the OpenSSL project's
    "OpenSSL" library (or modified versions of the "OpenSSL" library that use the
    same license as the original version), and distribute the linked executables.

    You must comply with the GNU General Public License version 2 in all
    respects for all of the code used other than the "OpenSSL" code.  If you
    modify this file, you may extend this exception to your version of the file,
    but you are not obligated to do so.  If you do not wish to do so, delete
    this exception statement from your version of this file.
    \endcode

    Also note shipping OpenSSL might cause \l{Import and Export Restrictions}
    to apply.
*/

/*!
    \module QtNetwork
    \title Qt Network C++ Classes
    \ingroup modules
    \qtvariable network
    \brief Provides classes to make network programming easier and portable.

    Qt Network provides a set of APIs for programming applications that use
    TCP/IP. See the \l{Qt Network} overview for more information.
*/