QLocalServer Class

Documentation des fonctions membres

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

Créer un nouveau serveur de sockets local avec l'parent fournie.

Voir également listen().

[virtual noexcept] QLocalServer::~QLocalServer()

Détruit l'objet ` QLocalServer `. Si le serveur est à l'écoute de connexions, celles-ci sont automatiquement fermées.

Tous les objets QLocalSockets clients encore connectés doivent soit se déconnecter, soit être rattachés à un autre parent 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 l'socket à la liste des connexions entrantes en attente.

Cette fonction a été introduite dans Qt 6.8.

Voir également ` incomingConnection()` et ` newConnection()`.

void QLocalServer::close()

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

Voir également isListening() et listen().

QString QLocalServer::errorString() const

Renvoie le message lisible par l'utilisateur 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 également serverError().

QString QLocalServer::fullServerName() const

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

Remarque : cette fonction est spécifique à la plate-forme

Voir également listen() et serverName().

[virtual] bool QLocalServer::hasPendingConnections() const

Renvoie « true » si le serveur a une connexion en attente ; sinon, renvoie « false ».

Voir également 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 de la connexion acceptée.

L'implémentation de base crée un ` QLocalSocket`, définit le descripteur de socket, puis stocke ` QLocalSocket ` dans une liste interne de connexions en attente. Enfin, ` newConnection()` est émis.

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

Voir également newConnection(), nextPendingConnection() et QLocalSocket::setSocketDescriptor().

bool QLocalServer::isListening() const

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

Voir également listen() et close().

bool QLocalServer::listen(const QString &name)

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

name Il peut s'agir d'un simple nom ; QLocalServer déterminera alors le chemin d'accès spécifique à la plate-forme. La fonction serverName() renverra le nom qui a été passé à listen().

En général, on se contente de passer un nom tel que « foo », mais sous Unix, il peut également s’agir d’un chemin d’accès tel que « /tmp/foo » et sous Windows, d’un chemin de canal tel que « \\.\pipe\foo ».

Voir également 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 actuellement à l’écoute. 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 spécifique à la plate-forme ne soit appelée. Le socket est configuré en mode non bloquant.

serverName(), fullServerName() peuvent renvoyer une chaîne de caractères contenant un nom si cette option est prise en charge par la plate-forme ; sinon, elles renvoient une chaîne vide QString. En particulier, les adresses des sockets dans l’espace de noms abstrait pris en charge par Linux ne donneront 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 en attente d'acceptation.

Cette fonction a été introduite dans Qt 6.3.

Voir également ` setListenBacklogSize()`.

int QLocalServer::maxPendingConnections() const

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

Voir également setMaxPendingConnections() et hasPendingConnections().

[signal] void QLocalServer::newConnection()

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

Voir également hasPendingConnections() et nextPendingConnection().

[virtual] QLocalSocket *QLocalServer::nextPendingConnection()

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

Le socket est créé en tant qu’enfant du serveur, ce qui signifie qu’il est automatiquement supprimé lorsque l’objet ` QLocalServer ` est détruit. Il est toutefois recommandé de supprimer explicitement l’objet lorsque vous n’en avez plus besoin, afin d’éviter tout gaspillage de mémoire.

nullptr est renvoyé si cette fonction est appelée alors qu’il n’y a aucune connexion en attente.

Voir également hasPendingConnections(), newConnection() et incomingConnection().

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

Supprime toute instance de serveur susceptible d'entraîner l'échec d'un appel à ` listen()` et renvoie ` true ` en cas de succès ; sinon, elle renvoie ` false`. Cette fonction est destinée à permettre la reprise après un plantage, 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 indiqué par name.

QAbstractSocket::SocketError QLocalServer::serverError() const

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

Voir également errorString().

QString QLocalServer::serverName() const

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

Voir également listen() et fullServerName().

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

Définit la taille de la file d'attente des connexions en attente d'acceptation pour 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 également ` listenBacklogSize()`.

void QLocalServer::setMaxPendingConnections(int numConnections)

Définit le nombre maximal de connexions acceptées en attente à numConnections. QLocalServer n'acceptera pas plus de numConnections connexions entrantes avant l'appel de nextPendingConnection().

Remarque : même si la fonction ` QLocalServer ` cesse d’accepter de nouvelles connexions une fois son nombre maximal de connexions en attente atteint, le système d’exploitation peut tout de même les conserver dans la file d’attente, ce qui entraînera l’affichage d’un message indiquant que le client est connecté.

Voir également maxPendingConnections() et hasPendingConnections().

qintptr QLocalServer::socketDescriptor() const

Renvoie le descripteur de socket natif utilisé par le serveur pour écouter les requêtes entrantes, ou -1 si le serveur n'est pas en mode d'écoute.

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

• Sous Windows, la valeur renvoyée est un descripteur de socket Winsock 2.
• Sous 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 un socket en écoute.

Voir également listen().

QLocalServer::SocketOptions QLocalServer::socketOptions() const

Renvoie les options définies pour 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 dépassé le délai d’attente et que timedOut n’est pas nullptr, *timedOut sera défini sur true.

Il s'agit d'un appel de fonction bloquant. Son utilisation est déconseillée dans une application GUI monothread, car l'application entière cessera de répondre jusqu'à ce que la fonction renvoie une valeur. waitForNewConnection() est surtout utile lorsqu'aucune boucle d'événements n'est disponible.

L’alternative non bloquante consiste à s’abonner au signal ` newConnection()`.

Si msec est égal à -1, cette fonction n'expirera pas.

Voir également hasPendingConnections() et nextPendingConnection().