Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 2.36 KB

AMQP-Receiver.md

File metadata and controls

29 lines (20 loc) · 2.36 KB

AMQP Receiver

AMQP receiver node toolbox

This is node is useful in order to create an AMQP receiver for connecting to an AMQP container (i.e. broker, AMQP server, AMQP router, ...) and start to receive messages.

Configuration

The configuration allows to specify following parameters :

  • Endpoint : the AMQP endpoint configuration node which specifies the AMQP container to connect with this receiver;
  • Address : the AMQP address as source for this receiver node;
  • Autoaccept : this flag specifies if received messages should be automatically accepted. Defaults to true;
  • Credit window : A 'credit' window controlling the flow of messages over this receiver. Defaults to 100 if not specified. A value of 0 can be used to turn of automatic flow control and manage it directly;
  • Dynamic : this flag specifies a request for dynamic creation of a remote node (see AMQP 1.0 specification for more information);
  • Sender settle mode : it specifies the sender settle mode with following possibile values unsettled, settled and mixed as described by the AMQP 1.0 specification;
  • Receiver settle mode : it specifies the receiver settle mode with following possibile values first and second as described by the AMQP 1.0 specification;
  • Durable : it specifies what state of the terminus will be retained durably: the state of durable messages (unsettled_state value), only existence and configuration of the terminus (configuration value), or no state at all (none value);
  • Expiry policy : expiry policy of the source (see AMQP 1.0 specification for more information);
  • Name : name used to identify the node inside the Node-RED flow;

AMQP receiver node

Input/Output

This node provides following input and output :

  • input : a "Node-RED" message with msg.credits = in order to grant credits to the peer for executing manual flow control (when Credit window parameter is set to 0);
  • output : a "Node-RED" message with msg.payload = with a JSON format containing body and optional header, properties, application_properties and so on. This is the received message. The other field is msg.delivery = with a JSON format containing information about delivery on received message (i.e. "tag");