QGrpcChannelOptions Class

Documentation des fonctions membres

QGrpcChannelOptions::QGrpcChannelOptions()

Construit par défaut un objet `QGrpcChannelOptions` vide.

QGrpcChannelOptions::QGrpcChannelOptions(const QGrpcChannelOptions &other)

Recrée un objet `QGrpcChannelOptions` à partir de ` other`.

[constexpr noexcept default] QGrpcChannelOptions::QGrpcChannelOptions(QGrpcChannelOptions &&other)

La fonction « move » construit un nouvel objet `QGrpcChannelOptions` à partir de ` other`.

[noexcept] QGrpcChannelOptions::~QGrpcChannelOptions()

Supprime l'QGrpcChannelOptions.

[since 6.12] QtGrpc::CompressionAlgorithms QGrpcChannelOptions::acceptedCompressionAlgorithms() const

Renvoie les algorithmes de compression que ce canal est prêt à accepter de la part du serveur. L'ensemble contient toujours « Identity », car la spécification « gRPC » impose l'acceptation des messages non compressés.

Cette valeur est utilisée pour construire l’en-tête de requête « grpc-accept-encoding ». Si le serveur répond avec un algorithme de compression qui ne figure pas dans cet ensemble, l’appel se termine par un code d’état « Unimplemented ».

Par défaut, il s'agit de ` supportedCompressionAlgorithms()` : tous les algorithmes que la version actuelle de Qt est capable de négocier sont proposés.

Cette fonction a été introduite dans Qt 6.12.

Voir également setAcceptedCompressionAlgorithms() et supportedCompressionAlgorithms().

[since 6.10] QGrpcChannelOptions &QGrpcChannelOptions::addMetadata(QByteArrayView key, QByteArrayView value)

Ajoute key et value au fichier metadata si cette paire exacte n'y figure pas déjà. Une même clé peut apparaître plusieurs fois avec des valeurs différentes.

Cette fonction a été introduite dans Qt 6.10.

Voir également metadata() et setMetadata().

[noexcept] std::optional<std::chrono::milliseconds> QGrpcChannelOptions::deadlineTimeout() const

Renvoie la durée du délai d'expiration utilisée pour calculer la date limite du canal.

Si ce champ n'est pas défini, renvoie un objet ` std::optional` vide.

Voir aussi setDeadlineTimeout().

[noexcept, since 6.11] std::optional<bool> QGrpcChannelOptions::filterServerMetadata() const

Renvoie « true » si les métadonnées du serveur liées au protocole sont exclues du résultat. Renvoie « false » pour inclure toutes les métadonnées reçues du serveur.

Si ce champ n’est pas défini, renvoie un ` std::optional` vide.

Cette fonction a été introduite dans Qt 6.11.

Voir également setFilterServerMetadata() et QGrpcCallOptions::filterServerMetadata().

[since 6.12] std::optional<quint64> QGrpcChannelOptions::maximumReceiveMessageSize() const

Renvoie la taille maximale autorisée, en octets, d'un message gRPC entrant. Cette limite s'applique à la charge utile de la trame gRPC décodée, après le déchiffrement au niveau du transport et toute décompression spécifique au message.

Si la valeur n'est pas spécifiée, renvoie un objet ` std::optional` vide.

Par défaut, la valeur n’est pas spécifiée.

Cette fonction a été introduite dans Qt 6.12.

Voir également setMaximumReceiveMessageSize() et QGrpcCallOptions::maximumReceiveMessageSize().

Cette fonction est prévue pour être obsolète dans la version 6.13.

Utilisez plutôt ` metadata` (QtGrpc::MultiValue).

Renvoie les métadonnées. Si ce champ n'est pas défini, renvoie des métadonnées vides.

Voir également metadata(QtGrpc::MultiValue_t) et setMetadata().

Renvoie les métadonnées. Si ce champ n'est pas défini, renvoie des métadonnées vides.

const auto &md = opts.metadata(QtGrpc::MultiValue);

Ces fonctions ont été introduites dans Qt 6.10.

Voir également setMetadata.

[since 6.12] std::optional<QtGrpc::CompressionAlgorithm> QGrpcChannelOptions::requestCompression() const

Renvoie l'algorithme de compression utilisé pour compresser les messages sortants sur ce canal ou cet appel.

Si ce champ n'est pas défini, renvoie un objet ` std::optional` vide.

Cette fonction a été introduite dans Qt 6.12.

Voir également ` setRequestCompression()` et ` QGrpcCallOptions::requestCompression()`.

[since 6.8] QGrpcSerializationFormat QGrpcChannelOptions::serializationFormat() const

Renvoie le format de sérialisation utilisé par le canal.

Si ce champ n'est pas défini, renvoie un format de sérialisation construit par l'Default.

Cette fonction a été introduite dans Qt 6.8.

Voir aussi ` setSerializationFormat()`.

[since 6.12] QGrpcChannelOptions &QGrpcChannelOptions::setAcceptedCompressionAlgorithms(QtGrpc::CompressionAlgorithms algorithms)

Définit l'algorithms de compression acceptée et renvoie une référence à l'objet mis à jour.

Identity est toujours ajouté implicitement, car la spécification gRPC exige que les clients acceptent les messages non compressés.

Si {QtGrpc::CompressionAlgorithm::Identity} est le seul algorithme accepté, les réponses compressées sont refusées. L’ajout d’indicateurs supplémentaires permet au serveur de répondre en utilisant ces algorithmes de compression.

Seuls les algorithmes pris en charge par cette version de Qt et inclus dans ` algorithms ` sont signalés au serveur comme méthodes de compression de réponse acceptées. Les indicateurs qui ne figurent pas dans ` supportedCompressionAlgorithms()` sont ignorés sans message d’erreur.

Cette fonction a été introduite dans Qt 6.12.

Voir également acceptedCompressionAlgorithms() et supportedCompressionAlgorithms().

QGrpcChannelOptions &QGrpcChannelOptions::setDeadlineTimeout(std::chrono::milliseconds timeout)

Définit l'timeout et renvoie une référence à l'objet mis à jour.

Un délai fixe la durée maximale pendant laquelle un client est prêt à attendre une réponse d’un serveur. Le délai réel est calculé en ajoutant l’ timeout à l’heure de début du RPC.

Le délai s'applique à toute la durée de vie d'un RPC, ce qui inclut la réception de l'QGrpcStatus finale d'un appel lancé précédemment ; il peut donc s'avérer indésirable pour les flux (de longue durée).

Voir également ` deadlineTimeout()`.

[since 6.11] QGrpcChannelOptions &QGrpcChannelOptions::setFilterServerMetadata(bool value)

Si la valeur de « value » est « true », les métadonnées liées au protocole définies par le transport gRPC (telles que les clés réservées grpc- ) seront exclues. Si la valeur de « value » est « false », toutes les métadonnées reçues du serveur seront incluses.

Cette fonction a été introduite dans Qt 6.11.

Voir également filterServerMetadata() et QGrpcCallOptions::setFilterServerMetadata().

[since 6.12] QGrpcChannelOptions &QGrpcChannelOptions::setMaximumReceiveMessageSize(quint64 size)

Définit la taille maximale de l'size e des messages entrants en octets et renvoie une référence à l'objet mis à jour.

Les messages dépassant cette limite sont rejetés avec un message d’ StatusCode::ResourceExhausted avant que leur charge utile ne soit mise en mémoire tampon. La valeur est utilisée telle quelle ; ainsi, une size de type 0 n’accepte que les messages vides.

Cette fonction a été introduite dans Qt 6.12.

Voir également ` maximumReceiveMessageSize()` et ` QGrpcCallOptions::setMaximumReceiveMessageSize()`.

Cette fonction sera obsolète à partir de la version 6.13.

Utilisez plutôt la surcharge de la fonction ` QMultiHash `.

Définit le paramètre « metadata » et renvoie une référence à l'objet mis à jour.

Voir également metadata().

Définit la propriété « metadata » et renvoie une référence à l'objet mis à jour.

Ces fonctions ont été introduites dans Qt 6.10.

Voir également metadata(QtGrpc::MultiValue_t).

[since 6.12] QGrpcChannelOptions &QGrpcChannelOptions::setRequestCompression(QtGrpc::CompressionAlgorithm algorithm)

Définit l'algorithm de compression utilisée pour compresser les messages envoyés par le client et renvoie une référence à l'objet mis à jour.

Une fois défini, l’algorithme est indiqué dans l’en-tête de requête « grpc-encoding ». Chaque message est compressé indépendamment ; si la compression ne réduit pas la taille de la charge utile, le message est envoyé non compressé, la valeur de « Compressed-Flag » étant alors définie sur « 0 » quoi qu’il arrive.

Cette fonction a été introduite dans Qt 6.12.

Voir également ` requestCompression()` et ` QGrpcCallOptions::setRequestCompression()`.

[since 6.8] QGrpcChannelOptions &QGrpcChannelOptions::setSerializationFormat(const QGrpcSerializationFormat &format)

Définit l'format de sérialisation du canal et renvoie une référence à l'objet mis à jour.

Cette fonction a été introduite dans Qt 6.8.

Voir aussi ` serializationFormat()`.

QGrpcChannelOptions &QGrpcChannelOptions::setSslConfiguration(const QSslConfiguration &sslConfiguration)

Définit l'sslConfiguration e du canal et renvoie une référence à l'objet mis à jour.

Voir également sslConfiguration().

std::optional<QSslConfiguration> QGrpcChannelOptions::sslConfiguration() const

Renvoie la configuration SSL du canal.

Si ce champ n'est pas défini, renvoie un objet ` std::optional` vide.

Voir aussi setSslConfiguration().

[static noexcept, since 6.12] QtGrpc::CompressionAlgorithms QGrpcChannelOptions::supportedCompressionAlgorithms()

Renvoie les algorithmes de compression que la version actuelle de Qt peut prendre en charge. « Identity » est toujours présent, car la spécification gRPC impose l'utilisation de messages non compressés. « Deflate » et « Gzip » sont toujours pris en charge.

Cette fonction a été introduite dans Qt 6.12.

Voir également acceptedCompressionAlgorithms() et setAcceptedCompressionAlgorithms().

[noexcept, since 6.8] void QGrpcChannelOptions::swap(QGrpcChannelOptions &other)

Permute l'other s de cet objet. Cette opération est très rapide et ne peut jamais échouer.

Cette fonction a été introduite dans Qt 6.8.

[since 6.8] QGrpcChannelOptions::operator QVariant() const

Crée un nouvel objet ` QVariant ` à partir de cet objet.

Cette fonction a été introduite dans Qt 6.8.

[noexcept] QGrpcChannelOptions &QGrpcChannelOptions::operator=(QGrpcChannelOptions &&other)

La fonction « move-assign » attribue la valeur de other à cet objet QGrpcChannelOptions et renvoie une référence à l'objet mis à jour.

QGrpcChannelOptions &QGrpcChannelOptions::operator=(const QGrpcChannelOptions &other)

Attribue la valeur « other » à cet objet « QGrpcChannelOptions » et renvoie une référence à l'objet mis à jour.