QGrpcChannelOptions Class

Member Function Documentation

[explicit] QGrpcChannelOptions::QGrpcChannelOptions(const QUrl &host)

Constructs an QGrpcChannelOptions object with host value.

QGrpcChannelOptions::QGrpcChannelOptions(const QGrpcChannelOptions &other)

Construct a copy of QGrpcChannelOptions with other object.

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

Move-construct a QGrpcChannelOptions instance, making it point at the same object that other was pointing to.

[noexcept] QGrpcChannelOptions::~QGrpcChannelOptions()

Destroys the QGrpcChannelOptions object.

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

Returns deadline value for setting up the channel.

Deadline value controls the maximum execution time of any call or stream executed on the channel.

If value was not set returns empty std::optional.

[noexcept] QUrl QGrpcChannelOptions::host() const

Returns host value for the channel.

[noexcept] const QGrpcMetadata &QGrpcChannelOptions::metadata() const

Returns metadata used for every call on the channel.

If value was not set returns empty QGrpcMetadata.

[noexcept, since 6.8] const QGrpcSerializationFormat &QGrpcChannelOptions::serializationFormat() const

Returns the serialization format used in QAbstractGrpcChannel implementations.

This function was introduced in Qt 6.8.

[noexcept] std::optional<QSslConfiguration> QGrpcChannelOptions::sslConfiguration() const

Returns SSL configuration for the channel.

If value was not set returns empty std::optional.

QGrpcChannelOptions &QGrpcChannelOptions::withDeadline(std::chrono::milliseconds deadline)

Sets deadline value with deadline and returns updated QGrpcChannelOptions object.

QGrpcChannelOptions &QGrpcChannelOptions::withHost(const QUrl &host)

Sets host value with host and returns updated QGrpcChannelOptions object.

QGrpcChannelOptions &QGrpcChannelOptions::withMetadata(const QGrpcMetadata &metadata)

Sets metadata for all calls and returns updated QGrpcChannelOptions object.

For HTTP2-based channels, metadata is converted into HTTP/2 headers, that added to each HTTP/2 request.

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

Sets the serialization format in the channel and returns updated QGrpcChannelOptions object.

The serialization format should be considered in QAbstractGrpcChannel implementations.

This function was introduced in Qt 6.8.

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

Sets SSL configuration with sslConfiguration and returns updated QGrpcChannelOptions object.

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

Move-assigns other to this QGrpcChannelOptions instance.

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

Assigns other to this QGrpcChannelOptions and returns a reference to this QGrpcChannelOptions.