Module amqp10_msg

Data Types

amqp10_body()

amqp10_body() = [#'v1_0.data'{}] | [#'v1_0.amqp_sequence'{}] | #'v1_0.amqp_value'{}

amqp10_header()

amqp10_header() = #{durable => boolean(), priority => byte(), ttl => maybe(non_neg_integer()), first_acquirer => boolean(), delivery_count => non_neg_integer()}

amqp10_msg()

abstract datatype: amqp10_msg()

amqp10_properties()

amqp10_properties() = #{message_id => maybe(any()), user_id => maybe(binary()), to => maybe(any()), subject => maybe(binary()), reply_to => maybe(any()), correlation_id => maybe(any()), content_type => maybe(content_type()), content_encoding => maybe(content_encoding()), absolute_expiry_time => maybe(non_neg_integer()), creation_time => maybe(non_neg_integer()), group_id => maybe(binary()), group_sequence => maybe(non_neg_integer()), reply_to_group_id => maybe(binary())}

annotations_key()

annotations_key() = binary() | non_neg_integer()

content_encoding()

content_encoding() = term()

content_type()

content_type() = term()

delivery_tag()

delivery_tag() = binary()

header_key()

header_key() = durable | priority | ttl | first_acquirer | delivery_count

maybe()

maybe(T) = T | undefined

Function Index

application_properties/1
body/1
body_bin/1Returns the binary representation.
delivery_annotations/1
delivery_id/1
delivery_tag/1
footer/1
from_amqp_records/1
handle/1
header/2
headers/1
message_annotations/1
message_format/1
new/2Create a new settled amqp10 message using the specified delivery tag and body.
new/3Create a new amqp10 message using the specified delivery tag, body and settlement state.
properties/1
set_application_properties/2
set_delivery_annotations/2
set_handle/2Set the link handle used for the message transfer.
set_headers/2Set amqp message headers.
set_message_annotations/2
set_message_format/2Set the message format.
set_properties/2Set amqp message properties.
set_settled/2Set the settledment mode.
settled/1
to_amqp_records/1

Function Details

application_properties/1

application_properties(Amqp10_msg::amqp10_msg()) -> #{binary() => binary() | integer() | string()}

body/1

body(Amqp10_msg::amqp10_msg()) -> [binary()] | [#'v1_0.amqp_sequence'{}] | #'v1_0.amqp_value'{}

body_bin/1

body_bin(Amqp10_msg::amqp10_msg()) -> binary()

Returns the binary representation

delivery_annotations/1

delivery_annotations(Amqp10_msg::amqp10_msg()) -> #{annotations_key() => any()}

delivery_id/1

delivery_id(Amqp10_msg::amqp10_msg()) -> non_neg_integer()

delivery_tag/1

delivery_tag(Amqp10_msg::amqp10_msg()) -> delivery_tag()

footer/1

footer(Amqp10_msg::amqp10_msg()) -> #{annotations_key() => any()}

from_amqp_records/1

from_amqp_records(Records::[amqp10_client_types:amqp10_msg_record()]) -> amqp10_msg()

handle/1

handle(Amqp10_msg::amqp10_msg()) -> non_neg_integer()

header/2

header(K::header_key(), Amqp10_msg::amqp10_msg()) -> term()

headers/1

headers(Amqp10_msg::amqp10_msg()) -> amqp10_header()

message_annotations/1

message_annotations(Amqp10_msg::amqp10_msg()) -> #{annotations_key() => any()}

message_format/1

message_format(Amqp10_msg::amqp10_msg()) -> maybe({non_neg_integer(), non_neg_integer()})

new/2

new(DeliveryTag::delivery_tag(), Body::amqp10_body() | binary()) -> amqp10_msg()

Create a new settled amqp10 message using the specified delivery tag and body.

new/3

new(DeliveryTag::delivery_tag(), Body::amqp10_body() | binary(), Settled::boolean()) -> amqp10_msg()

Create a new amqp10 message using the specified delivery tag, body and settlement state. Settled=true means the message is considered settled as soon as sent and no disposition will be issued by the receiver. Settled=false will delay settlement until a disposition has been received. A disposition will be notified to the sender by a message of the following stucture: {amqp10_disposition, {accepted | rejected, DeliveryTag}}

properties/1

properties(Amqp10_msg::amqp10_msg()) -> amqp10_properties()

set_application_properties/2

set_application_properties(Props::#{binary() | string() => binary() | integer() | string()}, Amqp10_msg::amqp10_msg()) -> amqp10_msg()

set_delivery_annotations/2

set_delivery_annotations(Props::#{binary() => binary() | integer() | string()}, Amqp10_msg::amqp10_msg()) -> amqp10_msg()

set_handle/2

set_handle(Handle::non_neg_integer(), Amqp10_msg::amqp10_msg()) -> amqp10_msg()

Set the link handle used for the message transfer.

set_headers/2

set_headers(Headers::#{atom() => any()}, Amqp10_msg::amqp10_msg()) -> amqp10_msg()

Set amqp message headers.

set_message_annotations/2

set_message_annotations(Props::#{binary() => binary() | integer() | string()}, Amqp10_msg::amqp10_msg()) -> amqp10_msg()

set_message_format/2

set_message_format(X1::{non_neg_integer(), non_neg_integer()}, Amqp10_msg::amqp10_msg()) -> amqp10_msg()

Set the message format.

set_properties/2

set_properties(Props::amqp10_properties(), Amqp10_msg::amqp10_msg()) -> amqp10_msg()

Set amqp message properties.

set_settled/2

set_settled(Settled::boolean(), Amqp10_msg::amqp10_msg()) -> amqp10_msg()

Set the settledment mode. Settled=true means the message is considered settled as soon as sent and no disposition will be issued by the receiver. Settled=false will delay settlement until a disposition has been received. A disposition will be notified to the sender by a message of the following stucture: {amqp10_disposition, {accepted | rejected, DeliveryTag}}

settled/1

settled(Amqp10_msg::amqp10_msg()) -> boolean()

to_amqp_records/1

to_amqp_records(Amqp10_msg::amqp10_msg()) -> [amqp10_client_types:amqp10_msg_record()]


Generated by EDoc