summaryrefslogtreecommitdiffstats
path: root/src/network/doc/snippets/code
Commit message (Collapse)AuthorAgeFilesLines
* Add example snippet to QNetworkInformation::isMetered()Mate Barany15 hours1-0/+78
| | | | | | | | | Highlight only the important part. Task-number: QTBUG-136625 Pick-to: 6.10 Change-Id: I9707d0d69b964421ab4f8a07c8b87cc07fa01e2f Reviewed-by: Mårten Nordheim <[email protected]>
* Add simple example how to test for connectivity with QNetworkinfoMate Barany15 hours1-0/+66
| | | | | | | | | | Extended with a description that explains the shortcomings of this approach. Task-number: QTBUG-136625 Pick-to: 6.10 Change-Id: I07473b1395fcc6dec0917da4bcc1c3791c1ed839 Reviewed-by: Mårten Nordheim <[email protected]>
* Add an example snippet to QNetworkInformationMate Barany7 days1-0/+49
| | | | | | | | | | The methods are well-documented but it probably does not hurt to add a small snippet about a simple example use case. Task-number: QTBUG-136625 Pick-to: 6.10 Change-Id: I267250faae4a062ed514a2e0bccca57f7bd8a0b3 Reviewed-by: Juha Vuolle <[email protected]>
* Change doc snippet licenseLucie Gérard2024-02-024-4/+4
| | | | | | | | | | | | According to QUIP-18 [1], all doc snippet files should be LicenseRef-Qt-Commercial OR BSD-3-Clause [1]: https://contribute.qt-project.org/quips/18 Pick-to: 6.7 Task-number: QTBUG-121787 Change-Id: I6e5bc9d05a5d510cc07a15abafe2257034562510 Reviewed-by: Kai Köhne <[email protected]>
* Take QJsonDocument as a parameterJuha Vuolle2024-01-301-1/+1
| | | | | | | | | | | Instead of separate QJsonObject and QJsonArray types. Resulted from API-review Pick-to: 6.7 Change-Id: I977d692d3709a8c3aa872683ddda54a143c25e67 Reviewed-by: Marc Mutz <[email protected]> Reviewed-by: Mårten Nordheim <[email protected]>
* Rename QRestReply data accessors as read* functionsJuha Vuolle2024-01-301-2/+2
| | | | | | | | | | | | This naming should make it clearer that (successful) calls to readJson(), readBody(), and readText() consume the data received so far. Resulted from API-review Pick-to: 6.7 Change-Id: I09ca9eac598f8fc83eecb72c22431ac35b966bf5 Reviewed-by: Marc Mutz <[email protected]>
* Update QRestAccessManager documentationJuha Vuolle2024-01-291-24/+29
| | | | | | | | | | | | To accommodate the deduplication and non-owning changes in previous commit. Resulted from API-review Pick-to: 6.7 Change-Id: I61eb071503d6714c7fd42b3fe533698a8dcd2e27 Reviewed-by: Ivan Solovev <[email protected]> Reviewed-by: Jaishree Vyas <[email protected]>
* Rename qnetworkrequestfactory's request() to createRequest()Juha Vuolle2024-01-121-4/+4
| | | | | | | | | Resulted from API-review Pick-to: 6.7 Change-Id: I09349dbddbfc191d871563b834396b387c6153c9 Reviewed-by: Mårten Nordheim <[email protected]> Reviewed-by: Giuseppe D'Angelo <[email protected]>
* Change QRestReply json return type to QJsonDocumentJuha Vuolle2024-01-121-2/+2
| | | | | | | | | | | The json return type and function naming has gone back and forth. Let's go with QJsonDocument after all, and add new overloads in future if necessary. Pick-to: 6.7 Task-number: QTBUG-119002 Change-Id: I3f9de0e6cba7d5c52d016d252d65b81f345af050 Reviewed-by: Marc Mutz <[email protected]>
* Add PATCH support for QRestAccessManagerJuha Vuolle2023-12-081-0/+8
| | | | | | | | | | | It is somewhat common HTTP method with RESTful use cases (partial updates on resources) Task-number: QTBUG-114637 Change-Id: Id252d3f4b54c3ebb8df5c93259e64a4af2d0ca2f Reviewed-by: Marc Mutz <[email protected]> Reviewed-by: Ivan Solovev <[email protected]> Reviewed-by: Mårten Nordheim <[email protected]>
* QRestAM custom HTTP 'method' supportJuha Vuolle2023-12-081-0/+7
| | | | | | | | | | This commit adds support for sending custom, non-standard, HTTP methods / verbs. Fixes: QTBUG-116262 Change-Id: I77addb389a7e4346b63526176bf8323696a7a337 Reviewed-by: Mårten Nordheim <[email protected]> Reviewed-by: Ivan Solovev <[email protected]>
* Add REST client convenience wrappersJuha Vuolle2023-12-081-0/+84
| | | | | | | | | | | | | [ChangeLog][QtNetwork][QRestAccessManager] Added new convenience classes QRestAccessManager and QRestReply for typical RESTful client application usage Task-number: QTBUG-114637 Task-number: QTBUG-114701 Change-Id: I65057e56bf27f365b54bfd528565efd5f09386aa Reviewed-by: Mårten Nordheim <[email protected]> Reviewed-by: Mate Barany <[email protected]> Reviewed-by: Marc Mutz <[email protected]>
* QNetworkRequestFactory convenience classJuha Vuolle2023-12-081-0/+27
| | | | | | | | | | | | | | | | | | | | | The class provides a way to represent server-side service endpoints. With RESTful applications these endpoints typically have a need for repeating requests fields such as headers, query parameters, bearer token, base URL, SSL configuration. This class allows setting of the repeating parts, while allowing the setting of changing parts on a per-request basis. [ChangeLog][QtNetwork][QNetworkRequestFactory] Added a new convenience class to help with the needs of repeating network request details imposed by the server-side service endpoints, which is common with RESTful applications. Task-number: QTBUG-113814 Change-Id: Iabcfaed786949ffbb0ad0c75297d0db6ecc1a3cc Reviewed-by: Marc Mutz <[email protected]> Reviewed-by: Ivan Solovev <[email protected]> Reviewed-by: Mate Barany <[email protected]> Reviewed-by: Mårten Nordheim <[email protected]>
* QSslConfiguration: remove exampleTimur Pocheptsov2023-12-051-7/+0
| | | | | | | | | | | | It uses the ciphersuite name which smart tools one day will mark as weak (i.e. https://ciphersuite.info/cs/TLS_DHE_DSS_WITH_AES_256_CBC_SHA/ in our example), names in the example are not in the standard notation, + it is and always was OpenSSL-specific example. Pick-to: 6.6 6.5 6.2 Fixes: QTBUG-119464 Change-Id: Ic6f095ff2c861582de756bf220e2e74106b88e83 Reviewed-by: Mårten Nordheim <[email protected]>
* Remove unused documentation code snippetsFriedemann Kleint2023-04-172-12/+0
| | | | | | | | | | | | | | | | | | | Modules: - Core - Gui - Widgets - Open(Widgets) - PrintSupport - Sql - Network - Concurrent - Testlib Pick-to: 6.5 Change-Id: I63e58c01bec4bd162486020f0085227fdaa83b18 Reviewed-by: Ahmad Samir <[email protected]> Reviewed-by: Christian Ehrlicher <[email protected]> Reviewed-by: Qt CI Bot <[email protected]>
* QNetworkDiskCache: Update doc snippetsMårten Nordheim2023-03-231-3/+6
| | | | | | | | | | | | We should encourage users to use the system cache directory. We should also encourage users to not use the char* QString-ctors. QStandardPaths::CacheLocation is documented to never be empty, so use it in this manner. Pick-to: 6.5 Change-Id: I1f050feda5b0a8e7c23fbed5db904bb0180b45f0 Reviewed-by: Timur Pocheptsov <[email protected]>
* Documentation: Port code snippets to new connection syntaxFriedemann Kleint2023-01-113-12/+7
| | | | | | | Pick-to: 6.5 6.4 6.2 Task-number: PYSIDE-2182 Change-Id: I5f800cf3a4a7afefbc36a79372fc35449fa953f0 Reviewed-by: Mårten Nordheim <[email protected]>
* Use SPDX license identifiersLucie Gérard2022-05-1625-1181/+50
| | | | | | | | | | | | | Replace the current license disclaimer in files by a SPDX-License-Identifier. Files that have to be modified by hand are modified. License files are organized under LICENSES directory. Task-number: QTBUG-67283 Change-Id: Id880c92784c40f3bbde861c0d93f58151c18b9f1 Reviewed-by: Qt CI Bot <[email protected]> Reviewed-by: Lars Knoll <[email protected]> Reviewed-by: Jörg Bornemann <[email protected]>
* QtNetwork: use _L1 for for creating Latin-1 string literalsSona Kurazyan2022-04-213-3/+8
| | | | | | Task-number: QTBUG-98434 Change-Id: Ic235b92377203f7a1429ae7fd784c4a1fa893e9f Reviewed-by: Mårten Nordheim <[email protected]>
* TLS: Mark TLS 1.0, 1.1 and DTLS 1.0 deprecatedMårten Nordheim2021-06-251-1/+1
| | | | | | | | | | | | As per the best practice laid forth in RFC-8996. TLS 1.2 was recommended from 2008 until TLS 1.3 was released in 2018. [ChangeLog][QtNetwork][QSslSocket] TLS 1.0, 1.1 and DTLS 1.0 are now deprecated, as recommended by RFC-8996. Fixes: QTBUG-92880 Change-Id: I90cebcfb07cfce623af7ac9f2b66ce9d02586b54 Reviewed-by: Timur Pocheptsov <[email protected]>
* Remove QFtp sources etc. in favor of alternate distributionMårten Nordheim2020-08-271-109/+0
| | | | | | | | | | | | While we initially wanted to just disable the functionality the way it is currently built forces people to do a full build of Qt just to enable it. Instead of doing this half-measure let's just remove the code completely from QtBase and rather prepare QtNetwork to handle being a plugin that can be compiled at any time. Task-number: QTBUG-80340 Change-Id: I19155c8c167cf932088f01b2a9706d0e7ab792d1 Reviewed-by: Alex Blasche <[email protected]>
* QAbstractSocket: Resolve remaining Qt6 TODOsMårten Nordheim2020-08-241-13/+1
| | | | | Change-Id: Id257f0721c1cd5fcbafa9297bae0251a2d68e366 Reviewed-by: Timur Pocheptsov <[email protected]>
* QSslConfiguration::setCiphers - introduce the overload taking QStringTimur Pocheptsov2020-07-011-0/+7
| | | | | | | | | | | | | We had such an overloaded version in QSslSocket, it was deprecated without providing any alternative. Now this function has some use and may be introduced in Qt6, as QSslConfiguration::setCiphers(const QString &). Last but not the least - a useless and strange auto-test was removed (it was creating a list of 5 QSslCiphers each with isNull() == true). That's becasue '!MD5' or 'ALL' (for example) is not a cipher to be found in supportedCiphers. Change-Id: I47eb4c0faa9b52885e883751dd992cd9cb3d26fe Reviewed-by: Mårten Nordheim <[email protected]>
* QNAM: docs cleanup from NetworkAccessibleMårten Nordheim2020-06-121-9/+0
| | | | | | | It was removed but some documentation bits were still there, apologies Change-Id: I1888b34fe04e6566349d35a27391d0bd14d622d4 Reviewed-by: Timur Pocheptsov <[email protected]>
* Merge remote-tracking branch 'origin/5.15' into devQt Forward Merge Bot2020-04-081-1/+1
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: examples/opengl/doc/src/cube.qdoc src/corelib/global/qlibraryinfo.cpp src/corelib/text/qbytearray_p.h src/corelib/text/qlocale_data_p.h src/corelib/time/qhijricalendar_data_p.h src/corelib/time/qjalalicalendar_data_p.h src/corelib/time/qromancalendar_data_p.h src/network/ssl/qsslcertificate.h src/widgets/doc/src/graphicsview.qdoc src/widgets/widgets/qcombobox.cpp src/widgets/widgets/qcombobox.h tests/auto/corelib/tools/qscopeguard/tst_qscopeguard.cpp tests/auto/widgets/widgets/qcombobox/tst_qcombobox.cpp tests/benchmarks/corelib/io/qdiriterator/qdiriterator.pro tests/manual/diaglib/debugproxystyle.cpp tests/manual/diaglib/qwidgetdump.cpp tests/manual/diaglib/qwindowdump.cpp tests/manual/diaglib/textdump.cpp util/locale_database/cldr2qlocalexml.py util/locale_database/qlocalexml.py util/locale_database/qlocalexml2cpp.py Resolution of util/locale_database/ are based on: https://codereview.qt-project.org/c/qt/qtbase/+/294250 and src/corelib/{text,time}/*_data_p.h were then regenerated by running those scripts. Updated CMakeLists.txt in each of tests/auto/corelib/serialization/qcborstreamreader/ tests/auto/corelib/serialization/qcborvalue/ tests/auto/gui/kernel/ and generated new ones in each of tests/auto/gui/kernel/qaddpostroutine/ tests/auto/gui/kernel/qhighdpiscaling/ tests/libfuzzer/corelib/text/qregularexpression/optimize/ tests/libfuzzer/gui/painting/qcolorspace/fromiccprofile/ tests/libfuzzer/gui/text/qtextdocument/sethtml/ tests/libfuzzer/gui/text/qtextdocument/setmarkdown/ tests/libfuzzer/gui/text/qtextlayout/beginlayout/ by running util/cmake/pro2cmake.py on their changed .pro files. Changed target name in tests/auto/gui/kernel/qaction/qaction.pro tests/auto/gui/kernel/qaction/qactiongroup.pro tests/auto/gui/kernel/qshortcut/qshortcut.pro to ensure unique target names for CMake Changed tst_QComboBox::currentIndex to not test the currentIndexChanged(QString), as that one does not exist in Qt 6 anymore. Change-Id: I9a85705484855ae1dc874a81f49d27a50b0dcff7
| * More qOverload cleanups in qtbaseTimur Pocheptsov2020-03-241-1/+1
| | | | | | | | | | | | Task-number: QTBUG-82605 Change-Id: I1c3c14ed82911ed5483258c11e76f5dd7744fa12 Reviewed-by: Mårten Nordheim <[email protected]>
* | QtNetwork: Delete bearer managementMårten Nordheim2020-04-053-127/+0
| | | | | | | | | | | | | | | | | | | | All remaining pieces are gone, configuration included. Relevant CMakeLists and configure.cmake were regenerated. Fixes: QTBUG-76502 Change-Id: I667b5da7e3802830d236d50b5e9190c2ee9c19e2 Reviewed-by: Lars Knoll <[email protected]>
* | Remove QRegExp usage from QSslCertificate and QSslSocketLars Knoll2020-03-311-8/+0
|/ | | | | | Change-Id: I81abe1ab2173af922fa4b5fad58d25fa602c523b Reviewed-by: Timur Pocheptsov <[email protected]> Reviewed-by: Mårten Nordheim <[email protected]>
* Document how to use CMake for Qt NetworkKai Koehne2020-03-091-3/+0
| | | | | | | | | | | | | Add documentation on how to use a module from CMake, alongside the existing documentation about qmake. While at it, also remove the mentioning of the central include; It is not something we should actively advocate anymore. Instead, the documentation of every class gives the correct include to use. Task-number: QTBUG-73058 Change-Id: I71ed5a62f4f0a6d868dd1f84ea39e5ac385a2fb8 Reviewed-by: Leena Miettinen <[email protected]>
* QSslCertificate: migrate to QRegularExpressionSamuel Gaist2020-01-231-0/+8
| | | | | | | | | | | | | | | This is part of the migration of qtbase from QRexExp to QRegularExpression. If support for regular expression is disabled, fixed string can still be used. [ChangeLog][QtCore][QSslCertificate] Add overload of fromPath that does not make use of QRegExp and deprecate the QRegExp variant. Task-number: QTBUG-72587 Change-Id: I507d8941cc7d70166da0948375dc421fe5e7d967 Reviewed-by: Mårten Nordheim <[email protected]>
* Clarify Q{Abstract,Local}Socket::waitForDisconnected() documentationKari Oikarinen2019-11-012-3/+6
| | | | | | | | | | | | | | Make it clear that the functions will return false if the socket was already disconnected. Fix the QLocalSocket example snippet to handle that case correctly by checking state() before attempting to wait. Fixes: QTBUG-50711 Change-Id: I4ab4062446a0041a35a3a1d65a19202ffa103298 Reviewed-by: Alex Trotsenko <[email protected]> Reviewed-by: Mårten Nordheim <[email protected]> Reviewed-by: Edward Welbourne <[email protected]>
* QUdpSocket: Convert snippet to functor connectAndre Hartmann2019-04-081-2/+2
| | | | | Change-Id: Ice210b979a1dd948cd8d95003bd50a4b71d91852 Reviewed-by: Thiago Macieira <[email protected]>
* Doc: Move literal code block to a separate fileCristian Maureira-Fredes2018-10-154-0/+223
| | | | | | | | | | | We need to override this snippet for the documentation we generate for Qt for Python, and it is easier to have it on a separate file. Task-number: PYSIDE-801 Task-number: PYSIDE-691 Change-Id: Ideb5b6af25024279f167137d3b65660bb9c96a7e Reviewed-by: Topi Reiniö <[email protected]>
* Document the DTLS APITimur Pocheptsov2018-08-092-0/+263
| | | | | | | Task-number: QTBUG-68070 Change-Id: Ifd08ecb7c2c1a6dc352952a10ad56259bd1ecf10 Reviewed-by: Paul Wicking <[email protected]> Reviewed-by: Mårten Nordheim <[email protected]>
* QNetworkAccessManager: Port doc snippet to functor-connectAndre Hartmann2018-07-271-7/+7
| | | | | | Change-Id: I719856168a254c90b0bb0943faee5ab0be75b0bd Reviewed-by: Martin Smith <[email protected]> Reviewed-by: Timur Pocheptsov <[email protected]>
* Replace outdated BSD license textKai Koehne2017-03-031-1/+11
| | | | | | | | For examples and documentation, use new BSD license text that includes the commercial licenses. Change-Id: I1cd74bd8e9c8f2746d8702df00780ee100cbebac Reviewed-by: Jani Heikkinen <[email protected]>
* Doc: Use canonical contact URL in license headerKai Koehne2017-02-281-1/+1
| | | | | | | | Change-Id: I34821150f66255df30d12572b27779e0e729ebc8 Reviewed-by: Samuel Gaist <[email protected]> Reviewed-by: Alex Trotsenko <[email protected]> Reviewed-by: Jani Heikkinen <[email protected]> Reviewed-by: Lars Knoll <[email protected]>
* Introduce SCTP sockets supportAlex Trotsenko2016-07-271-0/+53
| | | | | | | Add protocol-specific code and the QSctpServer, QSctpSocket classes. Change-Id: Ie9a1d87bd1fda866a2405043d1c15c12ded5a96e Reviewed-by: Thiago Macieira <[email protected]>
* Long live QNetworkDatagram!Thiago Macieira2016-06-201-8/+1
| | | | | | | | | | | | | | | | | This commit adds a new class called QNetworkDatagram that encapsulates the IP packet header and UDP/IP stack metadata along with the actual payload data. It can be used for both receiving as well as sending data. It's called QNetworkDatagram so it can be used by QSctpSocket too, when that lands. [ChangeLog][QtNetwork] Added QNetworkDatagram class, along with new function receiveDatagram in QUdpSocket that returns it and an overload to writeDatagram that can accept it. Change-Id: Iee8cbc07c4434ce9b560ffff13ca467f425ddc3d Reviewed-by: Alex Trotsenko <[email protected]> Reviewed-by: Richard J. Moore <[email protected]>
* QtNetwork: eradicate Q_FOREACH loops [rvalues]Marc Mutz2016-05-043-5/+7
| | | | | | | | | | | | | ... by replacing them with C++11 range-for loops. This is the simplest of the patch series: Q_FOREACH took a copy, so we do, too. Except we don't, since we're just catching the return value that comes out of the function (RVO). We can't feed the rvalues into range-for, because they are non-const and would thus detach. Change-Id: I42c9c44d948ab1512a69d42890187bc3cf2d7e58 Reviewed-by: Lars Knoll <[email protected]>
* Unify license header usage.Jani Heikkinen2016-03-2919-57/+247
| | | | | | | | | Update files using old header.LGPL3 to header.LGPL Update files using old FDL template to use new one Update files using old BSD template to use new one Change-Id: I36a78272516f9953d02956522f285b40adfc8915 Reviewed-by: Lars Knoll <[email protected]>
* Updated license headersJani Heikkinen2016-01-152-28/+40
| | | | | | | | | | | From Qt 5.7 -> LGPL v2.1 isn't an option anymore, see http://blog.qt.io/blog/2016/01/13/new-agreement-with-the-kde-free-qt-foundation/ Updated license headers to use new LGPL header instead of LGPL21 one (in those files which will be under LGPL v3) Change-Id: I046ec3e47b1876cd7b4b0353a576b352e3a946d9 Reviewed-by: Lars Knoll <[email protected]>
* Doc: Added missing semicolons to snippetNico Vertriest2015-12-031-3/+3
| | | | | | Task-number: QTBUG-34594 Change-Id: I3eeff4494f5b27c5b34b911008b1a87abe032868 Reviewed-by: Topi Reiniö <[email protected]>
* Merge remote-tracking branch 'origin/5.5' into 5.6Liang Qi2015-10-231-1/+2
|\ | | | | | | | | | | | | | | Conflicts: src/corelib/kernel/qcfsocketnotifier.cpp src/tools/qdoc/qdocindexfiles.cpp Change-Id: Iae365b23afc611de8794f22cceae8b210d25aa8a
| * Doc: Edit description of QSslSocket::AddCaCertificates()Topi Reinio2015-10-231-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The QSslSocket::addCaCertificates() variant that takes a path argument uses QSslCertificate::fromPath() in its implementation. Edit the description of the former to match that of the latter. Fix minor issues in QSslCertificate::fromPath() documentation; add a missing word, limit code snippet line width. Task-number: QTBUG-47359 Change-Id: Ibead74c998503e60a67d0b8eb551536bd20feff8 Reviewed-by: Venugopal Shivashankar <[email protected]> Reviewed-by: Timur Pocheptsov <[email protected]> Reviewed-by: Richard J. Moore <[email protected]>
* | QtNetwork documentation: Emphasize QTcpServer::addPendingConnection().Friedemann Kleint2015-09-211-1/+2
|/ | | | | | | | Add note mentioning it to QTcpSocket::incomingConnection() and update SSL socket server code snippet accordingly. Change-Id: I9d228dabde76f9e9cd5140edf08be09a588066c8 Reviewed-by: Thiago Macieira <[email protected]>
* Updated BSD licensed file headersJani Heikkinen2015-02-1519-57/+57
| | | | | Change-Id: I6441ff931dbd33b698d762e6f6784898f3f60fe7 Reviewed-by: Oswald Buddenhagen <[email protected]>
* Update copyright headersJani Heikkinen2015-02-1121-108/+108
| | | | | | | | | | | | | | | | | | Qt copyrights are now in The Qt Company, so we could update the source code headers accordingly. In the same go we should also fix the links to point to qt.io. Outdated header.LGPL removed (use header.LGPL21 instead) Old header.LGPL3 renamed to header.LGPL3-COMM to match actual licensing combination. New header.LGPL-COMM taken in the use file which were using old header.LGPL3 (src/plugins/platforms/android/extract.cpp) Added new header.LGPL3 containing Commercial + LGPLv3 + GPLv2 license combination Change-Id: I6f49b819a8a20cc4f88b794a8f6726d975e8ffbe Reviewed-by: Matti Paaso <[email protected]>
* Update license headers and add new license filesMatti Paaso2014-09-242-38/+22
| | | | | | | | | - Renamed LICENSE.LGPL to LICENSE.LGPLv21 - Added LICENSE.LGPLv3 - Removed LICENSE.GPL Change-Id: Iec3406e3eb3f133be549092015cefe33d259a3f2 Reviewed-by: Iikka Eklund <[email protected]>
* Fix QNetworkRequest::setRawHeader() for QT_NO_CAST_FROM_BYTEARRAYRichard J. Moore2014-04-081-1/+1
| | | | | | | Avoid the implicit conversion in the doc snippet. Change-Id: Iacec6dab371a22c16f537af471f6653d9c5ad43d Reviewed-by: Andy Shaw <[email protected]>