summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2012-12-10 13:37:47 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2012-12-10 15:54:56 +0100
commitc6f17e396a487c198905615411b0d167a376c4cf (patch)
treeafbb56577c95810433c58f8f8a135e52e3744327
parent9933229b1da030af7275d1df629af6bfbe07bd5c (diff)
Doc: Edited network and D-Bus related overviews.
-fixed or re-ordered links. -reformatted links to the landing pages -edited the paragraphs Change-Id: I864f1903073c681ce630e969e46688cb74aecca9 Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com>
-rw-r--r--doc/src/connectivity.qdoc142
-rw-r--r--doc/src/developmenttools.qdoc3
2 files changed, 71 insertions, 74 deletions
diff --git a/doc/src/connectivity.qdoc b/doc/src/connectivity.qdoc
index 356f13e58..07514eb13 100644
--- a/doc/src/connectivity.qdoc
+++ b/doc/src/connectivity.qdoc
@@ -33,91 +33,86 @@
Qt provides classes for both high-level and low-level network communication,
classes for web integration, and classes for interprocess communication.
-For high-level network traffic, Qt Network provides an abstraction layer over
-the operations used, showing only high-level classes and functions.
-
-Qt Network can also handle lower level protocols like TCP and UDP. Classes
-like QTcpSocket and QUdpSocket enable the developer to send and receive
-messages using the TCP or UDP protocol.
-
-Name resolution is done with QHostInfo. QHostInfo is called before creating
-a network connection with QTcpSocket or QUdpSocket.
-
+For high-level network traffic, \l{Qt Network} provides an abstraction layer
+over the operations used, showing only high-level classes and functions. Qt
+Network can also handle lower level protocols like TCP and UDP. Classes like
+QTcpSocket and QUdpSocket enable the developer to send and receive messages
+using the TCP or UDP protocol.Name resolution is done with QHostInfo. QHostInfo
+is called before creating a network connection with QTcpSocket or QUdpSocket.
Filtering and redistributing network traffic via proxies can handled by the
QNetWorkProxy class.
-Qt Network also provides Bearer Management. It has functions that can start
-or stop network interfaces and roam between access points. It does however
-not take care of the network configurations itself. The platform needs to
-take care of that.
+Qt Network also provides the \l{Bearer Management} API. It has functions that
+can start or stop network interfaces and roam between access points. It does
+however not take care of the network configurations itself. The platform needs
+to take care of that.
Qt Webkit offers a web browser engine that makes it possible to use web
content in your application. Qt Webkit can render HTML, XHTML,
and SVG documents, and execute Javascript.
-Qt also offers functionalities for IPC.
-
-Class QProcess is used to start external programs.
-
-Qt has classes for D-Bus, an interprocess communication and remote procedure
-calling mechanism. It mostly communicates via a central server application,
-called a bus. However, it is also possible to let applications communicate
-directly with each other.
-
+Qt also offers functionalities for \e{inter-process communication} (IPC). The
+class QProcess is used to start external programs. \l{Qt D-Bus} provides support
+for D-Bus, an interprocess communication and remoteprocedure calling mechanism.
+It mostly communicates via a central server application, called a bus. However,
+it is also possible to let applications communicate directly with each other.
QSharedMemory provides access to a shared memory segment by multiple threads
and processes. It is however also possible for a single process to
exclusively lock that shared memory.
-\list
-\li \l {Qt Network}
-\endlist
-
\section1 Network Communication
-Qt supports a wide range of network communication, with a focus on HTTP, TCP, and UDP.
-
-At the HTTP level, Qt offers the network access API, which consists mainly of QNetworkRequest,
-QNetworkAccessManager, and QNetworkReply. Put simply, the QNetworkRequest resembles an HTTP
-request, which gets passed to the QNetworkAccessManager to send the request on the wire; this
-class returns a QNetworkReply, which enables parsing the HTTP reply. The network access API
-uses the socket classes mentioned below (for TCP and SSL) internally.
-
-For communication at the socket level, QTcpSocket, QUdpSocket and QSslSocket should be used.
-These classes offer a synchronous API through the waitFor* methods as well as an asynchronous
-API; if possible (i.e. if the event loop is running), the asynchronous API should always be
-preferred.
-Qt also offers QTcpServer to enable the server-side part of a TCP communication. Please note
+Qt supports a wide range of network communication, with a focus on HTTP, TCP,
+and UDP.
+
+At the HTTP level, the \l{Qt Network} module offers the network access API,
+which consists mainly of QNetworkRequest, QNetworkAccessManager, and
+QNetworkReply. Put simply, the QNetworkRequest resembles an HTTP request, which
+gets passed to the QNetworkAccessManager to send the request on the wire; this
+class returns a QNetworkReply, which enables parsing the HTTP reply. The network
+access API uses the socket classes mentioned below (for TCP and SSL) internally.
+
+For communication at the socket level, QTcpSocket, QUdpSocket and QSslSocket
+should be used. These classes offer a synchronous API through the waitFor*
+methods as well as an asynchronous API; if possible (i.e. if the event loop is
+running), the asynchronous API should always be preferred. Qt also offers
+QTcpServer to enable the server-side part of a TCP communication. Please note
that there is no HTTP server class in Qt.
-For secure communication via SSL, Qt offers a wide range of classes alongside the central
-QSslSocket, e.g. QSslCertificate, QSslConfiguration and QSslError. The only supported backend
-for SSL in Qt is OpenSSL, which needs to be installed separately.
+For secure communication via SSL, Qt Network offers a wide range of classes
+alongside the central QSslSocket, e.g. QSslCertificate, QSslConfiguration and
+QSslError. The only supported backend for SSL in Qt is OpenSSL, which needs to
+be installed separately.
-For mobile devices, Qt offers the bearer management API to track the status of a connection
-(e.g. getting notified about online/offline status or whether Wifi or 3G is used).
+For mobile devices, Qt Network offers the \l{Bearer Management}{bearer
+management} API to track the status of a connection (e.g. getting notified about
+online/offline status or whether Wifi or 3G is used).
-Qt also offers HTTP support in QML by either using HTTP explicitly via XmlHttpRequest, or by
-transparently using HTTP URLs in e.g. Image sources.
+Qt also offers HTTP support in QML by either using HTTP explicitly via
+XmlHttpRequest, or by transparently using HTTP URLs in e.g. Image sources.
+Related Topics:
\list
-\li \l {Network Programming API}
-\li \l {Network Programming with Qt}
-\li \l {Qt Network - C++ Classes}
-\li \l {Secure Sockets Layer (SSL) Classes}
-\li \l {Resource Loading and Network Transparency}
-\li \l {Bearer Management}
+\li \l{Qt Network} - module documentation
+ \list
+ \li \l {Network Programming API}
+ \li \l {Network Programming with Qt}
+ \li \l {Qt Network - C++ Classes}
+ \li \l {Secure Sockets Layer (SSL) Classes}
+ \li \l {Bearer Management}
+ \endlist
+\li \l {Resource Loading and Network Transparency} - network and URL transparency in QML
\endlist
\section1 World Wide Web Support
-Qt makes it easy to embed web content into your Qt application using features of the QtWebKit
-layout engine.
-The QtWebKit module equips Qt with support for a broad range of standard web technologies
-that make it possible to embed HTML content styled with CSS and scripted with JavaScript into your Qt
-application.
-QtWebKit facilitates both integration with traditional QWidget based desktop applications as
-well as embedding into Qt Quick QML applications.
+Qt makes it easy to embed web content into your Qt application using features of
+the Qt WebKit layout engine. The Qt WebKit module equips Qt with support for a
+broad range of standard web technologies that make it possible to embed HTML
+content styled with CSS and scripted with JavaScript into your Qt application.
+QtWebKit facilitates both integration with traditional QWidget based desktop
+applications as well as embedding into Qt Quick QML applications.
For more information see \l {Integrating Web Content}.
@@ -126,7 +121,7 @@ For more information see \l {Integrating Web Content}.
Qt provides several ways to implement Inter-Process Communication
(IPC) in Qt applications.
-The cross-platform \l{QtNetwork} module provides classes that make
+The cross-platform \l{Qt Network} module provides classes that make
network programming portable and easy. It offers high-level
classes (e.g., QNetworkAccessManager, QFtp) that communicate using
specific application-level protocols, and lower-level classes
@@ -140,12 +135,11 @@ and processes. Additionally, QSystemSemaphore can be used to control
access to resources shared by the system, as well as to communicate
between processes.
-The \l{QtDBus} module is a Unix-only library you can use to
+The \l{Qt D-Bus} module is a Unix-only library you can use to
implement IPC using the D-Bus protocol. It extends Qt's
-\l{signalsandslots.html} {Signals and Slots} mechanism to the IPC
+\l{Signals & Slots}{signals and slots} mechanism to the IPC
level, allowing a signal emitted by one process to be connected to
-a slot in another process. The \l{Qt D-Bus} documentation has detailed
-information on how to use the \l{QtDBus} module.
+a slot in another process.
The cross-platform class \l{QProcess} can be used to start external
programs as child processes, and to communicate with them. It provides
@@ -158,15 +152,17 @@ a named pipe and on Unix this is a local domain socket.
The \l{QLocalServer} class provides a local socket based server. This
class makes it possible to accept incoming local socket connections.
+Related Topics:
\list
-\li \l {Using QtDBus Adaptors}
-\li \l {Qt D-Bus}
-\li \l {QLocalSocket}
-\li \l {Declaring Signals in D-Bus Adaptors}
-\li \l {Declaring Slots in D-Bus Adaptors}
-\li \l {QDBus Namespace}
-\li \l {The QtDBus Type System}
-\li \l {QtDBus XML Compiler (qdbusxml2cpp)}
+\li \l {Qt D-Bus} - module documentation
+ \list
+ \li \l {Using QtDBus Adaptors}
+ \li \l {QLocalSocket}
+ \li \l {Declaring Signals in D-Bus Adaptors}
+ \li \l {Declaring Slots in D-Bus Adaptors}
+ \li \l {The QtDBus Type System}
+ \li \l {QtDBus XML Compiler (qdbusxml2cpp)}
+ \endlist
\endlist
*/
diff --git a/doc/src/developmenttools.qdoc b/doc/src/developmenttools.qdoc
index dabaede51..dfadae9ff 100644
--- a/doc/src/developmenttools.qdoc
+++ b/doc/src/developmenttools.qdoc
@@ -90,7 +90,8 @@
\row \li \l{QtDBus XML compiler (qdbusxml2cpp)}
\li A tool to convert D-Bus interface descriptions to C++ source code.
\row \li \l{D-Bus Viewer}
- \li A tool to introspect D-Bus objects and messages.
+ \li A tool to introspect D-Bus objects and messages. Available from
+ the Qt SDK or the Qt 5 qttools repository.
\endtable
*/