QGrpcOperation Class

Member Function Documentation

void QGrpcOperation::cancel()

Attempts to cancel the operation in a channel and immediately emits QGrpcOperation::errorOccurred with the QGrpcStatus::Cancelled status code.

Any manipulation of the operation after this call has no effect.

[signal] void QGrpcOperation::errorOccurred(const QGrpcStatus &status) const

This signal indicates the error occurred during serialization.

This signal is emitted when error with status occurs in channel or during serialization.

See also QAbstractGrpcClient::errorOccurred.

[signal] void QGrpcOperation::finished()

This signal indicates the end of communication for this call.

If this signal is emitted by the stream then this stream is successfully closed either by client or server.

[noexcept] bool QGrpcOperation::isFinished() const

Returns true when QGrpcOperation finished its workflow, meaning it was finished, canceled, or error occurred, otherwise returns false.

[noexcept] QGrpcMetadata QGrpcOperation::metadata() const

Getter of the metadata received from the channel. For the HTTP2 channels it usually contains the HTTP headers received from the server.

[noexcept] QLatin1StringView QGrpcOperation::method() const

Getter of the method that this operation was intialized with.

template <typename T> T QGrpcOperation::read() const

Reads message from raw byte array stored in QGrpcOperation.

Returns a deserialized message or, on failure, a default-constructed message. If deserialization is not successful the QGrpcOperation::errorOccurred signal is emitted.