summaryrefslogtreecommitdiffstats
path: root/src/network/socket/qlocalsocket.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/network/socket/qlocalsocket.cpp')
-rw-r--r--src/network/socket/qlocalsocket.cpp26
1 files changed, 20 insertions, 6 deletions
diff --git a/src/network/socket/qlocalsocket.cpp b/src/network/socket/qlocalsocket.cpp
index af7cdb76d2..d517f91aad 100644
--- a/src/network/socket/qlocalsocket.cpp
+++ b/src/network/socket/qlocalsocket.cpp
@@ -220,11 +220,25 @@ QT_BEGIN_NAMESPACE
/*!
\fn QLocalSocket::LocalSocketError QLocalSocket::error() const
+ \deprecated
+
+ Use socketError() instead.
+
+ Returns the type of error that last occurred.
+
+ \sa state(), errorString(), socketError()
+*/
+
+/*!
+ \fn QLocalSocket::LocalSocketError QLocalSocket::socketError() const
+ \since 5.15
+
Returns the type of error that last occurred.
\sa state(), errorString()
*/
+
/*!
\fn bool QLocalSocket::isValid() const
@@ -272,7 +286,7 @@ QT_BEGIN_NAMESPACE
Waits until the socket is connected, up to \a msecs milliseconds. If the
connection has been established, this function returns \c true; otherwise
it returns \c false. In the case where it returns \c false, you can call
- error() to determine the cause of the error.
+ socketError() to determine the cause of the error.
The following example waits up to one second for a connection
to be established:
@@ -291,7 +305,7 @@ QT_BEGIN_NAMESPACE
connection was successfully disconnected, this function returns \c true;
otherwise it returns \c false (if the operation timed out, if an error
occurred, or if this QLocalSocket is already disconnected). In the case
- where it returns \c false, you can call error() to determine the cause of
+ where it returns \c false, you can call socketError() to determine the cause of
the error.
The following example waits up to one second for a connection
@@ -337,7 +351,7 @@ QT_BEGIN_NAMESPACE
connections, you will have to register it with Q_DECLARE_METATYPE() and
qRegisterMetaType().
- \sa error(), errorString(), {Creating Custom Qt Types}
+ \sa socketError(), errorString(), {Creating Custom Qt Types}
*/
/*!
@@ -372,7 +386,7 @@ QLocalSocket::~QLocalSocket()
QLocalSocket::close();
#if !defined(Q_OS_WIN) && !defined(QT_LOCALSOCKET_TCP)
Q_D(QLocalSocket);
- d->unixSocket.setParent(0);
+ d->unixSocket.setParent(nullptr);
#endif
}
@@ -446,7 +460,7 @@ QString QLocalSocket::fullServerName() const
/*!
Returns the state of the socket.
- \sa error()
+ \sa socketError()
*/
QLocalSocket::LocalSocketState QLocalSocket::state() const
{
@@ -466,7 +480,7 @@ bool QLocalSocket::isSequential() const
The LocalServerError enumeration represents the errors that can occur.
The most recent error can be retrieved through a call to
- \l QLocalSocket::error().
+ \l QLocalSocket::socketError().
\value ConnectionRefusedError The connection was refused by
the peer (or timed out).