QGrpcInterceptorChain Class

成员函数文档

QGrpcInterceptorChain::QGrpcInterceptorChain()

构建一个空的拦截器链。

[delete] QGrpcInterceptorChain::QGrpcInterceptorChain(const QGrpcInterceptorChain &)

复制并构造一个QGrpcInterceptorChain 实例。该函数已被删除。

[noexcept] QGrpcInterceptorChain::~QGrpcInterceptorChain()

摧毁拦截器链。

template <typename T> requires QtGrpcPrivate::if_interceptor<T> bool QGrpcInterceptorChain::add(T *interceptor)

将interceptor 添加到链中，但不获取其所有权。

如果拦截器已被添加，则返回true ；否则返回false 。

当通过原始指针设置拦截器时，调用方将保留所有权。QGrpcInterceptorChain 存储对所提供拦截器的非所有权引用。

拦截器链会被转移给通道并由通道拥有。因此，在使用该链的通道整个生命周期内，所有拦截器对象都必须保持有效。

以下代码演示了如何使用自定义删除器将拦截器的生命周期与单个通道绑定：

auto *metricsInterceptor = newMetricsInterceptor();
auto *authInterceptor = newAuthInterceptor();
~~~
QGrpcInterceptorChain chain;
if(!chain.add(metricsInterceptor))
    qFatal("Failed to add metrics interceptor");
if(!chain.add(authInterceptor))
    qFatal("Failed to add auth interceptor");

autochannel=std::shared_ptr<QGrpcHttp2Channel>(
    newQGrpcHttp2Channel(QUrl("you_uri:port"),std::move(chain)),
    [&metricsInterceptor, &authInterceptor](QGrpcHttp2Channel*ptr) {
        deleteptr;
        qDebug() << "Channel destroyed.";
       // 如果这些拦截器未与任何其他通道共享，
        // 这里是删除它们的合适位置。否则，其
        // 生命周期必须在外部进行管理。
       deletemetricsInterceptor;
        deleteauthInterceptor;
        metricsInterceptor=nullptr;
        authInterceptor=nullptr;
    }
);

每种拦截器类型必须实现至少一个拦截器接口（例如，QGrpcStartInterceptor 或QGrpcFinishedInterceptor ），以提供拦截功能。

另请参阅 set() 和clear()。

template <typename T> requires QtGrpcPrivate::if_interceptor<T> bool QGrpcInterceptorChain::add(std::unique_ptr<T> &&interceptor)

将interceptor 添加到拦截器链中，并将其所有权移交给自己。

如果拦截器已成功添加，则返回true ；否则返回false 。

只有当拦截器成功添加时，interceptor 的所有权才会转移给链。如果该函数返回false ，则所有权仍归调用者所有。

每种拦截器类型都必须实现至少一个拦截器接口（例如QGrpcStartInterceptor 或QGrpcFinishedInterceptor ），以提供拦截功能。

另请参阅 set() 和clear()。

[noexcept] QtGrpc::InterceptorCapabilities QGrpcInterceptorChain::capabilities() const

返回链中存储的所有拦截器的综合能力。

返回值是各拦截器提供的权限的按位或运算结果。

另请参阅 hasHandlerFor()、capabilitiesAt() 以及QtGrpc::InterceptorCapability 。

QtGrpc::InterceptorCapabilities QGrpcInterceptorChain::capabilitiesAt(qsizetype index) const

返回拦截器在index 中提供的功能。

另请参阅 capabilities() 和size()。

void QGrpcInterceptorChain::clear()

清除链。

从链中移除所有拦截器。该链所拥有的任何拦截器都将被销毁。

另请参阅 add() 和set()。

[noexcept] bool QGrpcInterceptorChain::empty() const

如果拦截器链中不包含任何拦截器，则返回 `true `；否则返回 `false`。

另请参阅 size() 和isEmpty()。

[noexcept] bool QGrpcInterceptorChain::hasHandlerFor(QtGrpc::InterceptorCapability cap) const

如果该链中包含至少一个为能力cap 提供处理程序的拦截器，则返回true ；否则返回false 。

另请参阅 capabilities() 和capabilitiesAt()。

[noexcept] bool QGrpcInterceptorChain::isEmpty() const

如果拦截器链中不包含任何拦截器，则返回 `true `；否则返回 `false`。

另请参阅 size() 和empty()。

template <typename... Ts> requires QtGrpcPrivate::if_interceptor<Ts...> bool QGrpcInterceptorChain::set(Ts *... interceptors)

将链中的内容替换为interceptors ，但不获取其所有权。

如果所有拦截器均已成功添加，则返回true ；否则返回false ，并保持拦截链不变。

当通过原始指针设置拦截器时，调用方保留所有权。QGrpcInterceptorChain 存储对所提供拦截器的非所有权引用。

拦截器链将转移给通道并由通道拥有。因此，在使用该链的通道整个生命周期内，所有拦截器对象都必须保持有效。

以下代码演示了如何使用自定义删除器将拦截器的生命周期与单个通道绑定：

auto *metricsInterceptor = newMetricsInterceptor();
auto *authInterceptor = newAuthInterceptor();
~~~
QGrpcInterceptorChain chain;
if(!chain.set(metricsInterceptor,authInterceptor))
    qFatal("Failed to set interceptors to chain");

autochannel=std::shared_ptr<QGrpcHttp2Channel>(
    newQGrpcHttp2Channel(QUrl("you_uri:port"),std::move(chain)),
    [&metricsInterceptor, &authInterceptor](QGrpcHttp2Channel*ptr) {
        deleteptr;
        qDebug() << "Channel destroyed.";
       // 如果这些拦截器未与其他任何通道共享，
        // 这里是删除它们的合适位置。否则，其
        // 生命周期必须由外部进行管理。
       deletemetricsInterceptor;
        deleteauthInterceptor;
        metricsInterceptor=nullptr;
        authInterceptor=nullptr;
    }
);

每种拦截器类型都必须实现至少一个拦截器接口（例如，QGrpcStartInterceptor 或QGrpcFinishedInterceptor ），以提供拦截功能。

另请参阅 add() 和clear()。

template <typename... Ts> requires QtGrpcPrivate::if_interceptor<Ts...> bool QGrpcInterceptorChain::set(std::unique_ptr<Ts> &&... interceptors)

将链中的内容替换为interceptors ，并取得对其的所有权。

如果所有拦截器均添加成功，则返回true ；否则返回false ，并保持拦截器链不变。

拦截器的处理顺序与传递给该函数时的顺序一致。如果所有添加操作均成功，则链将被按该顺序替换为新的拦截器。

所有权会在处理拦截器时逐步转移。如果操作失败，失败前已成功添加的任何拦截器都会被销毁，而剩余的（尚未处理的）unique_ptrs 仍保持有效。

每种拦截器类型都必须实现至少一个拦截器接口（例如，QGrpcStartInterceptor 或QGrpcFinishedInterceptor ），以提供拦截功能。

另请参阅 add() 和clear()。

[noexcept] qsizetype QGrpcInterceptorChain::size() const

返回链中存储的拦截器数量。

另请参阅 isEmpty()。

[noexcept] void QGrpcInterceptorChain::swap(QGrpcInterceptorChain &other)

将other 与该对象互换。此操作速度极快，且绝不会失败。

[delete] QGrpcInterceptorChain &QGrpcInterceptorChain::operator=(const QGrpcInterceptorChain &)

将other 复制并赋值给该QGrpcInterceptorChain 实例。此函数已被删除。