yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: briefly describe delivery callbacks

This commit is contained in:
Thales Macedo Garitezi 2024-05-06 10:00:10 -03:00
parent e6b1dfb095
commit cd4aaf663b
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
apps/emqx_connector_aggregator/src/emqx_connector_aggreg_delivery.erl
View File

@ -42,12 +42,19 @@
-type transfer_state() :: term(). -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(). -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(). -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()}. -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()}. -callback process_complete(transfer_state()) -> {ok, term()}.
%% %%