QLocalServer Class

Documentation des fonctions membres

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

Crée un nouveau serveur de socket local avec l'adresse parent.

Voir aussi listen().

[virtual noexcept] QLocalServer::~QLocalServer()

Détruit l'objet QLocalServer. Si le serveur est à l'écoute de connexions, il est automatiquement fermé.

Toutes les QLocalSockets clientes encore connectées doivent se déconnecter ou être réparties avant que le serveur ne soit supprimé.

Voir aussi close().

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

Cette fonction est appelée par QLocalServer::incomingConnection() pour ajouter socket à la liste des connexions entrantes en attente.

Cette fonction a été introduite dans Qt 6.8.

Voir aussi incomingConnection() et newConnection().

void QLocalServer::close()

Arrêter d'écouter les connexions entrantes. Les connexions existantes ne sont pas affectées, mais toute nouvelle connexion sera refusée.

Voir aussi isListening() et listen().

QString QLocalServer::errorString() const

Renvoie le message lisible par l'homme correspondant à l'erreur actuelle signalée par serverError(). Si aucune chaîne appropriée n'est disponible, une chaîne vide est renvoyée.

Voir aussi serverError().

QString QLocalServer::fullServerName() const

Renvoie le chemin complet sur lequel le serveur est à l'écoute.

Note : Ceci est spécifique à la plate-forme

Voir aussi listen() et serverName().

[virtual] bool QLocalServer::hasPendingConnections() const

Renvoie true si le serveur a une connexion en cours, sinon renvoie false.

Voir aussi nextPendingConnection() et setMaxPendingConnections().

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

Cette fonction virtuelle est appelée par QLocalServer lorsqu'une nouvelle connexion est disponible. socketDescriptor est le descripteur de socket natif pour la connexion acceptée.

L'implémentation de base crée un QLocalSocket, définit le descripteur de socket et stocke ensuite le QLocalSocket dans une liste interne de connexions en attente. Enfin, la fonction newConnection() est émise.

Réimplémentez cette fonction pour modifier le comportement du serveur lorsqu'une connexion est disponible.

Voir aussi newConnection(), nextPendingConnection() et QLocalSocket::setSocketDescriptor().

bool QLocalServer::isListening() const

Renvoie true si le serveur est à l'écoute des connexions entrantes, false sinon.

Voir aussi listen() et close().

bool QLocalServer::listen(const QString &name)

Indique au serveur d'écouter les connexions entrantes sur name. Si le serveur écoute déjà, listen() échouera. Retourne true en cas de succès, false dans le cas contraire.

name peut être un nom unique et QLocalServer déterminera le chemin d'accès correct spécifique à la plate-forme. serverName() renvoie le nom passé dans listen().

En général, on passe un nom comme "foo", mais sous Unix, il peut s'agir d'un chemin comme "/tmp/foo" et sous Windows, il peut s'agir d'un chemin de type pipe comme "\\.\pipe\foo "

Voir aussi serverName(), isListening() et close().

bool QLocalServer::listen(qintptr socketDescriptor)

Indique au serveur d'écouter les connexions entrantes sur socketDescriptor. La propriété renvoie false si le serveur est en train d'écouter. Elle renvoie true en cas de succès, sinon elle renvoie false. Le socket doit être prêt à accepter de nouvelles connexions sans qu'aucune fonction supplémentaire spécifique à la plate-forme ne soit appelée. La socket est mise en mode non bloquant.

serverName(), fullServerName() peuvent renvoyer une chaîne de caractères avec un nom si cette option est prise en charge par la plate-forme ; sinon, elles renvoient une adresse vide QString. En particulier, les adresses des sockets dans l'espace de noms abstrait pris en charge par Linux ne produiront pas de noms utiles si elles contiennent des caractères non imprimables.

Voir également isListening() et close().

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

Renvoie la taille de la file d'attente des connexions à accepter.

Cette fonction a été introduite dans Qt 6.3.

Voir aussi setListenBacklogSize().

int QLocalServer::maxPendingConnections() const

Renvoie le nombre maximum de connexions acceptées en attente. La valeur par défaut est 30.

Voir aussi setMaxPendingConnections() et hasPendingConnections().

[signal] void QLocalServer::newConnection()

Ce signal est émis chaque fois qu'une nouvelle connexion est disponible.

Voir aussi hasPendingConnections() et nextPendingConnection().

[virtual] QLocalSocket *QLocalServer::nextPendingConnection()

Renvoie la prochaine connexion en attente sous la forme d'un objet QLocalSocket connecté.

La socket est créée en tant qu'enfant du serveur, ce qui signifie qu'elle est automatiquement supprimée lorsque l'objet QLocalServer est détruit. Il est toutefois conseillé de supprimer l'objet explicitement lorsque vous n'en avez plus besoin, afin d'éviter de gaspiller de la mémoire.

nullptr est renvoyé si cette fonction est appelée alors qu'il n'y a pas de connexions en cours.

Voir aussi hasPendingConnections(), newConnection(), et incomingConnection().

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

Supprime toute instance de serveur qui pourrait faire échouer un appel à listen() et renvoie true en cas de succès ; sinon, renvoie false. Cette fonction est destinée à récupérer après un crash, lorsque l'instance de serveur précédente n'a pas été nettoyée.

Sous Windows, cette fonction ne fait rien ; sous Unix, elle supprime le fichier de socket donné par name.

QAbstractSocket::SocketError QLocalServer::serverError() const

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

Voir aussi errorString().

QString QLocalServer::serverName() const

Renvoie le nom du serveur si le serveur est à l'écoute des connexions ; sinon, renvoie QString().

Voir aussi listen() et fullServerName().

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

Définit la taille de la file d'attente des connexions à accepter à size. Le système d'exploitation peut réduire ou ignorer cette valeur. Par défaut, la taille de la file d'attente est de 50.

Cette fonction a été introduite dans Qt 6.3.

Voir aussi listenBacklogSize().

void QLocalServer::setMaxPendingConnections(int numConnections)

Fixe le nombre maximal de connexions acceptées en attente à numConnections. QLocalServer n'acceptera pas plus de numConnections connexions entrantes avant que nextPendingConnection() ne soit appelé.

Remarque : même si QLocalServer cesse d'accepter de nouvelles connexions après avoir atteint son nombre maximal de connexions en attente, le système d'exploitation peut encore les garder en file d'attente, ce qui permet aux clients de signaler qu'ils sont connectés.

Voir aussi maxPendingConnections() et hasPendingConnections().

qintptr QLocalServer::socketDescriptor() const

Renvoie le descripteur de socket natif que le serveur utilise pour écouter les instructions entrantes, ou -1 si le serveur n'écoute pas.

Le type de descripteur dépend de la plate-forme :

• Sous Windows, la valeur renvoyée est un Winsock 2 Socket Handle.
• Sur INTEGRITY, la valeur renvoyée est le descripteur de socket QTcpServer et le type est défini par socketDescriptor.
• Sur tous les autres systèmes d'exploitation de type UNIX, le type est un descripteur de fichier représentant une socket à l'écoute.

Voir aussi listen().

QLocalServer::SocketOptions QLocalServer::socketOptions() const

Renvoie les options de socket définies sur le socket.

Voir aussi setSocketOptions().

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

Attend au maximum msec millisecondes ou jusqu'à ce qu'une connexion entrante soit disponible. Renvoie true si une connexion est disponible ; sinon, renvoie false. Si l'opération a été interrompue et que timedOut n'est pas nullptr, *timedOut sera défini comme vrai.

Il s'agit d'un appel de fonction bloquant. Son utilisation est déconseillée dans une application GUI monotâche, car l'ensemble de l'application cessera de répondre jusqu'au retour de la fonction. waitForNewConnection() est surtout utile lorsqu'il n'y a pas de boucle d'événements disponible.

L'alternative non bloquante consiste à se connecter au signal newConnection().

Si msec vaut -1, cette fonction n'est pas interrompue.

Voir aussi hasPendingConnections() et nextPendingConnection().