Member Function Documentation

[since Qt Quick Ultralite (Platform) 1.9] MessageQueue::MessageQueue()

Constructs MessageQueue and requests a Qul::Platform::MessageQueueInterface implementation for the specified capacity. It uses MessageType's size as the messageSize.

This function was introduced in Qt Quick Ultralite (Platform) 1.9.

See also ~MessageQueue() and Qul::Platform::requestQueue().

[since Qt Quick Ultralite (Platform) 1.9] MessageQueue::~MessageQueue()

Destructs the MessageQueue instance.

This function was introduced in Qt Quick Ultralite (Platform) 1.9.

See also MessageQueue().

[since Qt Quick Ultralite (Platform) 1.9] uint32_t MessageQueue::capacity() const

Returns the maximum number of items the queue can hold.

This function was introduced in Qt Quick Ultralite (Platform) 1.9.

See also MessageQueueInterface::capacity().

[since Qt Quick Ultralite (Platform) 1.9] void MessageQueue::clearOverrun()

Clears implementation's overrun flag.

This function was introduced in Qt Quick Ultralite (Platform) 1.9.

See also MessageQueueInterface::clearOverrun() and isOverrun().

[since Qt Quick Ultralite (Platform) 1.9] bool MessageQueue::discardSupported() const

Returns true if the implementation supports discarding.

This function was introduced in Qt Quick Ultralite (Platform) 1.9.

See also MessageQueueInterface::discardSupported(), overwriteSupported(), enqueueOrDiscard(), and enqueueOrDiscardFromInterrupt().

[since Qt Quick Ultralite (Platform) 1.9] Qul::Platform::MessageQueueStatus MessageQueue::enqueueOrDiscard(const MessageType *message)

Adds message to the queue or discards it if the queue is full. Returns MessageQueueStatus indicating the result of the function call.

This function was introduced in Qt Quick Ultralite (Platform) 1.9.

See also MessageQueueInterface::enqueueOrDiscard(), enqueueOrDiscardFromInterrupt(), discardSupported(), receive(), receiveFromInterrupt(), and enqueueOrOverwrite().

[since Qt Quick Ultralite (Platform) 1.9] Qul::Platform::MessageQueueStatus MessageQueue::enqueueOrDiscardFromInterrupt(const MessageType *message)

Interrupt-safe version of enqueueOrDiscard().

This function was introduced in Qt Quick Ultralite (Platform) 1.9.

See also MessageQueueInterface::enqueueOrDiscardFromInterrupt(), enqueueOrDiscard(), discardSupported(), receive(), receiveFromInterrupt(), and enqueueOrOverwriteFromInterrupt().

[since Qt Quick Ultralite (Platform) 1.9] Qul::Platform::MessageQueueStatus MessageQueue::enqueueOrOverwrite(const MessageType *message)

Adds message or overwrites the oldest item in the queue if the queue is full. Returns MessageQueueStatus indicating the result of the function call.

This function was introduced in Qt Quick Ultralite (Platform) 1.9.

See also MessageQueueInterface::enqueueOrOverwrite(), enqueueOrOverwriteFromInterrupt(), overwriteSupported(), receive(), receiveFromInterrupt(), and enqueueOrDiscard().

[since Qt Quick Ultralite (Platform) 1.9] Qul::Platform::MessageQueueStatus MessageQueue::enqueueOrOverwriteFromInterrupt(const MessageType *message)

Interrupt-safe version of enqueueOrOverwrite().

This function was introduced in Qt Quick Ultralite (Platform) 1.9.

See also MessageQueueInterface::enqueueOrOverwriteFromInterrupt(), enqueueOrOverwrite(), overwriteSupported(), receive(), receiveFromInterrupt(), and enqueueOrDiscardFromInterrupt().

[since Qt Quick Ultralite (Platform) 1.9] bool MessageQueue::isEmpty() const

Returns true if the queue is empty, or false otherwise.

This function was introduced in Qt Quick Ultralite (Platform) 1.9.

See also MessageQueueInterface::isEmpty() and isEmptyFromInterrupt().

[since Qt Quick Ultralite (Platform) 1.9] bool MessageQueue::isEmptyFromInterrupt() const

Returns true if the queue is empty, or false otherwise. It is similar to isEmpty() but interrupt-safe.

This function was introduced in Qt Quick Ultralite (Platform) 1.9.

See also MessageQueueInterface::isEmptyFromInterrupt() and isEmpty().

[since Qt Quick Ultralite (Platform) 1.9] bool MessageQueue::isOverrun() const

Returns true if the implementation's queue is overrun by items that are either discarded or overwritten.

This function was introduced in Qt Quick Ultralite (Platform) 1.9.

See also MessageQueueInterface::isOverrun() and clearOverrun().

[since Qt Quick Ultralite (Platform) 1.9] bool MessageQueue::overwriteSupported() const

Returns true if the implementation supports overwriting.

This function was introduced in Qt Quick Ultralite (Platform) 1.9.

See also MessageQueueInterface::overwriteSupported(), discardSupported(), enqueueOrOverwrite(), and enqueueOrOverwriteFromInterrupt().

[since Qt Quick Ultralite (Platform) 1.9] Qul::Platform::MessageQueueStatus MessageQueue::receive(MessageType *message, int32_t timeout = 0)

Returns the first message from the queue. If timeout is specified, the function blocks for timeout milliseconds. A zero timeout value means that the function does not block at all, and a negative value means that the function waits infinitely.

message must be a pointer to a location that can hold the entire MessageType. The message from the queue will be written using memcpy (or an equivalent function) to the location pointed by message.

This function was introduced in Qt Quick Ultralite (Platform) 1.9.

See also MessageQueueInterface::receive(), receiveFromInterrupt(), enqueueOrDiscard(), enqueueOrDiscardFromInterrupt(), enqueueOrOverwrite(), and enqueueOrOverwriteFromInterrupt().

[since Qt Quick Ultralite (Platform) 1.9] Qul::Platform::MessageQueueStatus MessageQueue::receiveFromInterrupt(MessageType *message, int32_t timeout = 0)

Interrupt-safe version of receive().

message must be a pointer to a location that can hold the entire MessageType. The message from the queue will be written using memcpy (or an equivalent function) to the location pointed by message.

This function was introduced in Qt Quick Ultralite (Platform) 1.9.

See also MessageQueueInterface::receiveFromInterrupt(), receive(), enqueueOrDiscard(), enqueueOrDiscardFromInterrupt(), enqueueOrOverwrite(), and enqueueOrOverwriteFromInterrupt().