cli_proton_python.receiver module

Proton reactive API python reciever client

class cli_proton_python.receiver.Recv(opts, prefetch=None)

Bases: cli_proton_python.coreclient.CoreClient

Proton reactive API python receiver client

implements various handler methods for reactor events triggered by proton.reactor

check_empty(event)

checks whether there are messages to dispatch

Parameters:event (proton.Event) – reactor event

do_message_action(delivery)

performs requested action on received message

Parameters:delivery (proton.Delivery) – delivery disposition

on_connection_opened(event)

called when connection is opened

Parameters:event (proton.Event) – reactor event

on_delivery(event)

called when a message is delivered

Parameters:event (proton.Event) – reactor event

on_link_flow(event)

called on link flow

Parameters:event (proton.Event) – reactor event

on_link_opened(event)

called when link is opened

Parameters:event (proton.Event) – reactor event

on_message(event)

called when a message is received

Parameters:event (proton.Event) – reactor event

on_settled(event)

called when the remote peer has settled the outgoing message this is the point at which it should never be retransmitted

Parameters:event (proton.Event) – reactor event

on_start(event)

called when the event loop starts, creates a receiver for given url

Parameters:event (proton.Event) – reactor event

parse_link_options()

Prepare link options

Returns:list of link options Return type:list

process_reply_to(event)

sends received message to reply to address

Parameters:event (proton.Event) – reactor event

tear_down(event, settled=False)

tears down and closes the connection

Parameters:

• event (proton.Event) – reactor event
• settled (bool) – indicates whether all messages has been explicitly settled

class cli_proton_python.receiver.Timeout(parent, event)

Bases: object

Scheduler object for timeout control

on_timer_task(_)

on_timer_task action handler

if it’s time to close, so no new messages arrived in time, close connection

class cli_proton_python.receiver.TxRecv(opts)

Bases: cli_proton_python.receiver.Recv, proton.handlers.TransactionHandler

Proton reactive API python transactional receiver client

implements various handler methods for reactor events triggered by proton.reactor

is_empty(event)

check if queue is empty

Parameters:event (proton.Event) – reactor event Returns:True if the source is empty, False otherwise Return type:bool

on_delivery(event)

called when a message is delivered

Parameters:event (proton.Event) – reactor event

on_disconnected(_)

called when the transaction is disconnected

on_message(event)

called when a message is received

Parameters:event (proton.Event) – reactor event

on_start(event)

called when the event loop starts, creates a transactional receiver for given url

Parameters:event (proton.Event) – reactor event

on_transaction_aborted(event)

called when the transaction is aborted

Parameters:event (proton.Event) – reactor event

on_transaction_committed(event)

called when the transaction is committed

Parameters:event (proton.Event) – reactor event

on_transaction_declared(event)

called when the transaction is declared

Parameters:event (proton.Event) – reactor event

transaction_finish(event)

finish transaction, do tranaction action, process reporting and control options

Parameters:event (proton.Event) – reactor event

transaction_process(event)

transactionally receive a message, process reporting and control options

Parameters:event (proton.Event) – reactor event

cli_proton_python.receiver.main()

main loop