PythonQt.Qt.QLocalServer
QLocalServer
PythonQtInstanceWrapper object
Native bases: PythonQtInstanceWrapper
Supplemental documentation: Qt 5 reference:
Detailed Description
This class makes it possible to accept incoming local socket connections.
Call listen() to have the server start listening for incoming connections on a specified key. The newConnection() signal is then emitted each time a client connects to the server.
Call nextPendingConnection() to accept the pending connection as a connected QLocalSocket. The function returns a pointer to a QLocalSocket that can be used for communicating with the client.
If an error occurs, serverError() returns the type of error, and errorString() can be called to get a human readable description of what happened.
When listening for connections, the name which the server is listening on is available through serverName().
Calling close() makes QLocalServer stop listening for incoming connections.
Although QLocalServer is designed for use with an event loop, it's possible to use it without one. In that case, you must use waitForNewConnection(), which blocks until either a connection is available or a timeout expires.
Source: https://doc.qt.io/archives/qt-5.15/qlocalserver.html
Complete member index
Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.
| Member | Kind | Signature | Summary |
|---|---|---|---|
GroupAccessOption |
attribute | Any |
(shared captured text) |
NoOptions |
attribute | Any |
(shared captured text) |
OtherAccessOption |
attribute | Any |
(shared captured text) |
SocketOption |
attribute | type |
Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text) |
SocketOptions |
attribute | type |
Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text) |
UserAccessOption |
attribute | Any |
(shared captured text) |
WorldAccessOption |
attribute | Any |
(shared captured text) |
__init__ |
function | (self, *args: Any, **kwargs: Any) -> None |
Native constructor; consult class documentation for supported overloads. (shared captured text) |
blockSignals |
function | (self, b: Any) -> bool |
X.blockSignals(b) -> bool (shared captured text) |
childEvent |
function | (self, event: Any) -> Any |
(shared captured text) |
children |
function | (self) -> tuple |
X.children() -> tuple (shared captured text) |
className |
function | (self, *args: Any, **kwargs: Any) -> Any |
Return the classname of the object (shared captured text) |
close |
function | (self) -> None |
Stop listening for incoming connections. (shared captured text) |
connect |
function | (self, signal: Any, receiver: Any, slot: Any, type: Any) -> bool |
X.connect(signal, receiver, slot, type) -> bool (shared captured text) |
customEvent |
function | (self, event: Any) -> Any |
(shared captured text) |
delete |
function | (self, *args: Any, **kwargs: Any) -> Any |
Deletes the C++ object (at your own risk, my friend!) (shared captured text) |
deleteLater |
function | (self) -> Any |
(shared captured text) |
destroyed |
function | (self, *args: Any, **kwargs: Any) -> Any |
Native PythonQt.Qt.QLocalServer.destroyed; argument details are not documented. |
disconnect |
function | (self, signal: Any, receiver: Any, slot: Any) -> bool |
X.disconnect(signal, receiver, slot) -> bool (shared captured text) |
dumpObjectInfo |
function | (self) -> Any |
(shared captured text) |
dumpObjectTree |
function | (self) -> Any |
(shared captured text) |
dynamicPropertyNames |
function | (self) -> Any |
(shared captured text) |
errorString |
function | (self) -> str |
X.errorString() -> str (shared captured text) |
event |
function | (self, event: Any) -> bool |
X.event(event) -> bool (shared captured text) |
eventFilter |
function | (self, watched: Any, event: Any) -> bool |
X.eventFilter(watched, event) -> bool (shared captured text) |
findChild |
function | (self, type: Any, name: Any) -> Any |
X.findChild(type, name) -> PythonQt.private.QObject (shared captured text) |
findChildren |
function | (self, type: Any, name: Any) -> tuple |
X.findChildren(type, name) -> tuple (shared captured text) |
fullServerName |
function | (self) -> str |
X.fullServerName() -> str (shared captured text) |
hasPendingConnections |
function | (self) -> bool |
X.hasPendingConnections() -> bool (shared captured text) |
help |
function | (self, *args: Any, **kwargs: Any) -> Any |
Shows the help of available methods for this class (shared captured text) |
incomingConnection |
function | (self, socketDescriptor: int) -> None |
This virtual function is called by [QLocalServer](https://doc.qt.io/archives/qt-5.15/qlocalserver.html) when a new connection is available. socketDescriptor is the native socket descriptor for the⦠(shared captured text) |
inherits |
function | (self, *args: Any, **kwargs: Any) -> Any |
Returns if the class inherits or is of given type name (shared captured text) |
installEventFilter |
function | (self, filterObj: Any) -> Any |
(shared captured text) |
isListening |
function | (self) -> bool |
X.isListening() -> bool (shared captured text) |
isSignalConnected |
function | (self, signal: Any) -> bool |
X.isSignalConnected(signal) -> bool (shared captured text) |
isWidgetType |
function | (self) -> bool |
X.isWidgetType() -> bool (shared captured text) |
isWindowType |
function | (self) -> bool |
X.isWindowType() -> bool (shared captured text) |
killTimer |
function | (self, id: Any) -> Any |
(shared captured text) |
listen |
function | (self, name: Any) -> bool |
X.listen(name) -> bool (shared captured text) |
maxPendingConnections |
function | (self) -> int |
X.maxPendingConnections() -> int (shared captured text) |
metaObject |
function | (self) -> Any |
X.metaObject() -> PythonQt.QtCore.QMetaObject (shared captured text) |
moveToThread |
function | (self, thread: Any) -> Any |
(shared captured text) |
newConnection |
function | (self, *args: Any, **kwargs: Any) -> Any |
Native PythonQt.Qt.QLocalServer.newConnection; argument details are not documented. |
nextPendingConnection |
function | (self) -> Any |
X.nextPendingConnection() -> PythonQt.QtNetwork.QLocalSocket (shared captured text) |
objectName |
attribute | Any |
(shared captured text) |
objectNameChanged |
function | (self, *args: Any, **kwargs: Any) -> Any |
Native PythonQt.Qt.QLocalServer.objectNameChanged; argument details are not documented. |
parent |
function | (self) -> Any |
X.parent() -> PythonQt.private.QObject (shared captured text) |
property |
function | (self, name: Any) -> Any |
X.property(name) -> object (shared captured text) |
removeEventFilter |
function | (self, obj: Any) -> Any |
(shared captured text) |
removeServer |
function | (self, name: str) -> bool |
X.removeServer(name) -> bool (shared captured text) |
sender |
function | (self) -> Any |
X.sender() -> PythonQt.private.QObject (shared captured text) |
senderSignalIndex |
function | (self) -> int |
X.senderSignalIndex() -> int (shared captured text) |
serverError |
function | (self) -> Any |
Returns the type of error that occurred last or [NoError](https://doc.qt.io/archives/qt-5.15/qdtls.html#QDtlsError-enum). (shared captured text) |
serverName |
function | (self) -> str |
X.serverName() -> str (shared captured text) |
setMaxPendingConnections |
function | (self, numConnections: int) -> None |
Sets the maximum number of pending accepted connections to numConnections. (shared captured text) |
setObjectName |
function | (self, name: Any) -> Any |
(shared captured text) |
setParent |
function | (self, parent: Any) -> Any |
(shared captured text) |
setProperty |
function | (self, name: Any, value: Any) -> bool |
X.setProperty(name, value) -> bool (shared captured text) |
setSocketOptions |
function | (self, options: Any) -> None |
(shared captured text) |
signalsBlocked |
function | (self) -> bool |
X.signalsBlocked() -> bool (shared captured text) |
socketOptions |
attribute | Any |
The setSocketOptions method controls how the socket operates. (shared captured text) |
startTimer |
function | (self, interval: Any, timerType: Any) -> int |
X.startTimer(interval, timerType) -> int (shared captured text) |
thread |
function | (self) -> Any |
(shared captured text) |
timerEvent |
function | (self, event: Any) -> Any |
(shared captured text) |
tr |
function | (self, text: Any, ambig: Any, n: Any) -> str |
X.tr(text, ambig, n) -> str (shared captured text) |
waitForNewConnection |
function | (self, msec: int, timedOut: Any) -> bool |
X.waitForNewConnection(msec, timedOut) -> bool (shared captured text) |