QLocalSocket

PyQt5.QtNetwork.QLocalSocket

Inherits from QIODevice.

Description

The QLocalSocket class provides a local socket.

On Windows this is a named pipe and on Unix this is a local domain socket.

If an error occurs, socketError() returns the type of error, and errorString() can be called to get a human readable description of what happened.

Although QLocalSocket is designed for use with an event loop, it’s possible to use it without one. In that case, you must use waitForConnected(), waitForReadyRead(), waitForBytesWritten(), and waitForDisconnected() which blocks until the operation is complete or the timeout expires.

See also

QLocalServer.

Enums

LocalSocketError

The LocalServerError enumeration represents the errors that can occur. The most recent error can be retrieved through a call to error.

Member	Value	Description
ConnectionError	QAbstractSocket::NetworkError	An error occurred with the connection.
ConnectionRefusedError	QAbstractSocket::ConnectionRefusedError	The connection was refused by the peer (or timed out).
DatagramTooLargeError	QAbstractSocket::DatagramTooLargeError	The datagram was larger than the operating system’s limit (which can be as low as 8192 bytes).
OperationError	0	An operation was attempted while the socket was in a state that did not permit it.
PeerClosedError	QAbstractSocket::RemoteHostClosedError	The remote socket closed the connection. Note that the client socket (i.e., this socket) will be closed after the remote close notification has been sent.
ServerNotFoundError	QAbstractSocket::HostNotFoundError	The local socket name was not found.
SocketAccessError	QAbstractSocket::SocketAccessError	The socket operation failed because the application lacked the required privileges.
SocketResourceError	QAbstractSocket::SocketResourceError	The local system ran out of resources (e.g., too many sockets).
SocketTimeoutError	QAbstractSocket::SocketTimeoutError	The socket operation timed out.
UnknownSocketError	QAbstractSocket::UnknownSocketError	An unidentified error occurred.
UnsupportedSocketOperationError	QAbstractSocket::UnsupportedSocketOperationError	The requested socket operation is not supported by the local operating system.

---

LocalSocketState

This enum describes the different states in which a socket can be.

See also

state().

Member	Value	Description
ClosingState	QAbstractSocket::ClosingState	The socket is about to close (data may still be waiting to be written).
ConnectedState	QAbstractSocket::ConnectedState	A connection is established.
ConnectingState	QAbstractSocket::ConnectingState	The socket has started establishing a connection.
UnconnectedState	QAbstractSocket::UnconnectedState	The socket is not connected.

Methods

__init__(parent: QObject = None)

Creates a new local socket. The parent argument is passed to QObject’s constructor.

---

abort()

TODO

---

bytesAvailable() → int

TODO

---

bytesToWrite() → int

TODO

---

canReadLine() → bool

TODO

---

close()

TODO

---

connectToServer(mode: Union[OpenMode, OpenModeFlag] = ReadWrite)

TODO

---

connectToServer(str, mode: Union[OpenMode, OpenModeFlag] = ReadWrite)

This is an overloaded function.

Set the server name and attempts to make a connection to it.

The socket is opened in the given openMode and first enters ConnectingState. If a connection is established, QLocalSocket enters ConnectedState and emits connected.

After calling this function, the socket can emit error to signal that an error occurred.

See also

state(), serverName(), waitForConnected().

---

disconnectFromServer()

TODO

---

error() → LocalSocketError

TODO

---

flush() → bool

TODO

---

fullServerName() → str

Returns the server path that the socket is connected to.

Note: The return value of this function is platform specific.

See also

connectToServer(), serverName().

---

isSequential() → bool

TODO

---

isValid() → bool

TODO

---

open(mode: Union[OpenMode, OpenModeFlag] = ReadWrite) → bool

TODO

---

readBufferSize() → int

See also

setReadBufferSize().

---

readData(int) → bytes

TODO

---

serverName() → str

Returns the name of the peer as specified by setServerName(), or an empty QString if setServerName() has not been called or connectToServer() failed.

See also

setServerName(), connectToServer(), fullServerName().

---

setReadBufferSize(int)

See also

readBufferSize().

---

setServerName(str)

Set the name of the peer to connect to. On Windows name is the name of a named pipe; on Unix name is the name of a local domain socket.

This function must be called when the socket is not connected.

See also

serverName().

---

setSocketDescriptor(sip.voidptr, state: LocalSocketState = ConnectedState, mode: Union[OpenMode, OpenModeFlag] = ReadWrite) → bool

TODO

---

socketDescriptor() → sip.voidptr

See also

setSocketDescriptor().

---

state() → LocalSocketState

Returns the state of the socket.

See also

error.

---

waitForBytesWritten(msecs: int = 30000) → bool

TODO

---

waitForConnected(msecs: int = 30000) → bool

TODO

---

waitForDisconnected(msecs: int = 30000) → bool

TODO

---

waitForReadyRead(msecs: int = 30000) → bool

TODO

---

writeData(bytes) → int

TODO

Signals

connected()

TODO

---

disconnected()

TODO

---

error()

TODO

---

error(LocalSocketError)

TODO

---

stateChanged(LocalSocketState)

TODO