%%%------------------------------------------------------------------- %%% @doc %%% Macula SDK - Main API module for HTTP/3 mesh client operations. %%% %%% This module provides the primary interface for applications to %%% connect to Macula mesh networks and perform pub/sub and RPC %%% operations over HTTP/3 (QUIC) transport. %%% %%% == Quick Start == %%% %%% Connect to a mesh, publish events, subscribe to topics, and make RPC calls. %%% See individual function documentation for detailed examples with code. %%% %%% @end %%%------------------------------------------------------------------- -module(macula_client). %% API exports -export([ connect/2, disconnect/1, publish/3, publish/4, subscribe/3, unsubscribe/2, call/3, call/4, advertise/3, advertise/4, unadvertise/2 ]). %% Type exports -export_type([ client/0, topic/0, event_data/0, procedure/0, args/0, options/0, subscription_ref/0 ]). %%%=================================================================== %%% Types %%%=================================================================== -type client() :: pid(). %% Reference to a connected Macula mesh client. -type topic() :: binary(). %% Topic name for pub/sub operations. Topics should describe event types, %% not entity IDs. Example: `"my.app.user.registered"' (good), %% not `"my.app.user.123.registered"' (bad - ID belongs in payload). -type event_data() :: map() | binary(). %% Event payload data. Typically a map that will be JSON-encoded. -type procedure() :: binary(). %% RPC procedure name. Example: `"my.app.get_user"'. -type args() :: map() | list() | binary(). %% Arguments for RPC calls. -type options() :: map(). %% Connection or operation options. -type subscription_ref() :: reference(). %% Reference to an active subscription for unsubscribe operations. %%%=================================================================== %%% API Functions %%%=================================================================== %% @doc Connect to a Macula mesh network. %% %% Creates a new HTTP/3 (QUIC) connection to the specified mesh endpoint. %% %% == Options == %% %% %% %% == Examples == %% %% ``` %% %% Basic connection %% {ok, Client} = macula_client:connect(<<"https://mesh.local:443">>, #{ %% realm => <<"my.realm">> %% }). %% %% %% With API key authentication %% {ok, Client} = macula_client:connect(<<"https://mesh.local:443">>, #{ %% realm => <<"my.realm">>, %% auth => #{api_key => <<"secret-key">>} %% }). %% ''' -spec connect(Url :: binary(), Opts :: options()) -> {ok, client()} | {error, Reason :: term()}. connect(Url, Opts) when is_binary(Url), is_map(Opts) -> macula_connection:start_link(Url, Opts); connect(Url, Opts) when is_list(Url), is_map(Opts) -> connect(list_to_binary(Url), Opts). %% @doc Disconnect from the Macula mesh. %% %% Cleanly closes the HTTP/3 connection and cleans up all subscriptions. -spec disconnect(Client :: client()) -> ok | {error, Reason :: term()}. disconnect(Client) when is_pid(Client) -> macula_connection:stop(Client). %% @doc Publish an event to a topic. %% %% Publishes data to the specified topic. All subscribers to this topic %% will receive the event. %% %% == Topic Design == %% %% Topics should describe EVENT TYPES, not entity instances: %% %% %% Entity IDs belong in the event payload, not the topic name. %% %% == Examples == %% %% ``` %% %% Publish with default options %% ok = macula_client:publish(Client, <<"my.app.events">>, #{ %% type => <<"user.registered">>, %% user_id => <<"user-123">>, %% email => <<"user@example.com">> %% }). %% %% %% Publish with options %% ok = macula_client:publish(Client, <<"my.app.events">>, #{ %% data => <<"important">> %% }, #{acknowledge => true}). %% ''' -spec publish(Client :: client(), Topic :: topic(), Data :: event_data()) -> ok | {error, Reason :: term()}. publish(Client, Topic, Data) when is_pid(Client), is_binary(Topic) -> macula_connection:publish(Client, Topic, Data). %% @doc Publish an event with options. -spec publish(Client :: client(), Topic :: topic(), Data :: event_data(), Opts :: options()) -> ok | {error, Reason :: term()}. publish(Client, Topic, Data, Opts) when is_pid(Client), is_binary(Topic), is_map(Opts) -> macula_connection:publish(Client, Topic, Data, Opts). %% @doc Subscribe to a topic. %% %% Subscribes to events on the specified topic. The callback function %% will be invoked for each event received. %% %% == Callback Function == %% %% The callback receives the event data and should return `ok'. %% %% == Examples == %% %% ``` %% %% Simple subscription %% {ok, SubRef} = macula_client:subscribe(Client, <<"my.app.events">>, %% fun(EventData) -> %% io:format("Event: ~p~n", [EventData]), %% ok %% end). %% %% %% Unsubscribe later %% ok = macula_client:unsubscribe(Client, SubRef). %% ''' -spec subscribe(Client :: client(), Topic :: topic(), Callback :: fun((event_data()) -> ok)) -> {ok, subscription_ref()} | {error, Reason :: term()}. subscribe(Client, Topic, Callback) when is_pid(Client), is_binary(Topic), is_function(Callback, 1) -> macula_connection:subscribe(Client, Topic, Callback). %% @doc Unsubscribe from a topic. %% %% Removes the subscription identified by the subscription reference. -spec unsubscribe(Client :: client(), SubRef :: subscription_ref()) -> ok | {error, Reason :: term()}. unsubscribe(Client, SubRef) when is_pid(Client), is_reference(SubRef) -> macula_connection:unsubscribe(Client, SubRef). %% @doc Make a synchronous RPC call. %% %% Calls a remote procedure and waits for the result. %% %% == Examples == %% %% ``` %% %% Simple RPC call %% {ok, User} = macula_client:call(Client, <<"my.app.get_user">>, #{ %% user_id => <<"user-123">> %% }). %% %% %% With timeout %% {ok, Result} = macula_client:call(Client, <<"my.app.process">>, %% #{data => <<"large">>}, %% #{timeout => 30000}). %% ''' -spec call(Client :: client(), Procedure :: procedure(), Args :: args()) -> {ok, Result :: term()} | {error, Reason :: term()}. call(Client, Procedure, Args) when is_pid(Client), is_binary(Procedure) -> macula_connection:call(Client, Procedure, Args). %% @doc Make an RPC call with options. -spec call(Client :: client(), Procedure :: procedure(), Args :: args(), Opts :: options()) -> {ok, Result :: term()} | {error, Reason :: term()}. call(Client, Procedure, Args, Opts) when is_pid(Client), is_binary(Procedure), is_map(Opts) -> macula_connection:call(Client, Procedure, Args, Opts). %% @doc Advertise a service that this client provides. %% %% Registers a handler function for the specified procedure and advertises %% it to the DHT so other clients can discover and call it. %% %% The handler function receives a map of arguments and must return %% `{ok, Result}' or `{error, Reason}'. %% %% == Options == %% %% %% %% == Examples == %% %% ``` %% %% Define a handler function %% Handler = fun(#{user_id := UserId}) -> %% {ok, #{user_id => UserId, name => <<"Alice">>}} %% end. %% %% %% Advertise the service %% {ok, Ref} = macula_client:advertise( %% Client, %% <<"my.app.get_user">>, %% Handler %% ). %% %% %% Other clients can now call: %% %% {ok, User} = macula_client:call(OtherClient, <<"my.app.get_user">>, %% %% #{user_id => <<"user-123">>}). %% ''' -spec advertise(Client :: client(), Procedure :: procedure(), Handler :: macula_service_registry:handler_fn()) -> {ok, reference()} | {error, Reason :: term()}. advertise(Client, Procedure, Handler) when is_pid(Client), is_binary(Procedure), is_function(Handler) -> advertise(Client, Procedure, Handler, #{}). %% @doc Advertise a service with options. -spec advertise(Client :: client(), Procedure :: procedure(), Handler :: macula_service_registry:handler_fn(), Opts :: options()) -> {ok, reference()} | {error, Reason :: term()}. advertise(Client, Procedure, Handler, Opts) when is_pid(Client), is_binary(Procedure), is_function(Handler), is_map(Opts) -> macula_connection:advertise(Client, Procedure, Handler, Opts). %% @doc Stop advertising a service. %% %% Removes the local handler and stops advertising to the DHT. %% %% == Examples == %% %% ``` %% ok = macula_client:unadvertise(Client, <<"my.app.get_user">>). %% ''' -spec unadvertise(Client :: client(), Procedure :: procedure()) -> ok | {error, Reason :: term()}. unadvertise(Client, Procedure) when is_pid(Client), is_binary(Procedure) -> macula_connection:unadvertise(Client, Procedure). %%%=================================================================== %%% Internal functions %%%===================================================================