QLocalSocket Class

Dokumentation zu den Mitgliedsfunktionen

QLocalSocket::QLocalSocket(QObject *parent = nullptr)

Erstellt einen neuen lokalen Socket. Das Argument „ parent “ wird an den Konstruktor von „ QObject “ übergeben.

[virtual noexcept] QLocalSocket::~QLocalSocket()

Löscht den Socket und schließt gegebenenfalls die Verbindung.

void QLocalSocket::abort()

Beendet die aktuelle Verbindung und setzt den Socket zurück. Im Gegensatz zu ` disconnectFromServer()` schließt diese Funktion den Socket sofort und löscht dabei alle im Schreibpuffer befindlichen Daten.

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

[override virtual] qint64 QLocalSocket::bytesAvailable() const

Implementiert: ` QIODevice::bytesAvailable()` const.

[override virtual] qint64 QLocalSocket::bytesToWrite() const

Implementiert neu: ` QIODevice::bytesToWrite()` const.

[override virtual] bool QLocalSocket::canReadLine() const

Implementiert: ` QIODevice::canReadLine()` const.

[override virtual] void QLocalSocket::close()

Implementiert: ` QIODevice::close()`.

Schließt das E/A-Gerät für den Socket und ruft disconnectFromServer() auf, um die Verbindung des Sockets zu schließen.

Eine Beschreibung der Aktionen, die beim Schließen eines E/A-Geräts erfolgen, finden Sie unter QIODevice::close().

Siehe auch abort().

void QLocalSocket::connectToServer(QIODeviceBase::OpenMode openMode = ReadWrite)

Es wird versucht, eine Verbindung zu serverName() herzustellen. setServerName() muss aufgerufen werden, bevor Sie die Verbindung öffnen. Alternativ können Sie connectToServer(const QString &name, OpenMode openMode) verwenden;

Der Socket wird im angegebenen openMode geöffnet und wechselt zunächst in den Modus ConnectingState. Wenn eine Verbindung hergestellt wurde, wechselt QLocalSocket in den Modus ConnectedState und sendet connected().

Nach dem Aufruf dieser Funktion kann der Socket errorOccurred() auslösen, um zu signalisieren, dass ein Fehler aufgetreten ist.

Siehe auch state(), serverName() und waitForConnected().

void QLocalSocket::connectToServer(const QString &name, QIODeviceBase::OpenMode openMode = ReadWrite)

Legt die Server- name fest und versucht, eine Verbindung zu diesem Server herzustellen.

Der Socket wird unter der angegebenen openMode geöffnet und ruft zunächst ConnectingState auf. Wenn eine Verbindung hergestellt wurde, ruft QLocalSocket ConnectedState auf und gibt connected() aus.

Nach dem Aufruf dieser Funktion kann der Socket errorOccurred() ausgeben, um zu signalisieren, dass ein Fehler aufgetreten ist.

Siehe auch state(), serverName() und waitForConnected().

[signal] void QLocalSocket::connected()

Dieses Signal wird ausgelöst, nachdem connectToServer() aufgerufen wurde und eine Verbindung erfolgreich hergestellt wurde.

Siehe auch connectToServer() und disconnected().

void QLocalSocket::disconnectFromServer()

Versucht, den Socket zu schließen. Wenn noch Daten zum Schreiben anstehen, wechselt „ QLocalSocket “ in den Zustand „ ClosingState “ und wartet, bis alle Daten geschrieben wurden. Schließlich wechselt es in den Zustand „ UnconnectedState “ und sendet das Signal „ disconnected()“.

Siehe auch connectToServer().

[signal] void QLocalSocket::disconnected()

Dieses Signal wird ausgegeben, wenn die Verbindung zum Socket getrennt wurde.

Siehe auch connectToServer(), disconnectFromServer(), abort() und connected().

QLocalSocket::LocalSocketError QLocalSocket::error() const

Gibt den Typ des zuletzt aufgetretenen Fehlers zurück.

Siehe auch „ state()“ und „ errorString()“.

[signal] void QLocalSocket::errorOccurred(QLocalSocket::LocalSocketError socketError)

Dieses Signal wird ausgegeben, nachdem ein Fehler aufgetreten ist. Der Parameter „ socketError “ beschreibt die Art des aufgetretenen Fehlers.

Siehe auch „ error()“ und „ errorString()“.

bool QLocalSocket::flush()

Diese Funktion schreibt so viel wie möglich aus dem internen Schreibpuffer in den Socket, ohne zu blockieren. Wenn Daten geschrieben wurden, gibt diese Funktion „ true “ zurück; andernfalls wird „false“ zurückgegeben.

Rufen Sie diese Funktion auf, wenn Sie „ QLocalSocket “ benötigen, um sofort mit dem Senden der gepufferten Daten zu beginnen. Die Anzahl der erfolgreich geschriebenen Bytes hängt vom Betriebssystem ab. In den meisten Fällen müssen Sie diese Funktion nicht aufrufen, da „ QLocalSocket “ automatisch mit dem Senden der Daten beginnt, sobald die Kontrolle wieder an die Ereignisschleife zurückgegeben wird. Wenn keine Ereignisschleife vorhanden ist, rufen Sie stattdessen „ waitForBytesWritten()“ auf.

Siehe auch „ write()“ und „ waitForBytesWritten()“.

QString QLocalSocket::fullServerName() const

Gibt den Serverpfad zurück, mit dem der Socket verbunden ist.

Siehe auch connectToServer() und serverName().

[override virtual] bool QLocalSocket::isSequential() const

Implementiert: ` QIODevice::isSequential()` const.

bool QLocalSocket::isValid() const

Gibt „ true “ zurück, wenn der Socket gültig und einsatzbereit ist; andernfalls wird „ false “ zurückgegeben.

Siehe auch state() und connectToServer().

[override virtual] bool QLocalSocket::open(QIODeviceBase::OpenMode openMode = ReadWrite)

Implementiert: ` QIODevice::open` (Modus `QIODeviceBase::OpenMode`).

Entspricht connectToServer(OpenMode-Modus). Der Socket wird im angegebenen openMode zum Server geöffnet, der durch setServerName() definiert ist.

Beachten Sie, dass im Gegensatz zu den meisten anderen Unterklassen von ` QIODevice ` die Funktion `open()` das Gerät möglicherweise nicht direkt öffnet. Die Funktion gibt `false` zurück, wenn der Socket bereits verbunden war oder wenn der Server, mit dem eine Verbindung hergestellt werden soll, nicht definiert wurde, und in allen anderen Fällen `true`. Die Signale ` connected()` oder ` errorOccurred()` werden ausgelöst, sobald das Gerät tatsächlich geöffnet ist (oder die Verbindung fehlgeschlagen ist).

Weitere Details finden Sie unter „ connectToServer()“.

qint64 QLocalSocket::readBufferSize() const

Gibt die Größe des internen Lesepuffers zurück. Diese begrenzt die Datenmenge, die der Client empfangen kann, bevor Sie die Funktionen „ read()“ oder „ readAll()“ aufrufen. Eine Lesepuffergröße von 0 (Standard) bedeutet, dass der Puffer keine Größenbeschränkung hat, wodurch sichergestellt wird, dass keine Daten verloren gehen.

Siehe auch ` setReadBufferSize()` und ` read()`.

[override virtual protected] qint64 QLocalSocket::readData(char *data, qint64 c)

Implementiert: ` QIODevice::readData` (char *data, qint64 maxSize).

[override virtual protected] qint64 QLocalSocket::readLineData(char *data, qint64 maxSize)

Implementiert: QIODevice::readLineData(char *data, qint64 maxSize).

QString QLocalSocket::serverName() const

Gibt den Namen des Peers zurück, wie er durch setServerName() angegeben wurde, oder ein leeres QString, falls setServerName() nicht aufgerufen wurde oder connectToServer() fehlgeschlagen ist.

Siehe auch setServerName(), connectToServer() und fullServerName().

void QLocalSocket::setReadBufferSize(qint64 size)

Legt die Größe des internen Lesepuffers von „ QLocalSocket “ auf „ size “ Bytes fest.

Wenn die Puffergröße auf einen bestimmten Wert begrenzt ist, puffert „ QLocalSocket “ nicht mehr Daten als diese Größe. Eine Puffergröße von 0 bedeutet jedoch, dass der Lesepuffer unbegrenzt ist und alle eingehenden Daten gepuffert werden. Dies ist die Standardeinstellung.

Diese Option ist nützlich, wenn Sie die Daten nur zu bestimmten Zeitpunkten lesen (z. B. in einer Echtzeit-Streaming-Anwendung) oder wenn Sie Ihren Socket davor schützen möchten, zu viele Daten zu empfangen, was letztendlich dazu führen könnte, dass Ihrer Anwendung der Speicher ausgeht.

Siehe auch readBufferSize() und read().

void QLocalSocket::setServerName(const QString &name)

Legen Sie den „ name “ des Peers fest, mit dem eine Verbindung hergestellt werden soll. Unter Windows ist „name“ der Name einer benannten Pipe; unter Unix ist „name“ der Name eines lokalen Domänen-Sockets.

Diese Funktion muss aufgerufen werden, wenn der Socket nicht verbunden ist.

Siehe auch serverName().

bool QLocalSocket::setSocketDescriptor(qintptr socketDescriptor, QLocalSocket::LocalSocketState socketState = ConnectedState, QIODeviceBase::OpenMode openMode = ReadWrite)

Initialisiert „ QLocalSocket “ mit dem nativen Socket-Deskriptor „ socketDescriptor “. Gibt „ true “ zurück, wenn „ socketDescriptor “ als gültiger Socket-Deskriptor akzeptiert wird; andernfalls wird „ false “ zurückgegeben. Der Socket wird in dem durch „ openMode “ angegebenen Modus geöffnet und wechselt in den durch „ socketState “ angegebenen Socket-Zustand.

Siehe auch socketDescriptor(), state() und openMode().

[override virtual protected] qint64 QLocalSocket::skipData(qint64 maxSize)

Implementiert: QIODevice::skipData(qint64 maxSize).

qintptr QLocalSocket::socketDescriptor() const

Gibt den nativen Socket-Deskriptor des Objekts „ QLocalSocket “ zurück, sofern dieser verfügbar ist; andernfalls wird -1 zurückgegeben.

Der Socket-Deskriptor ist nicht verfügbar, wenn sich „ QLocalSocket “ im Status „ UnconnectedState “ befindet. 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 „ QTcpSocket “-Socket-Deskriptor, und der Typ wird durch „ socketDescriptor “ definiert.
• Auf allen anderen UNIX-ähnlichen Betriebssystemen ist der Typ ein Dateideskriptor, der einen Socket darstellt.

Siehe auch setSocketDescriptor().

QLocalSocket::LocalSocketState QLocalSocket::state() const

Gibt den Status des Sockets zurück.

Siehe auch ` error()`.

[signal] void QLocalSocket::stateChanged(QLocalSocket::LocalSocketState socketState)

Dieses Signal wird immer dann ausgelöst, wenn sich der Zustand von „ QLocalSocket “ ändert. Der Parameter „ socketState “ gibt den neuen Zustand an.

Siehe auch state().

[override virtual] bool QLocalSocket::waitForBytesWritten(int msecs = 30000)

Implementiert: QIODevice::waitForBytesWritten(int msecs).

bool QLocalSocket::waitForConnected(int msecs = 30000)

Wartet, bis die Verbindung zum Socket hergestellt ist, maximal msecs Millisekunden. Wenn die Verbindung hergestellt wurde, gibt diese Funktion „ true “ zurück; andernfalls gibt sie „ false “ zurück. Falls „ false “ zurückgegeben wird, können Sie „ error()“ aufrufen, um die Ursache des Fehlers zu ermitteln.

Das folgende Beispiel wartet bis zu einer Sekunde, bis eine Verbindung hergestellt ist:

socket->connectToServer("market");
if (socket->waitForConnected(1000))
    qDebug("Connected!");

Wenn msecs den Wert -1 hat, läuft diese Funktion nicht in eine Zeitüberschreitung.

Siehe auch „ connectToServer()“ und „ connected()“.

bool QLocalSocket::waitForDisconnected(int msecs = 30000)

Wartet, bis die Verbindung zum Socket getrennt wurde, maximal msecs Millisekunden. Wenn die Verbindung erfolgreich getrennt wurde, gibt diese Funktion true zurück; andernfalls gibt sie false zurück (wenn das Zeitlimit abgelaufen ist, ein Fehler aufgetreten ist oder wenn dieses QLocalSocket bereits getrennt ist). Falls false zurückgegeben wird, können Sie error() aufrufen, um die Ursache des Fehlers zu ermitteln.

Das folgende Beispiel wartet bis zu einer Sekunde darauf, dass eine Verbindung geschlossen wird:

socket->disconnectFromServer();
if (socket->state()== QLocalSocket::UnconnectedState
    || socket->waitForDisconnected(1000)) {
    qDebug("Disconnected!");
}

Wenn msecs den Wert -1 hat, läuft diese Funktion nicht ab.

Siehe auch disconnectFromServer() und close().

[override virtual] bool QLocalSocket::waitForReadyRead(int msecs = 30000)

Umsetzung von: ` QIODevice::waitForReadyRead(int msecs)`.

Diese Funktion wartet, bis Daten zum Lesen verfügbar sind und das Signal „ readyRead()“ ausgelöst wurde. Die Funktion läuft nach msecs Millisekunden ab; die Standard-Timeout-Zeit beträgt 30000 Millisekunden.

Die Funktion gibt „ true “ zurück, wenn Daten zum Lesen verfügbar sind; andernfalls gibt sie „ false “ zurück (wenn ein Fehler aufgetreten ist oder die Operation abgelaufen ist).

Siehe auch ` waitForBytesWritten()`.

[override virtual protected] qint64 QLocalSocket::writeData(const char *data, qint64 c)

Implementiert: ` QIODevice::writeData` (const char *data, qint64 maxSize).