IPWorks IoT 2020 Python Edition

Questions / Feedback?

fetch_message Method

Fetches a single message over the specified receiver link.

Syntax

def fetch_message(link_name: str) -> None: ...

Remarks

When fetch_message is called, the class will supply the sender with a single credit and then block until a message is received (if the fetch_timeout property is set to zero).

If fetch_timeout is non-zero, the class will only block for the specified number of seconds; once that time expires, it will instruct the sender to consume the credit. If the sender chooses to consume the credit by incrementing the value of the LinkDeliveryCount property rather than by sending a message, then the class will throw an error indicating a timeout.

LinkName specifies the receiver link which should fetch a message; if there is no such link, if the specified link is not a receiver link, or if the specified receiver link is not operating in rmSyncGet (1) mode, an error is thrown.

Refer to receive_mode and fetch_timeout for more information.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks IoT 2020 Python Edition - Version 20.0 [Build 8265]