QGrpcInterceptorChain Class
Almacena y gestiona una secuencia de interceptores. Más...
| Encabezado: | #include <QGrpcInterceptorChain> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Grpc) target_link_libraries(mytarget PRIVATE Qt6::Grpc) |
| Desde: | Qt 6.11 |
- Lista de todos los miembros, incluidos los miembros heredados
- QGrpcInterceptorChain forma parte de los interceptores deQt GRPC .
Funciones públicas
| QGrpcInterceptorChain() | |
| QGrpcInterceptorChain(const QGrpcInterceptorChain &) | |
| ~QGrpcInterceptorChain() | |
| bool | add(T *interceptor) |
| bool | add(std::unique_ptr<T> &&interceptor) |
| QtGrpc::InterceptorCapabilities | capabilities() const |
| QtGrpc::InterceptorCapabilities | capabilitiesAt(qsizetype index) const |
| void | clear() |
| bool | empty() const |
| bool | hasHandlerFor(QtGrpc::InterceptorCapability cap) const |
| bool | isEmpty() const |
| bool | set(Ts *... interceptors) |
| bool | set(std::unique_ptr<Ts> &&... interceptors) |
| qsizetype | size() const |
| void | swap(QGrpcInterceptorChain &other) |
| QGrpcInterceptorChain & | operator=(const QGrpcInterceptorChain &) |
Descripción detallada
QGrpcInterceptorChain almacena instancias de interceptores que observan o modifican diferentes etapas de una RPC. La cadena se pasa a un canal durante su construcción, y el canal es el propietario de la cadena durante el resto de su vida útil.
A medida que un RPC avanza en su ciclo de vida, el canal invoca los interceptores almacenados en la cadena en los puntos de interceptación correspondientes.
Los interceptores se añaden a la cadena en un orden definido. El orden es importante y determina cómo se invocan los interceptores durante las etapas de salida y entrada de una RPC. Para obtener más detalles, consulta la sección «Dirección y flujo» de la Descripción general de los interceptores deQt GRPC .
Los interceptores se pueden añadir utilizando dos modelos de propiedad principales:
- Con propiedad: se añaden interceptores mediante `
std::unique_ptr<T>`. Si la operación se realiza correctamente, la cadena asume la propiedad y destruye los interceptores cuando se destruye la cadena (y, por lo tanto, el canal). - Sin propiedad: Añade interceptores mediante punteros sin formato `
T*`. La cadena no asume la propiedad. El llamante debe asegurarse de que los objetos interceptores permanezcan válidos mientras el canal pueda invocarlos.
Ambos modelos pueden combinarse dentro de la misma cadena. Aunque está permitido, mezclar interceptores con propiedad y sin propiedad requiere precaución para garantizar que los interceptores sin propiedad sobrevivan a todos los canales que puedan utilizarlos.
Nota: QGrpcInterceptorChain no se puede copiar y solo se puede mover.
Véase también QtGrpc::InterceptorCapability.
Documentación de las funciones de miembro
QGrpcInterceptorChain::QGrpcInterceptorChain()
Crea una cadena de interceptores vacía.
[delete] QGrpcInterceptorChain::QGrpcInterceptorChain(const QGrpcInterceptorChain &)
Crea una instancia de ` QGrpcInterceptorChain` mediante copia. Esta función se ha eliminado.
[noexcept] QGrpcInterceptorChain::~QGrpcInterceptorChain()
Destruye la cadena de interceptores.
template <typename T> requires QtGrpcPrivate::if_interceptor<T> bool QGrpcInterceptorChain::add(T *interceptor)
Añade « interceptor » a la cadena sin asumir la propiedad.
Devuelve ` true ` si se ha añadido el interceptor; en caso contrario, devuelve ` false`.
Al establecer interceptores mediante un puntero sin tipo, el llamante conserva la propiedad. El objeto QGrpcInterceptorChain almacena referencias sin propiedad a los interceptores proporcionados.
La cadena de interceptores se transfiere al canal y pasa a ser propiedad de este. Como resultado, todos los objetos interceptores deben permanecer válidos durante todo el tiempo de vida del canal que utiliza la cadena.
El siguiente código muestra cómo utilizar un eliminador personalizado para vincular la vida útil del interceptor a un único canal:
auto *metricsInterceptor = new MetricsInterceptor();
auto *authInterceptor = new AuthInterceptor();
~~~
QGrpcInterceptorChain chain;
if (!chain.add(metricsInterceptor))
qFatal("Failed to add metrics interceptor");
if (!chain.add(authInterceptor))
qFatal("Failed to add auth interceptor");
auto channel = std::shared_ptr<QGrpcHttp2Channel>(
new QGrpcHttp2Channel(QUrl("you_uri:port"), std::move(chain)),
[&metricsInterceptor, &authInterceptor](QGrpcHttp2Channel* ptr) {
delete ptr;
qDebug() << "Channel destroyed.";
// Si estos interceptores no se comparten con ningún otro canal,
// este es el lugar adecuado para eliminarlos. De lo contrario, su
// ciclo de vida debe gestionarse externamente.
delete metricsInterceptor;
delete authInterceptor;
metricsInterceptor = nullptr;
authInterceptor = nullptr;
}
);Cada tipo de interceptor debe implementar al menos una interfaz de interceptor (por ejemplo, ` QGrpcStartInterceptor ` o ` QGrpcFinishedInterceptor`) para proporcionar capacidades de interceptación.
Véase también set() y clear().
template <typename T> requires QtGrpcPrivate::if_interceptor<T> bool QGrpcInterceptorChain::add(std::unique_ptr<T> &&interceptor)
Añade interceptor a la cadena y asume su propiedad.
Devuelve true si se ha añadido el interceptor; en caso contrario, devuelve false.
La propiedad de interceptor se transfiere a la cadena solo si el interceptor se añade correctamente. Si la función devuelve false, la propiedad sigue perteneciendo al autor de la llamada.
Cada tipo de interceptor debe implementar al menos una interfaz de interceptor (por ejemplo, QGrpcStartInterceptor o QGrpcFinishedInterceptor) para proporcionar capacidades de interceptación.
Véanse también set() y clear().
[noexcept] QtGrpc::InterceptorCapabilities QGrpcInterceptorChain::capabilities() const
Devuelve las capacidades combinadas de todos los interceptores almacenados en la cadena.
El valor devuelto es el OR bit a bit de las capacidades proporcionadas por los interceptores.
Véase también hasHandlerFor(), capabilitiesAt() y QtGrpc::InterceptorCapability.
QtGrpc::InterceptorCapabilities QGrpcInterceptorChain::capabilitiesAt(qsizetype index) const
Devuelve las capacidades que ofrece el interceptor en index.
Advertencia: Llamar a esta función con un index que no sea válido para la cadena da lugar a un comportamiento indefinido.
Véase también capabilities() y size().
void QGrpcInterceptorChain::clear()
Borra la cadena.
Elimina todos los interceptores de la cadena. Se destruyen todos los interceptores que pertenezcan a la cadena.
[noexcept] bool QGrpcInterceptorChain::empty() const
Devuelve ` true ` si la cadena no contiene ningún interceptor; en caso contrario, devuelve ` false`.
Véase también size() y isEmpty().
[noexcept] bool QGrpcInterceptorChain::hasHandlerFor(QtGrpc::InterceptorCapability cap) const
Devuelve ` true ` si la cadena contiene al menos un interceptor que proporcione un controlador para la capacidad ` cap`; en caso contrario, devuelve ` false`.
Véase también capabilities() y capabilitiesAt().
[noexcept] bool QGrpcInterceptorChain::isEmpty() const
Devuelve « true » si la cadena no contiene interceptores; en caso contrario, devuelve « false ».
Véanse también size() y empty().
template <typename... Ts> requires QtGrpcPrivate::if_interceptor<Ts...> bool QGrpcInterceptorChain::set(Ts *... interceptors)
Sustituye el contenido de la cadena por « interceptors » sin asumir la propiedad de los mismos.
Devuelve true si todos los interceptores se han añadido correctamente; en caso contrario, devuelve false y deja la cadena sin cambios.
Al establecer interceptores mediante un puntero sin tipificar, quien realiza la llamada conserva la propiedad. El objeto ` QGrpcInterceptorChain ` almacena referencias sin propiedad a los interceptores proporcionados.
La cadena de interceptores se transfiere al canal, que pasa a ser su propietario. Como resultado, todos los objetos interceptores deben permanecer válidos durante todo el ciclo de vida del canal que utiliza la cadena.
El siguiente código muestra cómo utilizar un eliminador personalizado para vincular la vida útil del interceptor a un único canal:
auto *metricsInterceptor = new MetricsInterceptor();
auto *authInterceptor = new AuthInterceptor();
~~~
QGrpcInterceptorChain chain;
if (!chain.set(metricsInterceptor, authInterceptor))
qFatal("Failed to set interceptors to chain");
auto channel = std::shared_ptr<QGrpcHttp2Channel>(
new QGrpcHttp2Channel(QUrl("you_uri:port"), std::move(chain)),
[&metricsInterceptor, &authInterceptor](QGrpcHttp2Channel* ptr) {
delete ptr;
qDebug() << "Channel destroyed.";
// Si estos interceptores no se comparten con ningún otro canal,
// este es el lugar adecuado para eliminarlos. De lo contrario, su
// ciclo de vida debe gestionarse externamente.
delete metricsInterceptor;
delete authInterceptor;
metricsInterceptor = nullptr;
authInterceptor = nullptr;
}
);Cada tipo de interceptor debe implementar al menos una interfaz de interceptor (por ejemplo, QGrpcStartInterceptor o QGrpcFinishedInterceptor) para proporcionar capacidades de interceptación.
Véase también add() y clear().
template <typename... Ts> requires QtGrpcPrivate::if_interceptor<Ts...> bool QGrpcInterceptorChain::set(std::unique_ptr<Ts> &&... interceptors)
Sustituye el contenido de la cadena por interceptors y asume la propiedad de los mismos.
Devuelve true si se han añadido correctamente todos los interceptores; de lo contrario, devuelve false y deja la cadena sin cambios.
Los interceptores se procesan en el orden en que se pasan a esta función. Si todas las adiciones se realizan correctamente, la cadena se sustituye por los nuevos interceptores en ese orden.
La propiedad se transfiere de forma incremental a medida que se procesan los interceptores. Si la operación falla, se destruyen los interceptores que se hayan añadido correctamente antes del fallo, mientras que los `unique_ptr` restantes (aún no procesados) siguen siendo válidos.
Cada tipo de interceptor debe implementar al menos una interfaz de interceptor (por ejemplo, QGrpcStartInterceptor o QGrpcFinishedInterceptor) para proporcionar capacidades de interceptación.
Véanse también add() y clear().
[noexcept] qsizetype QGrpcInterceptorChain::size() const
Devuelve el número de interceptores almacenados en la cadena.
Véase también isEmpty().
[noexcept] void QGrpcInterceptorChain::swap(QGrpcInterceptorChain &other)
Intercambia other por este objeto. Esta operación es muy rápida y nunca falla.
[delete] QGrpcInterceptorChain &QGrpcInterceptorChain::operator=(const QGrpcInterceptorChain &)
Asigna por copia other a esta instancia de QGrpcInterceptorChain. Esta función se ha eliminado.
© 2026 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.