Function Documentation

[since Qt Quick Ultralite (Platform) 1.9] void deleteQueue(Qul::Platform::MessageQueueInterface *queue)

Deletes the queue.

This function is used by MessageQueue to delete a queue when it is not needed anymore.

Here is an example implementation of this function:

void deleteQueue(MessageQueueInterface *queue)
{
    MyMessageQueue *mq = static_cast<MyMessageQueue *>(queue);
    mq->~MyMessageQueue();
    qul_free(mq);
}

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

See also requestQueue(), maximumQueueMessageSize(), Qul::Platform::MessageQueue, and Qul::Platform::MessageQueueInterface.

Qul::Platform::DeviceLinkInterface *Platform::getDeviceLinkInterface()

Provides the device link interface implementation for the platform.

If there is no such imlementation the function can return nullptr. But ideally, when the device link is not compiled in, this function should not be called at all.

See also QUL_PLATFORM_DEVICELINK_ENABLED.

[since Qt Quick Ultralite (Platform) 2.0] Qul::Platform::PlatformContext *getPlatformInstance()

Returns hardware specific platform context instance.

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

[since Qt Quick Ultralite (Platform) 1.9] std::size_t maximumQueueMessageSize()

Returns the maximum size of a message that a queue can hold. If the queue's maximum message size is not known or is arbitrary, SIZE_MAX must be returned.

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

See also requestQueue(), Qul::Platform::MessageQueue, and Qul::Platform::MessageQueueInterface.

[since Qt Quick Ultralite (Platform) 1.5] void printHeapStats()

Print heap usage statistics to stderr.

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

[since Qt Quick Ultralite (Platform) 1.5] void printStackStats()

Print stack usage statistics to stderr.

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

[since Qt Quick Ultralite (Platform) 1.5] void qul_free(void *ptr)

Frees a memory block allocated by qul_malloc.

ptr is the pointer to the memory block to be freed.

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

See also Qul::Platform::qul_malloc(std::size_t size) and Qul::Platform::qul_realloc(void *ptr, std::size_t new_size).

[since Qt Quick Ultralite (Platform) 1.5] void *qul_malloc(std::size_t size)

Allocates memory in the way optimal for the platform.

size is the size of the requested block of memory, in bytes.

All of Qt Quick Ultralite performs dynamic memory allocation through this function.

Memory allocated using this function must be freed using qul_free. Resizing the memory block that was allocated can also be done using qul_realloc.

Might return NULL if there is not sufficient memory to satisfy the request.

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

See also Qul::Platform::qul_free(void *ptr) and Qul::Platform::qul_realloc(void *ptr, std::size_t new_size).

[since Qt Quick Ultralite (Platform) 1.5] void *qul_realloc(void *ptr, std::size_t new_size)

Attempt to resize a memory block allocated with qul_malloc.

ptr is the pointer the the previously allocated memory block, and new_size is the new size for the memory block, in bytes.

Might return NULL if there is not sufficient memory to satisfy the request.

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

See also Qul::Platform::qul_malloc(std::size_t size) and Qul::Platform::qul_free(void *ptr).

[since Qt Quick Ultralite (Platform) 1.9] Qul::Platform::MessageQueueInterface *requestQueue(std::size_t queueCapacity, std::size_t messageSize)

Returns an instance of the MessageQueueInterface implementation with queueCapacity capacity. The queue must accept messages that satisfies the messageSize requirement. If the implementation can't satisfy the queueCapacity or messageSize, the function must return a null pointer.

This function is used by MessageQueue to get an appropriate queue for its use.

Here is an example implementation of this function:

MessageQueueInterface *requestQueue(size_t queueCapacity, size_t messageSize)
{
    void *queue = qul_malloc(sizeof(MyMessageQueue));

    if (queue == NULL) {
        return NULL;
    }

    MessageQueueInterface *interface = new (queue) MyMessageQueue(queueCapacity, messageSize);
    return interface;
}

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

See also deleteQueue(), maximumQueueMessageSize(), Qul::Platform::MessageQueue, and Qul::Platform::MessageQueueInterface.