agent_protocol (agents v0.2.0)

View Source

Summary

Functions

create_broadcast(Sender, Payload)

-spec create_broadcast(Sender, Payload) -> Message
                          when Sender :: binary() | atom(), Payload :: map(), Message :: map().

create_event(Sender, EventName, EventData)

-spec create_event(Sender, EventName, EventData) -> Message
                      when
                          Sender :: binary() | atom(),
                          EventName :: binary() | atom(),
                          EventData :: map(),
                          Message :: map().

create_message(Type, Sender, Payload)

-spec create_message(Type, Sender, Payload) -> Message
                        when
                            Type :: binary(),
                            Sender :: binary() | atom(),
                            Payload :: map(),
                            Message :: map().

create_request(Sender, Receiver, Payload)

-spec create_request(Sender, Receiver, Payload) -> Message
                        when
                            Sender :: binary() | atom(),
                            Receiver :: binary() | atom(),
                            Payload :: map(),
                            Message :: map().

create_response(CorrelationId, Sender, Receiver, Payload)

-spec create_response(CorrelationId, Sender, Receiver, Payload) -> Message
                         when
                             CorrelationId :: binary(),
                             Sender :: binary() | atom(),
                             Receiver :: binary() | atom(),
                             Payload :: map(),
                             Message :: map().

get_correlation_id(Message)

-spec get_correlation_id(Message) -> CorrelationId
                            when Message :: map(), CorrelationId :: binary() | undefined.

get_message_id(Message)

-spec get_message_id(Message) -> Id when Message :: map(), Id :: binary().

get_payload(Message)

-spec get_payload(Message) -> Payload when Message :: map(), Payload :: map().

get_receiver(Message)

-spec get_receiver(Message) -> Receiver when Message :: map(), Receiver :: binary() | undefined.

get_sender(Message)

-spec get_sender(Message) -> Sender when Message :: map(), Sender :: binary().

get_timestamp(Message)

-spec get_timestamp(Message) -> Timestamp when Message :: map(), Timestamp :: integer().

get_type(Message)

-spec get_type(Message) -> Type when Message :: map(), Type :: binary().

is_broadcast(Message)

-spec is_broadcast(Message) -> boolean() when Message :: map().

is_event(Message)

-spec is_event(Message) -> boolean() when Message :: map().

is_request(Message)

-spec is_request(Message) -> boolean() when Message :: map().

is_response(Message)

-spec is_response(Message) -> boolean() when Message :: map().

validate_message(Message)

-spec validate_message(Message) -> Result
                          when Message :: map(), Result :: ok | {error, Reason}, Reason :: term().