Waits to read an element from a Messenger channel.


icon

Inputs/Outputs

  • ci32.png timeout in ms (-1)

    timeout in ms is the time, in milliseconds, that this endpoint has to read the elements from the channel. The default value is -1, which means there is no time limit.

  • cqueuern.png channel

    channel is the channel wire that connects this endpoint to a writer endpoint.

  • cu32.png ack id (0)

    ack id specifies the ID number of a message to be acknowledged. This input allows the endpoint to acknowledge receiving the previous message. Use this input as an alternative to the Write Ack endpoint to enable acknowledgement in the channel. You can use Write Ack on every iteration after reading a message, or you can use this input so that the reader endpoint both acknowledges the previous message and reads the next message. The default is 0.

  • ibool.png timed out?

    timed out? returns TRUE if the amount of time specified by timeout in ms elapses.

  • icclst.png element

    element returns the data to read from the channel.

  • iChannel_Messagelvclass.png MessageAckBase.lvclass

  • ii32.png remaining

    remaining returns the number of elements that remain in the channel after this read operation.