QLocalServer Class

Dokumentation zu den Mitgliedsfunktionen

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

Erstellen Sie einen neuen lokalen Socket-Server mit der angegebenen Adresse parent.

Siehe auch listen().

[virtual noexcept] QLocalServer::~QLocalServer()

Löscht das ` QLocalServer `-Objekt. Wenn der Server auf Verbindungen wartet, wird die Verbindung automatisch geschlossen.

Alle noch verbundenen Client-`QLocalSockets` müssen entweder die Verbindung trennen oder einem neuen Elternobjekt zugeordnet 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 die ` socket ` zur Liste der ausstehenden eingehenden Verbindungen hinzuzufügen.

Diese Funktion wurde in Qt 6.8 eingeführt.

Siehe auch ` incomingConnection()` und ` newConnection()`.

void QLocalServer::close()

Das Abhören auf eingehende Verbindungen wird beendet. Bestehende Verbindungen sind davon nicht betroffen, neue Verbindungen werden jedoch abgelehnt.

Siehe auch isListening() und listen().

QString QLocalServer::errorString() const

Gibt die für den aktuellen, von serverError() gemeldeten Fehler passende, für Menschen lesbare Meldung zurück. Ist keine passende Zeichenkette verfügbar, wird eine leere Zeichenkette zurückgegeben.

Siehe auch serverError().

QString QLocalServer::fullServerName() const

Gibt den vollständigen Pfad zurück, auf dem der Server auf eingehende Verbindungen wartet.

Hinweis: Dies ist plattformabhängig

Siehe auch listen() und serverName().

[virtual] bool QLocalServer::hasPendingConnections() const

Gibt „ true “ zurück, wenn der Server eine ausstehende Verbindung hat; andernfalls gibt er „ false “ zurück.

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 einen ` QLocalSocket`, legt den Socket-Deskriptor fest und speichert den ` QLocalSocket ` anschließend in einer internen Liste ausstehender Verbindungen. Abschließend wird ` newConnection()` ausgelöst.

Implementieren Sie diese Funktion neu, 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 eingehende Verbindungen unter name zu warten. Wenn der Server bereits auf Verbindungen wartet, schlägt die Funktion `listen()` fehl. Gibt bei Erfolg ` true ` zurück, andernfalls ` false `.

name Es kann ein einzelner Name angegeben werden, und QLocalServer ermittelt den korrekten plattformspezifischen Pfad. serverName() gibt den Namen zurück, der an listen() übergeben wurde.

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

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

bool QLocalServer::listen(qintptr socketDescriptor)

Weist den Server an, auf eingehende Verbindungen unter socketDescriptor zu warten. Die Eigenschaft gibt „ false “ zurück, wenn der Server derzeit auf Verbindungen wartet. Bei Erfolg gibt sie „ true “ zurück; andernfalls gibt sie „ false “ zurück. 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, sofern diese Option von der Plattform unterstützt wird; andernfalls geben sie ein leeres QString zurück. Insbesondere liefern die Adressen von Sockets im von Linux unterstützten abstrakten Namensraum keine aussagekräftigen Namen, wenn sie nicht druckbare Zeichen enthalten.

Siehe auch ` isListening()` und ` close()`.

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

Gibt die Größe der Backlog-Warteschlange der noch anzunehmenden Verbindungen zurück.

Diese Funktion wurde in Qt 6.3 eingeführt.

Siehe auch ` setListenBacklogSize()`.

int QLocalServer::maxPendingConnections() const

Gibt die maximale Anzahl ausstehender akzeptierter Verbindungen zurück. Der Standardwert beträgt 30.

Siehe auch setMaxPendingConnections() und hasPendingConnections().

[signal] void QLocalServer::newConnection()

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

Siehe auch hasPendingConnections() und nextPendingConnection().

[virtual] QLocalSocket *QLocalServer::nextPendingConnection()

Gibt die nächste ausstehende Verbindung als verbundenes „ QLocalSocket “-Objekt zurück.

Der Socket wird als untergeordnetes Element des Servers erstellt, was bedeutet, dass er automatisch gelöscht wird, wenn das ` QLocalServer `-Objekt zerstört wird. Es empfiehlt sich dennoch, das Objekt explizit zu löschen, wenn Sie es nicht mehr benötigen, um Speicherplatzverschwendung zu vermeiden.

nullptr wird zurückgegeben, wenn diese Funktion aufgerufen wird, während keine ausstehenden Verbindungen vorhanden sind.

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

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

Entfernt jede Serverinstanz, die dazu führen könnte, dass ein Aufruf von ` listen()` fehlschlägt, und gibt bei Erfolg ` true ` zurück; andernfalls wird ` false` zurückgegeben. Diese Funktion dient dazu, nach einem Absturz wiederherzustellen, wenn die vorherige Serverinstanz nicht bereinigt wurde.

Unter Windows führt diese Funktion keine Aktion aus; unter Unix entfernt sie die durch ` name` angegebene Socket-Datei.

QAbstractSocket::SocketError QLocalServer::serverError() const

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

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)

Legt die Größe der Backlog-Warteschlange für anzunehmende Verbindungen auf ` size` fest. Das Betriebssystem kann diesen Wert verringern oder ignorieren. Standardmäßig beträgt die Warteschlangengröße 50.

Diese Funktion wurde in Qt 6.3 eingeführt.

Siehe auch ` listenBacklogSize()`.

void QLocalServer::setMaxPendingConnections(int numConnections)

Legt die maximale Anzahl ausstehender akzeptierter Verbindungen auf numConnections fest. QLocalServer akzeptiert nicht mehr als numConnections eingehende Verbindungen, bevor nextPendingConnection() aufgerufen wird.

Hinweis: Auch wenn QLocalServer keine neuen Verbindungen mehr akzeptiert, sobald die maximale Anzahl an ausstehenden Verbindungen erreicht ist, kann es vorkommen, dass das Betriebssystem diese weiterhin in der Warteschlange hält, was dazu führt, dass Clients signalisieren, dass eine Verbindung besteht.

Siehe auch maxPendingConnections() und hasPendingConnections().

qintptr QLocalServer::socketDescriptor() const

Gibt den nativen Socket-Deskriptor zurück, den der Server zum Abhören eingehender Befehle verwendet, oder -1, wenn der Server nicht im Abhörmodus ist.

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

• Unter Windows ist der Rückgabewert ein Winsock-2-Socket-Handle.
• Unter INTEGRITY ist der Rückgabewert der Socket-Deskriptor „ QTcpServer “, und der Typ wird durch ` socketDescriptor` definiert.
• Auf allen anderen UNIX-ähnlichen Betriebssystemen ist der Typ ein Dateideskriptor, der einen Listening-Socket darstellt.

Siehe auch listen().

QLocalServer::SocketOptions QLocalServer::socketOptions() const

Gibt die für den Socket festgelegten Socket-Optionen zurück.

Siehe auch ` setSocketOptions()`.

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

Wartet höchstens msec Millisekunden oder so lange, bis eine eingehende Verbindung verfügbar ist. Gibt „ true “ zurück, wenn eine Verbindung verfügbar ist; andernfalls wird „ false “ zurückgegeben. Wenn das Zeitlimit für den Vorgang abgelaufen ist und „ timedOut “ nicht „ nullptr “ ist, wird *timedOut auf „true“ gesetzt.

Dies ist ein blockierender Funktionsaufruf. Von seiner Verwendung in einer Single-Thread-GUI-Anwendung wird abgeraten, da die gesamte Anwendung nicht mehr reagiert, bis die Funktion zurückkehrt. waitForNewConnection() ist vor allem dann nützlich, wenn keine Ereignisschleife verfügbar ist.

Die nicht blockierende Alternative besteht darin, sich an das Signal „ newConnection()“ anzuhängen.

Ist `msec` gleich -1, läuft diese Funktion nicht ab.

Siehe auch ` hasPendingConnections()` und ` nextPendingConnection()`.