QLocalServer Class

Dokumentation der Mitgliedsfunktionen

[explicit] QLocalServer::QLocalServer(QObject *parent = nullptr)

Erstellt einen neuen lokalen Socket-Server mit dem angegebenen parent.

Siehe auch listen().

[virtual noexcept] QLocalServer::~QLocalServer()

Zerstört das Objekt QLocalServer. Wenn der Server auf Verbindungen wartet, wird er automatisch geschlossen.

Alle Client QLocalSockets, die noch verbunden sind, müssen entweder die Verbindung trennen oder repariert werden, bevor der Server gelöscht wird.

Siehe auch close().

[protected, since 6.8] void QLocalServer::addPendingConnection(QLocalSocket *socket)

Diese Funktion wird von QLocalServer::incomingConnection() aufgerufen, um socket in die Liste der anstehenden eingehenden Verbindungen aufzunehmen.

Diese Funktion wurde in Qt 6.8 eingeführt.

Siehe auch incomingConnection() und newConnection().

void QLocalServer::close()

Hören Sie auf, auf eingehende Verbindungen zu warten. Bestehende Verbindungen sind davon nicht betroffen, aber alle neuen Verbindungen werden abgelehnt.

Siehe auch isListening() und listen().

QString QLocalServer::errorString() const

Gibt die von Menschen lesbare Meldung zurück, die dem aktuellen Fehler entspricht, der von serverError() gemeldet wurde. Ist keine geeignete Zeichenkette verfügbar, wird eine leere Zeichenkette zurückgegeben.

Siehe auch serverError().

QString QLocalServer::fullServerName() const

Gibt den vollständigen Pfad zurück, unter dem der Server lauscht.

Hinweis: Dies ist plattformspezifisch.

Siehe auch listen() und serverName().

[virtual] bool QLocalServer::hasPendingConnections() const

Gibt true zurück, wenn der Server eine schwebende Verbindung hat; andernfalls wird false zurückgegeben.

Siehe auch nextPendingConnection() und setMaxPendingConnections().

[virtual protected] void QLocalServer::incomingConnection(quintptr socketDescriptor)

Diese virtuelle Funktion wird von QLocalServer aufgerufen, wenn eine neue Verbindung verfügbar ist. socketDescriptor ist der native Socket-Deskriptor für die akzeptierte Verbindung.

Die Basisimplementierung erstellt eine QLocalSocket, setzt den Socket-Deskriptor und speichert dann die QLocalSocket in einer internen Liste ausstehender Verbindungen. Schließlich wird newConnection() ausgegeben.

Reimplementieren Sie diese Funktion, um das Verhalten des Servers zu ändern, wenn eine Verbindung verfügbar ist.

Siehe auch newConnection(), nextPendingConnection(), und QLocalSocket::setSocketDescriptor().

bool QLocalServer::isListening() const

Gibt true zurück, wenn der Server auf eingehende Verbindungen wartet, andernfalls false.

Siehe auch listen() und close().

bool QLocalServer::listen(const QString &name)

Weist den Server an, auf name auf eingehende Verbindungen zu warten. Wenn der Server gerade lauscht, wird false zurückgegeben. Bei Erfolg wird true zurückgegeben, ansonsten false.

name kann ein einzelner Name sein und QLocalServer wird den korrekten plattformspezifischen Pfad ermitteln. serverName() gibt den Namen zurück, der in listen übergeben wurde.

Normalerweise würde man nur einen Namen wie "foo" übergeben, aber unter Unix könnte dies auch ein Pfad wie "/tmp/foo" sein und unter Windows könnte dies ein Pipe-Pfad wie "\\.\pipe\foo" sein.

Siehe auch serverName(), isListening(), und close().

bool QLocalServer::listen(qintptr socketDescriptor)

Weist den Server an, auf socketDescriptor auf eingehende Verbindungen zu warten. Die Eigenschaft gibt false zurück, wenn der Server gerade lauscht. Bei Erfolg gibt sie true zurück, andernfalls false. Der Socket muss bereit sein, neue Verbindungen anzunehmen, ohne dass zusätzliche plattformspezifische Funktionen aufgerufen werden. Der Socket wird in den nicht-blockierenden Modus versetzt.

serverName(), fullServerName() können eine Zeichenkette mit einem Namen zurückgeben, wenn diese Option von der Plattform unterstützt wird; andernfalls geben sie einen leeren QString zurück. Insbesondere die Adressen von Sockets im abstrakten Namensraum, der von Linux unterstützt wird, liefern keine nützlichen Namen, wenn sie nicht druckbare Zeichen enthalten.

Siehe auch isListening() und close().

[since 6.3] int QLocalServer::listenBacklogSize() const

Gibt die Größe der Rückstandswarteschlange der zu akzeptierenden Verbindungen zurück.

Diese Funktion wurde in Qt 6.3 eingeführt.

Siehe auch setListenBacklogSize().

int QLocalServer::maxPendingConnections() const

Gibt die maximale Anzahl der anstehenden akzeptierten Verbindungen zurück. Der Standardwert ist 30.

Siehe auch setMaxPendingConnections() und hasPendingConnections().

[signal] void QLocalServer::newConnection()

Dieses Signal wird jedes Mal ausgesendet, wenn eine neue Verbindung verfügbar ist.

Siehe auch hasPendingConnections() und nextPendingConnection().

[virtual] QLocalSocket *QLocalServer::nextPendingConnection()

Gibt die nächste anstehende Verbindung als verbundenes QLocalSocket Objekt zurück.

Der Socket wird als Kind des Servers erstellt, was bedeutet, dass er automatisch gelöscht wird, wenn das QLocalServer Objekt zerstört wird. Es ist dennoch eine gute Idee, das Objekt explizit zu löschen, wenn Sie damit fertig sind, um Speicherverschwendung zu vermeiden.

nullptr wird zurückgegeben, wenn diese Funktion aufgerufen wird und keine Verbindungen anstehen.

Siehe auch hasPendingConnections(), newConnection(), und incomingConnection().

[static] bool QLocalServer::removeServer(const QString &name)

Entfernt jede Serverinstanz, die einen Aufruf von listen() zum Scheitern bringen könnte, und gibt im Erfolgsfall true zurück; andernfalls gibt sie false zurück. Diese Funktion ist dazu gedacht, sich von einem Absturz zu erholen, wenn die vorherige Serverinstanz noch nicht bereinigt wurde.

Unter Windows bewirkt diese Funktion nichts; unter Unix entfernt sie die Socket-Datei, die durch name angegeben wird.

QAbstractSocket::SocketError QLocalServer::serverError() const

Gibt den Typ des zuletzt aufgetretenen Fehlers zurück oder NoError.

Siehe auch errorString().

QString QLocalServer::serverName() const

Gibt den Servernamen zurück, wenn der Server auf Verbindungen wartet; andernfalls wird QString() zurückgegeben.

Siehe auch listen() und fullServerName().

[since 6.3] void QLocalServer::setListenBacklogSize(int size)

Setzt die Größe der Warteschlange für zu akzeptierende Verbindungen auf size. Das Betriebssystem kann diesen Wert reduzieren oder ignorieren. Standardmäßig beträgt die Größe der Warteschlange 50.

Diese Funktion wurde in Qt 6.3 eingeführt.

Siehe auch listenBacklogSize().

void QLocalServer::setMaxPendingConnections(int numConnections)

Setzt die maximale Anzahl der anstehenden akzeptierten Verbindungen auf numConnections. QLocalServer wird nicht mehr als numConnections eingehende Verbindungen akzeptieren, bevor nextPendingConnection() aufgerufen wird.

Hinweis: Auch wenn QLocalServer keine neuen Verbindungen mehr annimmt, nachdem es seine maximale Anzahl an ausstehenden Verbindungen erreicht hat, kann das Betriebssystem diese noch in der Warteschlange halten, was dazu führt, dass Clients signalisieren, dass sie verbunden sind.

Siehe auch maxPendingConnections() und hasPendingConnections().

qintptr QLocalServer::socketDescriptor() const

Gibt den nativen Socket-Deskriptor zurück, den der Server verwendet, um auf eingehende Anweisungen zu warten, oder -1, wenn der Server nicht wartet.

Der Typ des Deskriptors hängt von der Plattform ab:

• Unter Windows ist der zurückgegebene Wert ein Winsock 2 Socket Handle.
• Unter INTEGRITY ist der Rückgabewert der QTcpServer Socket Deskriptor und der Typ ist durch socketDescriptor definiert.
• Auf allen anderen UNIX-ähnlichen Betriebssystemen ist der Typ ein Dateideskriptor, der einen lauschenden Socket darstellt.

Siehe auch listen().

QLocalServer::SocketOptions QLocalServer::socketOptions() const

Gibt die Socket-Optionen zurück, die auf dem Socket eingestellt sind.

Siehe auch setSocketOptions().

bool QLocalServer::waitForNewConnection(int msec = 0, bool *timedOut = nullptr)

Wartet höchstens msec Millisekunden lang oder bis eine eingehende Verbindung verfügbar ist. Gibt true zurück, wenn eine Verbindung verfügbar ist; andernfalls false. Wenn der Vorgang eine Zeitüberschreitung hatte und timedOut nicht nullptr ist, wird *timedOut auf true gesetzt.

Dies ist ein blockierender Funktionsaufruf. Seine Verwendung ist in einer Single-Thread-GUI-Anwendung nicht ratsam, da die gesamte Anwendung nicht mehr reagiert, bis die Funktion zurückkehrt. waitForNewConnection() ist hauptsächlich dann nützlich, wenn keine Ereignisschleife verfügbar ist.

Die nicht-blockierende Alternative ist die Verbindung mit dem Signal newConnection().

Wenn msec -1 ist, wird diese Funktion nicht abgebrochen.

Siehe auch hasPendingConnections() und nextPendingConnection().