QQmlGrpcChannelOptions QML Type

The QQmlGrpcChannelOptions is an storage class used to set additional channel options. More...

Import Statement: import QtGrpc
Since: Qt 6.7
Instantiates: QGrpcChannelOptions


Detailed Description

Provides a set of properties to access the channel options that are used by gRPC channels to communicate with the services.

See also QGrpcChannelOptions.

Property Documentation

deadline : int

Sets a deadline value for a channel.

See also QGrpcChannelOptions::deadline.

host : QUrl

Sets a host URL for the channel.

Note: host is REQUIRED property. It must be set for object creation.

See also QGrpcChannelOptions::host.

metadata : QQmlGrpcMetadata

Sets a pointer to the metadata object used for a channel.

See also QQmlGrpcMetadata and QGrpcMetadata.

serializationFormat : enumeration [since 6.8]

Sets the serialization format for the channel. The GrpcSerializationFormat::Default format is used by default.

GrpcSerializationFormat.DefaultThe default GrpcSerializationFormat preset. This preset constructs QProtobufSerializer with an empty content type suffix.
GrpcSerializationFormat.ProtobufThe embedded protobuf GrpcSerializationFormat preset. This preset constructs QProtobufSerializer with the proto content type suffix.
GrpcSerializationFormat.JsonThe embedded JSON GrpcSerializationFormat preset. This preset constructs QProtobufJsonSerializer with the json content type suffix.

Note: This enumeration is the Qt Quick equivalent of QGrpcSerializationFormat::Format.

This property was introduced in Qt 6.8.

See also QGrpcChannelOptions::serializationFormat and QGrpcSerializationFormat::Format.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.