API reference - Class QLocalServer

GroupAccessOption

Signature: [static,const] QLocalServer_SocketOption GroupAccessOption

Description: Enum constant QLocalServer::GroupAccessOption

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

NoOptions

Signature: [static,const] QLocalServer_SocketOption NoOptions

Description: Enum constant QLocalServer::NoOptions

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

OtherAccessOption

Signature: [static,const] QLocalServer_SocketOption OtherAccessOption

Description: Enum constant QLocalServer::OtherAccessOption

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

UserAccessOption

Signature: [static,const] QLocalServer_SocketOption UserAccessOption

Description: Enum constant QLocalServer::UserAccessOption

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

WorldAccessOption

Signature: [static,const] QLocalServer_SocketOption WorldAccessOption

Description: Enum constant QLocalServer::WorldAccessOption

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

_const_cast

Signature: [const] QLocalServer 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.

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QLocalServer::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

close

Signature: void close

Description: Method void QLocalServer::close()

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QLocalServer::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

destroyed

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

Description: Signal declaration for QLocalServer::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.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QLocalServer::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QLocalServer::destroyed(QObject *)

Call this method to emit this signal.

emit_newConnection

Signature: void emit_newConnection

Description: Emitter for signal void QLocalServer::newConnection()

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QLocalServer::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

errorString

Signature: [const] string errorString

Description: Method QString QLocalServer::errorString()

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QLocalServer::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QLocalServer::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

fullServerName

Signature: [const] string fullServerName

Description: Method QString QLocalServer::fullServerName()

hasPendingConnections

Signature: [const] bool hasPendingConnections

Description: Virtual method bool QLocalServer::hasPendingConnections()

This method can be reimplemented in a derived class.

incomingConnection

Signature: void incomingConnection (unsigned long long socketDescriptor)

Description: Virtual method void QLocalServer::incomingConnection(quintptr socketDescriptor)

This method can be reimplemented in a derived class.

isListening?

Signature: [const] bool isListening?

Description: Method bool QLocalServer::isListening()

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QLocalServer::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

listen

(1) Signature: bool listen (string name)

Description: Method bool QLocalServer::listen(const QString &name)

(2) Signature: bool listen (long long socketDescriptor)

Description: Method bool QLocalServer::listen(QIntegerForSizeof<void*>::Signed socketDescriptor)

maxPendingConnections

Signature: [const] int maxPendingConnections

Description: Method int QLocalServer::maxPendingConnections()

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

maxPendingConnections=

Signature: void maxPendingConnections= (int numConnections)

Description: Method void QLocalServer::setMaxPendingConnections(int numConnections)

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

new

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

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

This method creates an object of class QLocalServer.

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

newConnection

Signature: [signal] void newConnection

Description: Signal declaration for QLocalServer::newConnection()

You can bind a procedure to this signal.

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

nextPendingConnection

Signature: QLocalSocket ptr nextPendingConnection

Description: Virtual method QLocalSocket *QLocalServer::nextPendingConnection()

This method can be reimplemented in a derived class.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QLocalServer::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.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QLocalServer::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

removeServer

Signature: [static] bool removeServer (string name)

Description: Static method bool QLocalServer::removeServer(const QString &name)

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

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QLocalServer::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QLocalServer::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

serverError

Signature: [const] QAbstractSocket_SocketError serverError

Description: Method QAbstractSocket::SocketError QLocalServer::serverError()

serverName

Signature: [const] string serverName

Description: Method QString QLocalServer::serverName()

setMaxPendingConnections

Signature: void setMaxPendingConnections (int numConnections)

Description: Method void QLocalServer::setMaxPendingConnections(int numConnections)

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

setSocketOptions

Signature: void setSocketOptions (QLocalServer_QFlags_SocketOption options)

Description: Method void QLocalServer::setSocketOptions(QFlags<QLocalServer::SocketOption> options)

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

socketDescriptor

Signature: [const] long long socketDescriptor

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

socketOptions

Signature: [const] QLocalServer_QFlags_SocketOption socketOptions

Description: Method QFlags<QLocalServer::SocketOption> QLocalServer::socketOptions()

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

socketOptions=

Signature: void socketOptions= (QLocalServer_QFlags_SocketOption options)

Description: Method void QLocalServer::setSocketOptions(QFlags<QLocalServer::SocketOption> options)

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QLocalServer::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

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

Description: Static method QString QLocalServer::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 QLocalServer::trUtf8(const char *s, const char *c, int n)

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

waitForNewConnection

Signature: bool waitForNewConnection (int msec = 0, bool ptr timedOut = nullptr)

Description: Method bool QLocalServer::waitForNewConnection(int msec, bool *timedOut)