diff options
| author | Edward Welbourne <edward.welbourne@qt.io> | 2018-11-08 15:53:40 +0100 |
|---|---|---|
| committer | Edward Welbourne <edward.welbourne@qt.io> | 2018-11-09 10:30:45 +0000 |
| commit | 0dae641331bbd21207f6c74a7a34e0c74103d61e (patch) | |
| tree | 39fa49e531926e3dc78832086eb91222bd3f6f69 /src/network/socket/qabstractsocket.cpp | |
| parent | dec7961709c90f6977d2447f7fa6c6625af41cb2 (diff) | |
QAbstractSocket::Bind: clarify some details
The function's documentation needlessly repeated parts of its first
line. The BindFlag enum it takes as a parameter confused readers by
saying an option is ignored on Windows, failing to make clear that it
is so because that option is what Windows does by default.
Tidied some phrasing and typos in the process.
Fixes: QTBUG-52364
Change-Id: Ia6510caff7ec80216eefccf41fb009b1357e4b2e
Reviewed-by: Andy Shaw <andy.shaw@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/network/socket/qabstractsocket.cpp')
| -rw-r--r-- | src/network/socket/qabstractsocket.cpp | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/src/network/socket/qabstractsocket.cpp b/src/network/socket/qabstractsocket.cpp index 13e10e4102..a33dcb5955 100644 --- a/src/network/socket/qabstractsocket.cpp +++ b/src/network/socket/qabstractsocket.cpp @@ -424,7 +424,7 @@ Note that by combining this option with ReuseAddressHint, you will also allow your service to rebind an existing shared address. On Unix, this is equivalent to the SO_REUSEADDR socket option. On Windows, - this option is ignored. + this is the default behavior, so this option is ignored. \value DontShareAddress Bind the address and port exclusively, so that no other services are allowed to rebind. By passing this option to @@ -444,7 +444,7 @@ \value DefaultForPlatform The default option for the current platform. On Unix and \macos, this is equivalent to (DontShareAddress - + ReuseAddressHint), and on Windows, its equivalent to ShareAddress. + + ReuseAddressHint), and on Windows, it is equivalent to ShareAddress. */ /*! \enum QAbstractSocket::PauseMode @@ -455,7 +455,7 @@ The only notification currently supported is QSslSocket::sslErrors(). \value PauseNever Do not pause data transfer on the socket. This is the - default and matches the behaviour of Qt 4. + default and matches the behavior of Qt 4. \value PauseOnSslErrors Pause data transfer on the socket upon receiving an SSL error notification. I.E. QSslSocket::sslErrors(). */ @@ -1538,11 +1538,9 @@ void QAbstractSocket::setPauseMode(PauseModes pauseMode) Binds to \a address on port \a port, using the BindMode \a mode. - Binds this socket to the address \a address and the port \a port. - For UDP sockets, after binding, the signal QUdpSocket::readyRead() is emitted whenever a UDP datagram arrives on the specified address and port. - Thus, This function is useful to write UDP servers. + Thus, this function is useful to write UDP servers. For TCP sockets, this function may be used to specify which interface to use for an outgoing connection, which is useful in case of multiple network |