LinkReadyToSend Property

Whether this link is ready to send a message.

Syntax

 amqp.getLinkReadyToSend(index, [callback])

Default Value

FALSE

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 getLinkReadyToSend([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 setLinkReadyToSend([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

Whether this link is ready to send a message.

This property reflects whether this link is currently ready to send a message or not; it always returns False if LinkRole is lrReceiver (1).

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

Boolean