Module amqp10_client_session

Behaviours: gen_statem.

Data Types

attach_args()

attach_args() = #{name => binary(), role => attach_role(), snd_settle_mode => snd_settle_mode(), rcv_settle_mode => rcv_settle_mode(), filter => filter(), properties => amqp10_client_types:properties(), max_message_size => max_message_size(), handle => output_handle(), footer_opt => footer_opt()}

attach_role()

attach_role() = {sender, target_def()} | {receiver, source_def(), pid()}

filter()

filter() = #{binary() => binary() | map() | [binary()]}

footer_opt()

footer_opt() = crc32 | adler32

link_address()

link_address() = binary()

link_ref()

link_ref() = #link_ref{}

max_message_size()

max_message_size() = undefined | non_neg_integer()

output_handle()

output_handle() = link_handle()

"The remotely chosen handle is referred to as the input handle." [2.6.2]

source_def()

source_def() = #{address => link_address(), durable => terminus_durability()}

target_def()

target_def() = #{address => link_address(), durable => terminus_durability()}

terminus_durability()

terminus_durability() = none | configuration | unsettled_state

transfer_error()

transfer_error() = {error, insufficient_credit | remote_incoming_window_exceeded | message_size_exceeded | link_not_found | half_attached}

Function Index

'begin'/1
'end'/1
attach/2
begin_sent/3
begin_sync/1
begin_sync/2
callback_mode/0
code_change/4
detach/2
disposition/5
end_sent/3
flow/4
format_status/1
init/1
mapped/3
socket_ready/2
start_link/4
terminate/3
transfer/3
unmapped/3

Function Details

'begin'/1

'begin'(Connection::pid()) -> supervisor:startchild_ret()

'end'/1

'end'(Pid::pid()) -> ok

attach/2

attach(Session::pid(), Args::attach_args()) -> {ok, link_ref()}

begin_sent/3

begin_sent(X1, X2, State) -> any()

begin_sync/1

begin_sync(Connection::pid()) -> supervisor:startchild_ret()

begin_sync/2

begin_sync(Connection::pid(), Timeout::non_neg_integer()) -> supervisor:startchild_ret() | session_timeout

callback_mode/0

callback_mode() -> any()

code_change/4

code_change(OldVsn, StateName, State, Extra) -> any()

detach/2

detach(Session::pid(), Handle::output_handle()) -> ok | {error, link_not_found | half_attached}

disposition/5

disposition(Link_ref::link_ref(), First::delivery_number(), Last::delivery_number(), Settled::boolean(), DeliveryState::amqp10_client_types:delivery_state()) -> ok

end_sent/3

end_sent(EvtType, Frame, State) -> any()

flow/4

flow(Session, Handle, Flow, RenewWhenBelow) -> any()

format_status/1

format_status(Status) -> any()

init/1

init(X1) -> any()

mapped/3

mapped(EvtType, Flow, State) -> any()

socket_ready/2

socket_ready(Pid::pid(), Socket::amqp10_client_connection:amqp10_socket()) -> ok

start_link/4

start_link(From, Channel, Reader, ConnConfig) -> any()

terminate/3

terminate(Reason, StateName, State) -> any()

transfer/3

transfer(Session::pid(), Amqp10Msg::amqp10_msg:amqp10_msg(), Timeout::timeout()) -> ok | transfer_error()

unmapped/3

unmapped(X1, X2, State) -> any()


Generated by EDoc