QGrpcChannelOptions Class

Member Function Documentation

QGrpcChannelOptions::QGrpcChannelOptions()

Default-constructs an empty QGrpcChannelOptions.

QGrpcChannelOptions::QGrpcChannelOptions(const QGrpcChannelOptions &other)

Copy-constructs a QGrpcChannelOptions from other.

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

Move-constructs a new QGrpcChannelOptions from other.

[noexcept] QGrpcChannelOptions::~QGrpcChannelOptions()

Destroys the QGrpcChannelOptions.

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

Returns the compression algorithms that this channel is willing to accept from the server. The set always contains Identity because the gRPC specification mandates that uncompressed messages are accepted.

The value is used to build the grpc-accept-encoding request header. If the server responds with a compression algorithm that is not in this set, the call is finished with a Unimplemented status code.

By default, this is supportedCompressionAlgorithms(): every algorithm the current Qt build can negotiate is advertised.

This function was introduced in Qt 6.12.

See also setAcceptedCompressionAlgorithms() and supportedCompressionAlgorithms().

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

Adds key and value to the metadata if the exact pair is not already contained. The same key may appear multiple times with different values.

This function was introduced in Qt 6.10.

See also metadata() and setMetadata().

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

Returns the timeout duration that is used to calculate the deadline for the channel.

If this field is unset, returns an empty std::optional.

See also setDeadlineTimeout().

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

Returns true if protocol-related server metadata is excluded from the result. Returns false to include all metadata received from the server.

If this field is unset, returns an empty std::optional.

This function was introduced in Qt 6.11.

See also setFilterServerMetadata() and QGrpcCallOptions::filterServerMetadata().

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

Returns the maximum size in bytes of an incoming gRPC message accepted by this channel or call. The limit applies to the decoded gRPC frame payload, after transport-level decryption and any per-message decompression.

This function returns only the value explicitly configured on this object:

• std::nullopt if no value was set
• 0 if the QtGrpc-imposed limit is disabled
• otherwise, the configured maximum message size

If no value is configured, the effective limit is resolved when an RPC starts using the following precedence:

1. call options
2. channel options
3. the QT_GRPC_MAXIMUM_RECEIVE_MESSAGE_SIZE environment variable
4. the built-in 4 MiB default specified by gRPC

This function was introduced in Qt 6.12.

See also setMaximumReceiveMessageSize() and QGrpcCallOptions::maximumReceiveMessageSize().

This function is scheduled for deprecation in version 6.13.

Use metadata(QtGrpc::MultiValue) instead.

Returns the metadata. If this field is unset, returns empty metadata.

See also metadata(QtGrpc::MultiValue_t) and setMetadata().

Returns the metadata. If this field is unset, returns empty metadata.

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

These functions were introduced in Qt 6.10.

See also setMetadata.

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

Returns the compression algorithm used to compress outbound messages on this channel or call.

If this field is unset, returns an empty std::optional.

This function was introduced in Qt 6.12.

See also setRequestCompression() and QGrpcCallOptions::requestCompression().

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

Returns the serialization format used by the channel.

If this field is unset, returns a Default constructed serialization format.

This function was introduced in Qt 6.8.

See also setSerializationFormat().

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

Sets the accepted compression algorithms and returns a reference to the updated object.

Identity is always added implicitly, because the gRPC specification requires clients to accept uncompressed messages.

If {QtGrpc::CompressionAlgorithm::Identity} is the only accepted algorithm, compressed responses are refused. Adding additional flags allows the server to respond using those compression algorithms.

Only algorithms supported by this Qt build and included in algorithms are advertised to the server as accepted response compression methods. Flags that are not present in supportedCompressionAlgorithms() are silently discarded.

This function was introduced in Qt 6.12.

See also acceptedCompressionAlgorithms() and supportedCompressionAlgorithms().

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

Sets the timeout and returns a reference to the updated object.

A deadline sets the limit for how long a client is willing to wait for a response from a server. The actual deadline is computed by adding the timeout to the start time of the RPC.

The deadline applies to the entire lifetime of an RPC, which includes receiving the final QGrpcStatus for a previously started call and can thus be unwanted for (long-lived) streams.

See also deadlineTimeout().

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

If value is true, protocol-related metadata defined by the gRPC transport (such as reserved grpc- keys) will be excluded. If value is false, all metadata received from the server will be included.

This function was introduced in Qt 6.11.

See also filterServerMetadata() and QGrpcCallOptions::setFilterServerMetadata().

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

Sets the maximum incoming message size in bytes and returns a reference to the updated object.

Messages exceeding this limit are rejected with StatusCode::ResourceExhausted before their payload is buffered.

A value of 0 disables the QtGrpc-imposed limit. If no value is configured, a default limit of 4 MiB applies, matching the gRPC specification.

This function was introduced in Qt 6.12.

See also maximumReceiveMessageSize() and QGrpcCallOptions::setMaximumReceiveMessageSize().

This function is scheduled for deprecation in version 6.13.

Use the QMultiHash overload instead.

Sets the metadata and returns a reference to the updated object.

See also metadata().

Sets the metadata and returns a reference to the updated object.

These functions were introduced in Qt 6.10.

See also metadata(QtGrpc::MultiValue_t).

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

Sets the compression algorithm used to compress messages sent by the client and returns a reference to the updated object.

When set, the algorithm is announced in the grpc-encoding request header. Each message is compressed independently; if compression does not reduce the payload size, the message is sent uncompressed with the Compressed-Flag set to 0 regardless.

This function was introduced in Qt 6.12.

See also requestCompression() and QGrpcCallOptions::setRequestCompression().

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

Sets the serialization format for the channel and returns a reference to the updated object.

This function was introduced in Qt 6.8.

See also serializationFormat().

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

Sets the sslConfiguration for the channel and returns a reference to the updated object.

See also sslConfiguration().

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

Returns the SSL configuration for the channel.

If this field is unset, returns an empty std::optional.

See also setSslConfiguration().

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

Returns the compression algorithms that the current Qt build can negotiate. Identity is always present because the gRPC specification mandates uncompressed messages. Deflate and Gzip are always supported.

This function was introduced in Qt 6.12.

See also acceptedCompressionAlgorithms() and setAcceptedCompressionAlgorithms().

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

Swaps other with this object. This operation is very fast and never fails.

This function was introduced in Qt 6.8.

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

Constructs a new QVariant from this object.

This function was introduced in Qt 6.8.

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

Move-assigns other to this QGrpcChannelOptions and returns a reference to the updated object.

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

Assigns other to this QGrpcChannelOptions and returns a reference to the updated object.