QAbstractSocket Class

Documentation des fonctions membres

QAbstractSocket::QAbstractSocket(QAbstractSocket::SocketType socketType, QObject *parent)

Crée une nouvelle socket abstraite de type socketType. L'argument parent est transmis au constructeur de QObject.

Voir aussi socketType(), QTcpSocket, et QUdpSocket.

[virtual noexcept] QAbstractSocket::~QAbstractSocket()

Détruit la prise.

void QAbstractSocket::abort()

Abandonne la connexion en cours et réinitialise le socket. Contrairement à disconnectFromHost(), cette fonction ferme immédiatement la socket, en rejetant toutes les données en attente dans le tampon d'écriture.

Voir également disconnectFromHost() et close().

[virtual] bool QAbstractSocket::bind(const QHostAddress &address, quint16 port = 0, QAbstractSocket::BindMode mode = DefaultForPlatform)

Se lie à address sur le port port, en utilisant le serveur BindMode mode .

Pour les sockets UDP, après la liaison, le signal QUdpSocket::readyRead() est émis chaque fois qu'un datagramme UDP arrive sur l'adresse et le port spécifiés. Cette fonction est donc utile pour écrire des serveurs UDP.

Pour les sockets TCP, cette fonction peut être utilisée pour spécifier l'interface à utiliser pour une connexion sortante, ce qui est utile en cas d'interfaces réseau multiples.

Par défaut, la socket est liée à l'aide de DefaultForPlatform BindMode . Si aucun port n'est spécifié, un port aléatoire est choisi.

En cas de succès, la fonction renvoie true et la socket entre dans BoundState; sinon, elle renvoie false.

bool QAbstractSocket::bind(quint16 port = 0, QAbstractSocket::BindMode mode = DefaultForPlatform)

Se lie à QHostAddress:Any sur le port port, en utilisant BindMode mode .

Par défaut, la socket est liée à DefaultForPlatform BindMode . Si aucun port n'est spécifié, un port aléatoire est choisi.

[since 6.2] bool QAbstractSocket::bind(QHostAddress::SpecialAddress addr, quint16 port = 0, QAbstractSocket::BindMode mode = DefaultForPlatform)

Se lie à l'adresse spéciale addr sur le port port, en utilisant l'adresse BindMode mode .

Par défaut, la socket est liée à l'adresse DefaultForPlatform BindMode . Si aucun port n'est spécifié, un port aléatoire est choisi.

Cette fonction a été introduite dans Qt 6.2.

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

Réimplémente : QIODevice::bytesAvailable() const.

Renvoie le nombre d'octets entrants en attente de lecture.

Voir aussi bytesToWrite() et read().

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

Réimplémente : QIODevice::bytesToWrite() const.

Renvoie le nombre d'octets en attente d'écriture. Les octets sont écrits lorsque le contrôle revient à la boucle d'événements ou lorsque flush() est appelé.

Voir aussi bytesAvailable() et flush().

[override virtual] void QAbstractSocket::close()

Réimplémente : QIODevice::close().

Ferme le périphérique d'E/S pour la socket et appelle disconnectFromHost() pour fermer la connexion de la socket.

Voir QIODevice::close() pour une description des actions qui se produisent lorsqu'un périphérique d'E/S est fermé.

Voir aussi abort().

[virtual] void QAbstractSocket::connectToHost(const QString &hostName, quint16 port, QIODeviceBase::OpenMode openMode = ReadWrite, QAbstractSocket::NetworkLayerProtocol protocol = AnyIPProtocol)

Tente d'établir une connexion avec hostName sur le site port. Le paramètre protocol peut être utilisé pour spécifier le protocole réseau à utiliser (par exemple, IPv4 ou IPv6).

La socket est ouverte dans l'adresse openMode et entre d'abord dans HostLookupState, puis effectue une recherche de nom d'hôte dans hostName. Si la recherche aboutit, hostFound() est émis et QAbstractSocket entre dans ConnectingState. Il tente ensuite de se connecter à l'adresse ou aux adresses renvoyées par la recherche. Enfin, si une connexion est établie, QAbstractSocket entre dans ConnectedState et émet connected().

À tout moment, la socket peut émettre errorOccurred() pour signaler qu'une erreur s'est produite.

hostName peut être une adresse IP sous forme de chaîne (par exemple, "43.195.83.32") ou un nom d'hôte (par exemple, "example.com"). QAbstractSocket n'effectuera une recherche que si cela est nécessaire. port est dans l'ordre natif des octets.

Voir aussi state(), peerName(), peerAddress(), peerPort() et waitForConnected().

void QAbstractSocket::connectToHost(const QHostAddress &address, quint16 port, QIODeviceBase::OpenMode openMode = ReadWrite)

Tente d'établir une connexion avec address sur le port port.

[signal] void QAbstractSocket::connected()

Ce signal est émis après que connectToHost() a été appelé et qu'une connexion a été établie avec succès.

Voir également connectToHost() et disconnected().

[virtual] void QAbstractSocket::disconnectFromHost()

Tente de fermer la socket. S'il y a des données en attente d'écriture, QAbstractSocket entrera dans ClosingState et attendra jusqu'à ce que toutes les données aient été écrites. Finalement, il entrera dans UnconnectedState et émettra le signal disconnected().

Voir aussi connectToHost().

[signal] void QAbstractSocket::disconnected()

Ce signal est émis lorsque la prise a été déconnectée.

Voir aussi connectToHost(), disconnectFromHost(), et abort().

QAbstractSocket::SocketError QAbstractSocket::error() const

Renvoie le type d'erreur qui s'est produite en dernier.

Voir aussi state() et errorString().

[signal] void QAbstractSocket::errorOccurred(QAbstractSocket::SocketError socketError)

Ce signal est émis lorsqu'une erreur s'est produite. Le paramètre socketError décrit le type d'erreur qui s'est produite.

Lorsque ce signal est émis, il se peut que la socket ne soit pas prête pour une tentative de reconnexion. Dans ce cas, les tentatives de reconnexion doivent être effectuées à partir de la boucle d'événements. Par exemple, utilisez QChronoTimer::singleShot() avec 0ns comme timeout.

QAbstractSocket::SocketError n'est pas un métatype enregistré, donc pour les connexions en file d'attente, vous devrez l'enregistrer avec Q_DECLARE_METATYPE() et qRegisterMetaType().

Voir aussi error(), errorString(), et Créer des types Qt personnalisés.

bool QAbstractSocket::flush()

Cette fonction écrit autant de données que possible depuis le tampon d'écriture interne vers le socket réseau sous-jacent, sans bloquer. Si des données ont été écrites, cette fonction renvoie true; sinon, elle renvoie false.

Appelez cette fonction si vous avez besoin que QAbstractSocket commence à envoyer des données tamponnées immédiatement. Le nombre d'octets écrits avec succès dépend du système d'exploitation. Dans la plupart des cas, il n'est pas nécessaire d'appeler cette fonction, car QAbstractSocket commencera à envoyer des données automatiquement dès que le contrôle reviendra à la boucle d'événements. En l'absence de boucle d'événements, appelez plutôt waitForBytesWritten().

Voir également write() et waitForBytesWritten().

[signal] void QAbstractSocket::hostFound()

Ce signal est émis après que connectToHost() a été appelé et que la recherche d'hôte a réussi.

Voir aussi connected().

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

Réimplémente : QIODevice::isSequential() const.

bool QAbstractSocket::isValid() const

Renvoie true si la socket est valide et prête à être utilisée, sinon renvoie false.

Voir aussi state().

QHostAddress QAbstractSocket::localAddress() const

Renvoie l'adresse de l'hôte de la socket locale si elle est disponible ; sinon, elle renvoie QHostAddress::Null.

Il s'agit normalement de l'adresse IP principale de l'hôte, mais elle peut être QHostAddress::LocalHost (127.0.0.1) pour les connexions à l'hôte local.

Voir aussi localPort(), peerAddress(), et setLocalAddress().

quint16 QAbstractSocket::localPort() const

Renvoie le numéro de port de l'hôte (dans l'ordre des octets natifs) de la socket locale s'il est disponible ; sinon, renvoie 0.

Voir aussi localAddress(), peerPort(), et setLocalPort().

QAbstractSocket::PauseModes QAbstractSocket::pauseMode() const

Renvoie le mode de pause de cette socket.

Voir aussi setPauseMode() et resume().

QHostAddress QAbstractSocket::peerAddress() const

Renvoie l'adresse de l'homologue connecté si la socket est dans ConnectedState; sinon, renvoie QHostAddress::Null.

Voir aussi peerName(), peerPort(), localAddress(), et setPeerAddress().

QString QAbstractSocket::peerName() const

Renvoie le nom de l'homologue tel que spécifié par connectToHost(), ou un QString vide si connectToHost() n'a pas été appelé.

Voir aussi peerAddress(), peerPort(), et setPeerName().

quint16 QAbstractSocket::peerPort() const

Renvoie le port de l'homologue connecté si la socket est dans ConnectedState; sinon renvoie 0.

Voir aussi peerAddress(), localPort(), et setPeerPort().

QString QAbstractSocket::protocolTag() const

Renvoie la balise de protocole pour cette socket. Si la balise de protocole est définie, elle est transmise à QNetworkProxyQuery lors de sa création interne pour indiquer la balise de protocole à utiliser.

Voir aussi setProtocolTag() et QNetworkProxyQuery.

QNetworkProxy QAbstractSocket::proxy() const

Renvoie le proxy réseau pour cette socket. Par défaut, QNetworkProxy::DefaultProxy est utilisé, ce qui signifie que cette socket interrogera les paramètres de proxy par défaut de l'application.

Voir aussi setProxy(), QNetworkProxy, et QNetworkProxyFactory.

[signal] void QAbstractSocket::proxyAuthenticationRequired(const QNetworkProxy &proxy, QAuthenticator *authenticator)

Ce signal peut être émis lors de l'utilisation d'un site proxy nécessitant une authentification. L'objet authenticator peut alors être rempli avec les détails requis pour permettre l'authentification et poursuivre la connexion.

Voir également QAuthenticator et QNetworkProxy.

qint64 QAbstractSocket::readBufferSize() const

Renvoie la taille du tampon de lecture interne. Cela limite la quantité de données que le client peut recevoir avant que vous n'appeliez read() ou readAll().

Une taille de tampon de lecture de 0 (par défaut) signifie que le tampon n'a pas de limite de taille, ce qui garantit qu'aucune donnée n'est perdue.

Voir également setReadBufferSize() et read().

[override virtual protected] qint64 QAbstractSocket::readData(char *data, qint64 maxSize)

Réimplémente : QIODevice::readData(char *data, qint64 maxSize).

[override virtual protected] qint64 QAbstractSocket::readLineData(char *data, qint64 maxlen)

Réimplémente : QIODevice::readLineData(char *data, qint64 maxSize).

[virtual] void QAbstractSocket::resume()

Poursuit le transfert de données sur la socket. Cette méthode ne doit être utilisée qu'après que la socket a été configurée pour faire une pause en cas de notification et qu'une notification a été reçue. La seule notification actuellement supportée est QSslSocket::sslErrors(). L'appel de cette méthode si la socket n'est pas en pause entraîne un comportement indéfini.

Voir aussi pauseMode() et setPauseMode().

[protected] void QAbstractSocket::setLocalAddress(const QHostAddress &address)

Définit l'adresse du côté local d'une connexion à address.

Vous pouvez appeler cette fonction dans une sous-classe de QAbstractSocket pour modifier la valeur de retour de la fonction localAddress() après l'établissement d'une connexion. Cette fonction est couramment utilisée par les connexions proxy pour les paramètres de connexion virtuelle.

Notez que cette fonction ne lie pas l'adresse locale de la socket avant une connexion (par exemple, QAbstractSocket::bind()).

Voir également localAddress(), setLocalPort() et setPeerAddress().

[protected] void QAbstractSocket::setLocalPort(quint16 port)

Définit le port du côté local d'une connexion à port.

Vous pouvez appeler cette fonction dans une sous-classe de QAbstractSocket pour modifier la valeur de retour de la fonction localPort() après l'établissement d'une connexion. Cette fonction est couramment utilisée par les connexions proxy pour les paramètres de connexion virtuelle.

Notez que cette fonction ne lie pas le port local de la socket avant une connexion (par exemple, QAbstractSocket::bind()).

Voir aussi localPort(), localAddress(), setLocalAddress() et setPeerPort().

void QAbstractSocket::setPauseMode(QAbstractSocket::PauseModes pauseMode)

Détermine s'il convient de faire une pause lors de la réception d'une notification. Le paramètre pauseMode spécifie les conditions dans lesquelles la socket doit être mise en pause. La seule notification actuellement supportée est QSslSocket::sslErrors(). Si cette option vaut PauseOnSslErrors, le transfert de données sur la socket sera interrompu et devra être réactivé explicitement en appelant resume(). Par défaut, cette option est définie sur PauseNever. Cette option doit être appelée avant la connexion au serveur, sinon elle entraînera un comportement indéfini.

Voir également pauseMode() et resume().

[protected] void QAbstractSocket::setPeerAddress(const QHostAddress &address)

Définit l'adresse du côté distant de la connexion à address.

Vous pouvez appeler cette fonction dans une sous-classe de QAbstractSocket pour modifier la valeur de retour de la fonction peerAddress() après l'établissement d'une connexion. Cette fonction est couramment utilisée par les connexions proxy pour les paramètres de connexion virtuelle.

Voir également peerAddress(), setPeerPort() et setLocalAddress().

[protected] void QAbstractSocket::setPeerName(const QString &name)

Définit le nom d'hôte de l'homologue distant à name.

Vous pouvez appeler cette fonction dans une sous-classe de QAbstractSocket pour modifier la valeur de retour de la fonction peerName() après l'établissement d'une connexion. Cette fonction est couramment utilisée par les connexions proxy pour les paramètres de connexion virtuelle.

Voir aussi peerName().

[protected] void QAbstractSocket::setPeerPort(quint16 port)

Définit le port du côté distant de la connexion à port.

Vous pouvez appeler cette fonction dans une sous-classe de QAbstractSocket pour modifier la valeur de retour de la fonction peerPort() après l'établissement d'une connexion. Cette fonction est couramment utilisée par les connexions proxy pour les paramètres de connexion virtuelle.

Voir également peerPort(), setPeerAddress() et setLocalPort().

void QAbstractSocket::setProtocolTag(const QString &tag)

Définit la balise de protocole pour cette socket à tag.

Voir aussi protocolTag().

void QAbstractSocket::setProxy(const QNetworkProxy &networkProxy)

Définit le proxy réseau explicite pour cette socket à networkProxy.

Pour désactiver l'utilisation d'un proxy pour cette socket, utilisez le type de proxy QNetworkProxy::NoProxy:

socket->setProxy(QNetworkProxy::NoProxy);

La valeur par défaut du proxy est QNetworkProxy::DefaultProxy, ce qui signifie que la socket utilisera les paramètres de l'application : si un proxy est défini avec QNetworkProxy::setApplicationProxy, elle l'utilisera ; sinon, si une usine est définie avec QNetworkProxyFactory::setApplicationProxyFactory, elle interrogera cette usine avec le type QNetworkProxyQuery::TcpSocket.

Voir aussi proxy(), QNetworkProxy, et QNetworkProxyFactory::queryProxy().

[virtual] void QAbstractSocket::setReadBufferSize(qint64 size)

Fixe la taille du tampon de lecture interne de QAbstractSocket à size octets.

Si la taille du tampon est limitée à une certaine taille, QAbstractSocket ne mettra pas en mémoire tampon plus que cette taille de données. Exceptionnellement, une taille de tampon de 0 signifie que le tampon de lecture est illimité et que toutes les données entrantes sont mises en mémoire tampon. Il s'agit de la valeur par défaut.

Cette option est utile si vous ne lisez les données qu'à certains moments (par exemple, dans une application de streaming en temps réel) ou si vous voulez protéger votre socket contre la réception d'une trop grande quantité de données, ce qui pourrait éventuellement entraîner une saturation de la mémoire de votre application.

Seul QTcpSocket utilise la mémoire tampon interne de QAbstractSocket; QUdpSocket n'utilise aucune mémoire tampon, mais s'appuie plutôt sur la mémoire tampon implicite fournie par le système d'exploitation. Pour cette raison, appeler cette fonction sur QUdpSocket n'a aucun effet.

Voir aussi readBufferSize() et read().

[virtual] bool QAbstractSocket::setSocketDescriptor(qintptr socketDescriptor, QAbstractSocket::SocketState socketState = ConnectedState, QIODeviceBase::OpenMode openMode = ReadWrite)

Initialise QAbstractSocket avec le descripteur de socket natif socketDescriptor. Renvoie true si socketDescriptor est accepté comme descripteur de socket valide ; sinon, renvoie false. La socket est ouverte dans le mode spécifié par openMode, et entre dans l'état de la socket spécifié par socketState. Les tampons de lecture et d'écriture sont vidés et les données en attente sont rejetées.

Note : Il n'est pas possible d'initialiser deux sockets abstraites avec le même descripteur de socket natif.

Voir aussi socketDescriptor().

[protected] void QAbstractSocket::setSocketError(QAbstractSocket::SocketError socketError)

Définit le type d'erreur qui s'est produit en dernier à socketError.

Voir aussi setSocketState() et setErrorString().

[virtual] void QAbstractSocket::setSocketOption(QAbstractSocket::SocketOption option, const QVariant &value)

Fixe la valeur donnée par option à la valeur décrite par value.

Voir aussi socketOption().

[protected] void QAbstractSocket::setSocketState(QAbstractSocket::SocketState state)

Définit l'état de la socket à state.

Voir aussi state().

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

Réimplémente : QIODevice::skipData(qint64 maxSize).

[virtual] qintptr QAbstractSocket::socketDescriptor() const

Renvoie le descripteur de socket natif de l'objet QAbstractSocket s'il est disponible, sinon renvoie -1.

Si la socket utilise QNetworkProxy, le descripteur retourné peut ne pas être utilisable avec les fonctions natives de la socket.

Le descripteur de socket n'est pas disponible lorsque QAbstractSocket est dans UnconnectedState.

Voir aussi setSocketDescriptor().

[virtual] QVariant QAbstractSocket::socketOption(QAbstractSocket::SocketOption option)

Renvoie la valeur de l'option option.

Voir aussi setSocketOption().

QAbstractSocket::SocketType QAbstractSocket::socketType() const

Renvoie le type de socket (TCP, UDP ou autre).

Voir aussi QTcpSocket et QUdpSocket.

QAbstractSocket::SocketState QAbstractSocket::state() const

Renvoie l'état de la socket.

Voir aussi error().

[signal] void QAbstractSocket::stateChanged(QAbstractSocket::SocketState socketState)

Ce signal est émis lorsque l'état de QAbstractSocket change. Le paramètre socketState est le nouvel état.

QAbstractSocket::SocketState n'est pas un métatype enregistré, donc pour les connexions en file d'attente, vous devrez l'enregistrer avec Q_DECLARE_METATYPE() et qRegisterMetaType().

Voir aussi state() et Créer des types Qt personnalisés.

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

Réimplémente : QIODevice::waitForBytesWritten(int msecs).

Cette fonction se bloque jusqu'à ce qu'au moins un octet ait été écrit sur la socket et que le signal bytesWritten() ait été émis. La fonction s'arrête après msecs millisecondes ; le délai par défaut est de 30000 millisecondes.

La fonction renvoie true si le signal bytesWritten() est émis ; sinon, elle renvoie false (si une erreur s'est produite ou si l'opération a expiré).

Voir également waitForReadyRead().

[virtual] bool QAbstractSocket::waitForConnected(int msecs = 30000)

Attend que le socket soit connecté, jusqu'à msecs millisecondes. Si la connexion a été établie, cette fonction renvoie true; sinon, elle renvoie false. Dans le cas où elle renvoie false, vous pouvez appeler error() pour déterminer la cause de l'erreur.

L'exemple suivant attend jusqu'à une seconde l'établissement d'une connexion :

socket->connectToHost("imap", 143) ;if (socket->waitForConnected(1000))    qDebug("Connected!");

Si msecs est égal à -1, cette fonction n'est pas interrompue.

Voir également connectToHost() et connected().

[virtual] bool QAbstractSocket::waitForDisconnected(int msecs = 30000)

Attend que la socket soit déconnectée, jusqu'à msecs millisecondes. Si la connexion a été déconnectée avec succès, cette fonction renvoie true; sinon, elle renvoie false (si l'opération a pris du retard, si une erreur s'est produite ou si cette QAbstractSocket est déjà déconnectée). Dans le cas où elle renvoie false, vous pouvez appeler error() pour déterminer la cause de l'erreur.

L'exemple suivant attend jusqu'à une seconde la fermeture d'une connexion :

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

Si msecs est égal à -1, cette fonction n'est pas interrompue.

Voir également disconnectFromHost() et close().

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

Réimplémente : QIODevice::waitForReadyRead(int msecs).

Cette fonction se bloque jusqu'à ce que de nouvelles données soient disponibles pour la lecture et que le signal readyRead() ait été émis. La fonction s'arrête au bout de msecs millisecondes ; le délai par défaut est de 30000 millisecondes.

La fonction renvoie true si le signal readyRead() a été émis et que de nouvelles données sont disponibles pour la lecture ; sinon, elle renvoie false (si une erreur s'est produite ou si l'opération a été interrompue).

Voir aussi waitForBytesWritten().

[override virtual protected] qint64 QAbstractSocket::writeData(const char *data, qint64 size)

Réimplémente : QIODevice::writeData(const char *data, qint64 maxSize).