Referencia de API y eventos de Adder
Referencia de API y eventos
Sección titulada «Referencia de API y eventos»Esta guía documenta el parámetro opcional replay del endpoint /events y el contrato de apagado de la API Go de Adder.
Endpoint /events
Sección titulada «Endpoint /events»El endpoint /events acepta el parámetro de consulta opcional replay:
GET /events?replay=false- Sin
replay, Adder usareplay=truey activa la reproducción de eventos almacenados en el búfer. replay=falsesolicita una entrega solo de eventos en directo y excluye la reproducción de eventos almacenados en el búfer.replay=trueactiva la reproducción de eventos almacenados en el búfer.
Adder Tray usa replay=false en la conexión inicial para recibir solo eventos en directo. Después de una reconexión, usa replay=true para activar la reproducción del búfer. Esta política de conexión pertenece a Adder Tray y no constituye un requisito para todos los clientes de la API.
Contrato de apagado de la API Go
Sección titulada «Contrato de apagado de la API Go»La interfaz api.API requiere el método:
Shutdown(context.Context) errorAPIv1 implementa el apagado del listener. Las implementaciones de api.API deben incluir este método y el código que llama a la interfaz debe gestionar su resultado.
Docs authored by Doc Holiday