QLocalSocket Class

Dokumentation der Mitgliedsfunktionen

QLocalSocket::QLocalSocket(QObject *parent = nullptr)

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

[virtual noexcept] QLocalSocket::~QLocalSocket()

Zerstört den Socket und schließt die Verbindung, falls erforderlich.

void QLocalSocket::abort()

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

Siehe auch disconnectFromServer() und close().

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

Reimplements: QIODevice::bytesAvailable() const.

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

Reimplements: QIODevice::bytesToWrite() const.

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

Reimplements: QIODevice::canReadLine() const.

[override virtual] void QLocalSocket::close()

Reimplements: 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.

Siehe QIODevice::close() für eine Beschreibung der Aktionen, die auftreten, wenn ein E/A-Gerät geschlossen wird.

Siehe auch abort().

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

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

Der Socket wird im angegebenen openMode geöffnet und betritt zunächst ConnectingState. Wenn eine Verbindung hergestellt wird, geht QLocalSocket in ConnectedState ein und sendet connected().

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

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

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

Dies ist eine überladene Funktion.

Setzt den Server name und versucht, eine Verbindung zu ihm herzustellen.

Der Socket wird im angegebenen openMode geöffnet und geht zunächst in ConnectingState ein. Wenn eine Verbindung zustande kommt, geht QLocalSocket in ConnectedState und sendet connected().

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 ausgegeben, nachdem connectToServer() aufgerufen wurde und eine Verbindung erfolgreich aufgebaut wurde.

Siehe auch connectToServer() und disconnected().

void QLocalSocket::disconnectFromServer()

Versucht, den Socket zu schließen. Wenn noch Daten darauf warten, geschrieben zu werden, wechselt QLocalSocket zu ClosingState und wartet, bis alle Daten geschrieben worden sind. Schließlich geht es in UnconnectedState über und gibt das Signal disconnected() aus.

Siehe auch connectToServer().

[signal] void QLocalSocket::disconnected()

Dieses Signal wird ausgegeben, wenn die Verbindung zum Socket unterbrochen 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, wenn ein Fehler aufgetreten ist. Der Parameter socketError beschreibt den Typ des aufgetretenen Fehlers.

QLocalSocket::LocalSocketError ist kein registrierter Metatyp, daher müssen Sie ihn für Warteschlangenverbindungen mit Q_DECLARE_METATYPE() und qRegisterMetaType() registrieren.

Siehe auch error(), errorString(), und Erstellen von benutzerdefinierten Qt-Typen.

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 von 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 an die Ereignisschleife zurückgeht. 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

Reimplements: 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)

Reimplements: QIODevice::open(QIODeviceBase::OpenMode-Modus).

Äquivalent zu connectToServer(OpenMode-Modus). Der Socket wird im angegebenen openMode für den durch setServerName() definierten Server geöffnet.

Beachten Sie, dass open() im Gegensatz zu den meisten anderen QIODevice Unterklassen das Gerät nicht direkt öffnen darf. Die Funktion gibt false zurück, wenn der Socket bereits verbunden war oder wenn der zu verbindende Server nicht definiert wurde, und true in allen anderen Fällen. Die Signale connected() oder errorOccurred() werden ausgegeben, sobald das Gerät tatsächlich geöffnet ist (oder die Verbindung fehlgeschlagen ist).

Siehe connectToServer() für weitere Details.

qint64 QLocalSocket::readBufferSize() const

Gibt die Größe des internen Lesepuffers zurück. Damit wird die Datenmenge begrenzt, die der Client empfangen kann, bevor Sie read() oder readAll() aufrufen. Eine Lesepuffergröße von 0 (die Voreinstellung) bedeutet, dass der Puffer keine Größenbegrenzung hat, wodurch sichergestellt wird, dass keine Daten verloren gehen.

Siehe auch setReadBufferSize() und read().

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

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

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

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

QString QLocalSocket::serverName() const

Gibt den Namen der Gegenstelle zurück, wie in setServerName() angegeben, oder ein leeres QString, wenn setServerName() nicht aufgerufen wurde oder connectToServer() fehlgeschlagen ist.

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

void QLocalSocket::setReadBufferSize(qint64 size)

Setzt die Größe des internen Lesepuffers von QLocalSocket auf size Bytes.

Wenn die Puffergröße auf eine bestimmte Größe begrenzt ist, wird QLocalSocket nicht mehr als diese Datenmenge puffern. Ausnahmsweise bedeutet eine Puffergröße von 0, 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 Ihr Socket davor schützen wollen, zu viele Daten zu empfangen, was dazu führen könnte, dass Ihrer Anwendung der Speicher ausgeht.

Siehe auch readBufferSize() und read().

void QLocalSocket::setServerName(const QString &name)

Legen Sie die name der Gegenstelle fest, zu der eine Verbindung hergestellt werden soll. Unter Windows ist name der Name einer benannten Pipe; unter Unix ist name der Name eines lokalen Domain-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 geht in den durch socketState angegebenen Socket-Status über.

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

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

Reimplements: QIODevice::skipData(qint64 maxSize).

qintptr QLocalSocket::socketDescriptor() const

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

Der Socket-Deskriptor ist nicht verfügbar, wenn QLocalSocket in UnconnectedState ist. Der Typ des Deskriptors hängt von der Plattform ab:

• Unter Windows ist der zurückgegebene Wert ein Winsock 2 Socket Handle.
• Auf INTEGRITY ist der zurückgegebene Wert 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 Zustand des Sockets zurück.

Siehe auch error().

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

Dieses Signal wird ausgesendet, wenn sich der Zustand von QLocalSocket ändert. Der Parameter socketState ist der neue Zustand.

QLocalSocket::SocketState ist kein registrierter Metatyp, daher müssen Sie ihn für Warteschlangenverbindungen mit Q_DECLARE_METATYPE() und qRegisterMetaType() registrieren.

Siehe auch state() und Benutzerdefinierte Qt-Typen erstellen.

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

Reimplements: QIODevice::waitForBytesWritten(int msecs).

bool QLocalSocket::waitForConnected(int msecs = 30000)

Wartet, bis der Socket verbunden ist, bis zu msecs Millisekunden. Wenn die Verbindung hergestellt wurde, gibt diese Funktion true zurück, andernfalls false. 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 aufgebaut ist:

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

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

Siehe auch connectToServer() und connected().

bool QLocalSocket::waitForDisconnected(int msecs = 30000)

Wartet, bis der Socket die Verbindung getrennt hat, bis zu msecs Millisekunden. Wenn die Verbindung erfolgreich getrennt wurde, gibt diese Funktion true zurück, andernfalls false (wenn der Vorgang eine Zeitüberschreitung hatte, ein Fehler auftrat oder die QLocalSocket bereits getrennt wurde). Wenn false zurückgegeben wird, können Sie error() aufrufen, um die Ursache des Fehlers zu ermitteln.

Im folgenden Beispiel wird bis zu einer Sekunde gewartet, bis eine Verbindung geschlossen wird:

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

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

Siehe auch disconnectFromServer() und close().

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

Reimplements: QIODevice::waitForReadyRead(int msecs).

Diese Funktion blockiert, bis Daten zum Lesen verfügbar sind und das Signal readyRead() ausgegeben wurde. Die Funktion führt nach msecs Millisekunden eine Zeitüberschreitung durch; die Standardzeitüberschreitung 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 der Vorgang eine Zeitüberschreitung hatte).

Siehe auch waitForBytesWritten().

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

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