IPWorks MQ 2020 Node.js Edition

Questions / Feedback?

LinkReceiveMode Property

The receive mode this link is operating in.

Syntax

 amqp.getLinkReceiveMode(index, [callback])

Possible Values

  0 (lrmAutomatic), 
  1 (lrmFetch)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getLinkReceiveMode([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setLinkReceiveMode([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The receive mode this link is operating in.

This property reflects the receive mode which this link is operating in, if it is a receiver link. (For sender links, this property's value means nothing.) Values can be:

  • lrmAutomatic - Messages will be received automatically
  • lrmFetch - One message will be received after each call to the FetchMessage method.

Refer to ReceiveMode for more information.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is read-only and not available at design time.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks MQ 2020 Node.js Edition - Version 20.0 [Build 8155]