API reference - Class QLocalSocket

ClosingState

Signature: [static,const] QLocalSocket_LocalSocketState ClosingState

Description: Enum constant QLocalSocket::ClosingState

Python specific notes:
The object exposes a readable attribute 'ClosingState'. This is the getter.

ConnectedState

Signature: [static,const] QLocalSocket_LocalSocketState ConnectedState

Description: Enum constant QLocalSocket::ConnectedState

Python specific notes:
The object exposes a readable attribute 'ConnectedState'. This is the getter.

ConnectingState

Signature: [static,const] QLocalSocket_LocalSocketState ConnectingState

Description: Enum constant QLocalSocket::ConnectingState

Python specific notes:
The object exposes a readable attribute 'ConnectingState'. This is the getter.

ConnectionError

Signature: [static,const] QLocalSocket_LocalSocketError ConnectionError

Description: Enum constant QLocalSocket::ConnectionError

Python specific notes:
The object exposes a readable attribute 'ConnectionError'. This is the getter.

ConnectionRefusedError

Signature: [static,const] QLocalSocket_LocalSocketError ConnectionRefusedError

Description: Enum constant QLocalSocket::ConnectionRefusedError

Python specific notes:
The object exposes a readable attribute 'ConnectionRefusedError'. This is the getter.

DatagramTooLargeError

Signature: [static,const] QLocalSocket_LocalSocketError DatagramTooLargeError

Description: Enum constant QLocalSocket::DatagramTooLargeError

Python specific notes:
The object exposes a readable attribute 'DatagramTooLargeError'. This is the getter.

OperationError

Signature: [static,const] QLocalSocket_LocalSocketError OperationError

Description: Enum constant QLocalSocket::OperationError

Python specific notes:
The object exposes a readable attribute 'OperationError'. This is the getter.

PeerClosedError

Signature: [static,const] QLocalSocket_LocalSocketError PeerClosedError

Description: Enum constant QLocalSocket::PeerClosedError

Python specific notes:
The object exposes a readable attribute 'PeerClosedError'. This is the getter.

ServerNotFoundError

Signature: [static,const] QLocalSocket_LocalSocketError ServerNotFoundError

Description: Enum constant QLocalSocket::ServerNotFoundError

Python specific notes:
The object exposes a readable attribute 'ServerNotFoundError'. This is the getter.

SocketAccessError

Signature: [static,const] QLocalSocket_LocalSocketError SocketAccessError

Description: Enum constant QLocalSocket::SocketAccessError

Python specific notes:
The object exposes a readable attribute 'SocketAccessError'. This is the getter.

SocketResourceError

Signature: [static,const] QLocalSocket_LocalSocketError SocketResourceError

Description: Enum constant QLocalSocket::SocketResourceError

Python specific notes:
The object exposes a readable attribute 'SocketResourceError'. This is the getter.

SocketTimeoutError

Signature: [static,const] QLocalSocket_LocalSocketError SocketTimeoutError

Description: Enum constant QLocalSocket::SocketTimeoutError

Python specific notes:
The object exposes a readable attribute 'SocketTimeoutError'. This is the getter.

UnconnectedState

Signature: [static,const] QLocalSocket_LocalSocketState UnconnectedState

Description: Enum constant QLocalSocket::UnconnectedState

Python specific notes:
The object exposes a readable attribute 'UnconnectedState'. This is the getter.

UnknownSocketError

Signature: [static,const] QLocalSocket_LocalSocketError UnknownSocketError

Description: Enum constant QLocalSocket::UnknownSocketError

Python specific notes:
The object exposes a readable attribute 'UnknownSocketError'. This is the getter.

UnsupportedSocketOperationError

Signature: [static,const] QLocalSocket_LocalSocketError UnsupportedSocketOperationError

Description: Enum constant QLocalSocket::UnsupportedSocketOperationError

Python specific notes:
The object exposes a readable attribute 'UnsupportedSocketOperationError'. This is the getter.

_const_cast

Signature: [const] QLocalSocket ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

abort

Signature: void abort

Description: Method void QLocalSocket::abort()

aboutToClose

Signature: [signal] void aboutToClose

Description: Signal declaration for QLocalSocket::aboutToClose()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'aboutToClose'. This is the getter.
The object exposes a writable attribute 'aboutToClose'. This is the setter.

bytesAvailable

Signature: [const] long long bytesAvailable

Description: Method qint64 QLocalSocket::bytesAvailable()

This is a reimplementation of QIODevice::bytesAvailable

bytesToWrite

Signature: [const] long long bytesToWrite

Description: Method qint64 QLocalSocket::bytesToWrite()

This is a reimplementation of QIODevice::bytesToWrite

bytesWritten

Signature: [signal] void bytesWritten (long long bytes)

Description: Signal declaration for QLocalSocket::bytesWritten(qint64 bytes)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'bytesWritten'. This is the getter.
The object exposes a writable attribute 'bytesWritten'. This is the setter.

canReadLine

Signature: [const] bool canReadLine

Description: Method bool QLocalSocket::canReadLine()

This is a reimplementation of QIODevice::canReadLine

channelBytesWritten

Signature: [signal] void channelBytesWritten (int channel, long long bytes)

Description: Signal declaration for QLocalSocket::channelBytesWritten(int channel, qint64 bytes)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'channelBytesWritten'. This is the getter.
The object exposes a writable attribute 'channelBytesWritten'. This is the setter.

channelReadyRead

Signature: [signal] void channelReadyRead (int channel)

Description: Signal declaration for QLocalSocket::channelReadyRead(int channel)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'channelReadyRead'. This is the getter.
The object exposes a writable attribute 'channelReadyRead'. This is the setter.

close

Signature: void close

Description: Method void QLocalSocket::close()

This is a reimplementation of QIODevice::close

connectToServer

(1) Signature: void connectToServer (QIODevice_QFlags_OpenModeFlag openMode = QIODevice::ReadWrite)

Description: Method void QLocalSocket::connectToServer(QFlags<QIODevice::OpenModeFlag> openMode)

(2) Signature: void connectToServer (string name, QIODevice_QFlags_OpenModeFlag openMode = QIODevice::ReadWrite)

Description: Method void QLocalSocket::connectToServer(const QString &name, QFlags<QIODevice::OpenModeFlag> openMode)

connected

Signature: [signal] void connected

Description: Signal declaration for QLocalSocket::connected()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'connected'. This is the getter.
The object exposes a writable attribute 'connected'. This is the setter.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QLocalSocket::destroyed(QObject *)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

disconnectFromServer

Signature: void disconnectFromServer

Description: Method void QLocalSocket::disconnectFromServer()

disconnected

Signature: [signal] void disconnected

Description: Signal declaration for QLocalSocket::disconnected()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'disconnected'. This is the getter.
The object exposes a writable attribute 'disconnected'. This is the setter.

error

Signature: [const] QLocalSocket_LocalSocketError error

Description: Method QLocalSocket::LocalSocketError QLocalSocket::error()

error_sig

Signature: [signal] void error_sig (const QLocalSocket_LocalSocketError socketError)

Description: Signal declaration for QLocalSocket::error(QLocalSocket::LocalSocketError socketError)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'error_sig'. This is the getter.
The object exposes a writable attribute 'error_sig'. This is the setter.

flush

Signature: bool flush

Description: Method bool QLocalSocket::flush()

fullServerName

Signature: [const] string fullServerName

Description: Method QString QLocalSocket::fullServerName()

isSequential?

Signature: [const] bool isSequential?

Description: Method bool QLocalSocket::isSequential()

This is a reimplementation of QIODevice::isSequential

isValid?

Signature: [const] bool isValid?

Description: Method bool QLocalSocket::isValid()

new

Signature: [static] new QLocalSocket new (QObject ptr parent = nullptr)

Description: Constructor QLocalSocket::QLocalSocket(QObject *parent)

This method creates an object of class QLocalSocket.

Python specific notes:
This method is the default initializer of the object.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QLocalSocket::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'objectNameChanged'. This is the getter.
The object exposes a writable attribute 'objectNameChanged'. This is the setter.

open

Signature: bool open (QIODevice_QFlags_OpenModeFlag openMode = QIODevice::ReadWrite)

Description: Method bool QLocalSocket::open(QFlags<QIODevice::OpenModeFlag> openMode)

This is a reimplementation of QIODevice::open

readBufferSize

Signature: [const] long long readBufferSize

Description: Method qint64 QLocalSocket::readBufferSize()

Python specific notes:
The object exposes a readable attribute 'readBufferSize'. This is the getter.

readBufferSize=

Signature: void readBufferSize= (long long size)

Description: Method void QLocalSocket::setReadBufferSize(qint64 size)

Python specific notes:
The object exposes a writable attribute 'readBufferSize'. This is the setter.

readChannelFinished

Signature: [signal] void readChannelFinished

Description: Signal declaration for QLocalSocket::readChannelFinished()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'readChannelFinished'. This is the getter.
The object exposes a writable attribute 'readChannelFinished'. This is the setter.

readyRead

Signature: [signal] void readyRead

Description: Signal declaration for QLocalSocket::readyRead()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'readyRead'. This is the getter.
The object exposes a writable attribute 'readyRead'. This is the setter.

serverName

Signature: [const] string serverName

Description: Method QString QLocalSocket::serverName()

Python specific notes:
The object exposes a readable attribute 'serverName'. This is the getter.

serverName=

Signature: void serverName= (string name)

Description: Method void QLocalSocket::setServerName(const QString &name)

Python specific notes:
The object exposes a writable attribute 'serverName'. This is the setter.

setReadBufferSize

Signature: void setReadBufferSize (long long size)

Description: Method void QLocalSocket::setReadBufferSize(qint64 size)

Python specific notes:
The object exposes a writable attribute 'readBufferSize'. This is the setter.

setServerName

Signature: void setServerName (string name)

Description: Method void QLocalSocket::setServerName(const QString &name)

Python specific notes:
The object exposes a writable attribute 'serverName'. This is the setter.

setSocketDescriptor

Signature: bool setSocketDescriptor (long long socketDescriptor, const QLocalSocket_LocalSocketState socketState = QLocalSocket::ConnectedState, QIODevice_QFlags_OpenModeFlag openMode = QIODevice::ReadWrite)

Description: Method bool QLocalSocket::setSocketDescriptor(QIntegerForSizeof<void*>::Signed socketDescriptor, QLocalSocket::LocalSocketState socketState, QFlags<QIODevice::OpenModeFlag> openMode)

socketDescriptor

Signature: [const] long long socketDescriptor

Description: Method QIntegerForSizeof<void*>::Signed QLocalSocket::socketDescriptor()

state

Signature: [const] QLocalSocket_LocalSocketState state

Description: Method QLocalSocket::LocalSocketState QLocalSocket::state()

stateChanged

Signature: [signal] void stateChanged (const QLocalSocket_LocalSocketState socketState)

Description: Signal declaration for QLocalSocket::stateChanged(QLocalSocket::LocalSocketState socketState)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'stateChanged'. This is the getter.
The object exposes a writable attribute 'stateChanged'. This is the setter.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QLocalSocket::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QLocalSocket::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.

waitForBytesWritten

Signature: bool waitForBytesWritten (int msecs = 30000)

Description: Method bool QLocalSocket::waitForBytesWritten(int msecs)

This is a reimplementation of QIODevice::waitForBytesWritten

waitForConnected

Signature: bool waitForConnected (int msecs = 30000)

Description: Method bool QLocalSocket::waitForConnected(int msecs)

waitForDisconnected

Signature: bool waitForDisconnected (int msecs = 30000)

Description: Method bool QLocalSocket::waitForDisconnected(int msecs)

waitForReadyRead

Signature: bool waitForReadyRead (int msecs = 30000)

Description: Method bool QLocalSocket::waitForReadyRead(int msecs)

This is a reimplementation of QIODevice::waitForReadyRead