فهرست منبع

docs: briefly describe delivery callbacks

Thales Macedo Garitezi 1 سال پیش
والد
کامیت
cd4aaf663b
1فایلهای تغییر یافته به همراه7 افزوده شده و 0 حذف شده
  1. 7 0
      apps/emqx_connector_aggregator/src/emqx_connector_aggreg_delivery.erl

+ 7 - 0
apps/emqx_connector_aggregator/src/emqx_connector_aggreg_delivery.erl

@@ -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()}.
 
 
 %%
 %%