From cd4aaf663be9e6f751a1f869cb838108c9f0201b Mon Sep 17 00:00:00 2001 From: Thales Macedo Garitezi Date: Mon, 6 May 2024 10:00:10 -0300 Subject: [PATCH] docs: briefly describe delivery callbacks --- .../src/emqx_connector_aggreg_delivery.erl | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/apps/emqx_connector_aggregator/src/emqx_connector_aggreg_delivery.erl b/apps/emqx_connector_aggregator/src/emqx_connector_aggreg_delivery.erl index 6124aa5a6..071c28ee5 100644 --- a/apps/emqx_connector_aggregator/src/emqx_connector_aggreg_delivery.erl +++ b/apps/emqx_connector_aggregator/src/emqx_connector_aggreg_delivery.erl @@ -42,12 +42,19 @@ -type transfer_state() :: term(). +%% @doc Initialize the transfer state, such as blob storage path, transfer options, client +%% credentials, etc. . -callback init_transfer_state(buffer_map(), map()) -> transfer_state(). +%% @doc Append data to the transfer before sending. Usually should not fail. -callback process_append(iodata(), transfer_state()) -> transfer_state(). +%% @doc Push appended transfer data to its destination (e.g.: upload a part of a +%% multi-part upload). May fail. -callback process_write(transfer_state()) -> {ok, transfer_state()} | {error, term()}. +%% @doc Finalize the transfer and clean up any resources. May return a term summarizing +%% the transfer. -callback process_complete(transfer_state()) -> {ok, term()}. %%