QLocalSocket¶

The QLocalSocket class provides a local socket. More…

Synopsis¶

Functions¶

def abort ()
def connectToServer ([openMode=QIODeviceBase.ReadWrite])
def connectToServer (name[, openMode=QIODeviceBase.ReadWrite])
def connected ()
def disconnectFromServer ()
def disconnected ()
def error ()
def errorOccurred (socketError)
def flush ()
def fullServerName ()
def isValid ()
def readBufferSize ()
def serverName ()
def setReadBufferSize (size)
def setServerName (name)
def setSocketDescriptor (socketDescriptor[, socketState=ConnectedState[, openMode=QIODeviceBase.ReadWrite]])
def socketDescriptor ()
def state ()
def stateChanged (socketState)
def waitForConnected ([msecs=30000])
def waitForDisconnected ([msecs=30000])

Detailed Description¶

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

If an error occurs, 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 , waitForReadyRead() , waitForBytesWritten() , and which blocks until the operation is complete or the timeout expires.

See also

QLocalServer

class PySide6.QtNetwork.QLocalSocket([parent=None])¶

Parameters: parent – PySide6.QtCore.QObject

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

PySide6.QtNetwork.QLocalSocket.LocalSocketError¶

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

Constant

Description

QLocalSocket.ConnectionRefusedError

The connection was refused by the peer (or timed out).

QLocalSocket.PeerClosedError

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.

QLocalSocket.ServerNotFoundError

The local socket name was not found.

QLocalSocket.SocketAccessError

The socket operation failed because the application lacked the required privileges.

QLocalSocket.SocketResourceError

The local system ran out of resources (e.g., too many sockets).

QLocalSocket.SocketTimeoutError

The socket operation timed out.

QLocalSocket.DatagramTooLargeError

The datagram was larger than the operating system’s limit (which can be as low as 8192 bytes).

QLocalSocket.ConnectionError

An error occurred with the connection.

QLocalSocket.UnsupportedSocketOperationError

The requested socket operation is not supported by the local operating system.

QLocalSocket.OperationError

An operation was attempted while the socket was in a state that did not permit it.

QLocalSocket.UnknownSocketError

An unidentified error occurred.

PySide6.QtNetwork.QLocalSocket.LocalSocketState¶

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

Constant

Description

QLocalSocket.UnconnectedState

The socket is not connected.

QLocalSocket.ConnectingState

The socket has started establishing a connection.

QLocalSocket.ConnectedState

A connection is established.

QLocalSocket.ClosingState

The socket is about to close (data may still be waiting to be written).

See also

state()

PySide6.QtNetwork.QLocalSocket.abort()¶

PySide6.QtNetwork.QLocalSocket.connectToServer([openMode=QIODeviceBase.ReadWrite])¶

Parameters: openMode – OpenMode

PySide6.QtNetwork.QLocalSocket.connectToServer(name[, openMode=QIODeviceBase.ReadWrite])

Parameters

name – str
openMode – OpenMode

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 .

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

See also

state() serverName() waitForConnected()

PySide6.QtNetwork.QLocalSocket.connected()¶

PySide6.QtNetwork.QLocalSocket.disconnectFromServer()¶

PySide6.QtNetwork.QLocalSocket.disconnected()¶

PySide6.QtNetwork.QLocalSocket.error()¶

Return type: LocalSocketError

PySide6.QtNetwork.QLocalSocket.errorOccurred(socketError)¶

Parameters: socketError – LocalSocketError

PySide6.QtNetwork.QLocalSocket.flush()¶

Return type: bool

PySide6.QtNetwork.QLocalSocket.fullServerName()¶

Return type: str

Returns the server path that the socket is connected to.

Note

The return value of this function is platform specific.

Qt Documentation

Table of Contents

Previous topic

Next topic

QLocalSocket¶

Synopsis¶

Functions¶

Detailed Description¶

Constant	Description
QLocalSocket.ConnectionRefusedError	The connection was refused by the peer (or timed out).
QLocalSocket.PeerClosedError	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.
QLocalSocket.ServerNotFoundError	The local socket name was not found.
QLocalSocket.SocketAccessError	The socket operation failed because the application lacked the required privileges.
QLocalSocket.SocketResourceError	The local system ran out of resources (e.g., too many sockets).
QLocalSocket.SocketTimeoutError	The socket operation timed out.
QLocalSocket.DatagramTooLargeError	The datagram was larger than the operating system’s limit (which can be as low as 8192 bytes).
QLocalSocket.ConnectionError	An error occurred with the connection.
QLocalSocket.UnsupportedSocketOperationError	The requested socket operation is not supported by the local operating system.
QLocalSocket.OperationError	An operation was attempted while the socket was in a state that did not permit it.
QLocalSocket.UnknownSocketError	An unidentified error occurred.

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