Public API

Public API. More...

Data Structures
struct	qtipContext_t
	Queue context structure. More...

Macros
#define	QTIP_CPP_SUPPORT_START
#define	QTIP_CPP_SUPPORT_END
#define	QTIP_IS_CPP   (0U)
#define	SIZE_TYPE   size_t
	Type for holding the number of items in queue.

Typedefs
typedef size_t	qtipSize_t
	Number of items in queue.

Enumerations
enum	qtipStatus_t {   QTIP_STATUS_OK , QTIP_STATUS_FULL , QTIP_STATUS_EMPTY , QTIP_STATUS_NULL_PTR ,   QTIP_STATUS_INVALID_SIZE , QTIP_STATUS_LOCKED }
	Queue operation status. More...

Functions
qtipStatus_t	qtip_init (qtipContext_t *pContext, void *pQueue, qtipSize_t maxItems, size_t itemSize)
	Initialize queue context.
qtipStatus_t	qtip_put (qtipContext_t *pContext, void *pItem)
	Put an item in a queue.
qtipStatus_t	qtip_pop (qtipContext_t *pContext, void *pItem)
	Extract the next item from the queue.
qtipStatus_t	qtip_peek (qtipContext_t *pContext, void *pBuffer, qtipSize_t *pSize)
	Copies every element of the queue into a buffer.
qtipStatus_t	qtip_purge (qtipContext_t *pContext)
	Removes all the items from the queue.
qtipStatus_t	qtip_get_front (qtipContext_t *pContext, void *pItem)
	Gets the item at the front of the queue.
qtipStatus_t	qtip_get_rear (qtipContext_t *pContext, void *pItem)
	Gets the item at the rear of the queue.
qtipStatus_t	qtip_is_full (qtipContext_t *pContext)
	Checks whether the queue is full.
qtipStatus_t	qtip_is_empty (qtipContext_t *pContext)
	Checks whether the queue is empty.
qtipStatus_t	qtip_count_items (qtipContext_t *pContext, qtipSize_t *pResult)
	Gets the number of items in the queue.
qtipStatus_t	qtip_get_item_index (qtipContext_t *pContext, qtipSize_t index, void *pItem)
	Gets the item from an intex in the queue.
qtipStatus_t	qtip_remove_item_index (qtipContext_t *pContext, qtipSize_t index)
	Removes the item from an intex in the queue.
qtipStatus_t	qtip_get_pop_index (qtipContext_t *pContext, qtipSize_t index, void *pItem)
	Pops the item from an intex in the queue.
qtipStatus_t	qtip_is_locked (qtipContext_t *pContext)
	Checks whether the queue is locked.
qtipStatus_t	qtip_lock (qtipContext_t *pContext)
	Locks the queue.
qtipStatus_t	qtip_unlock (qtipContext_t *pContext)
	Unlocks the queue.
qtipStatus_t	qtip_total_enqueued_items (qtipContext_t *pContext, size_t *pResult)
	Get number of items inserted in the queue.
qtipStatus_t	qtip_total_processed_items (qtipContext_t *pContext, size_t *pResult)
	Get number of processed items in the queue.

Detailed Description

Public API.

---

Data Structure Documentation

qtipContext_t

struct qtipContext_t

Queue context structure.

Definition at line 71 of file qtip.h.

Data Fields
qtipSize_t	maxItems	Number of items allowed in the queue.
qtipSize_t	qty	Current number of items in the queue.
void *	start	Pointer to the start of the queue.
qtipSize_t	front	Absolute index of the front of the queue.
qtipSize_t	rear	Absolute index of the rear of the queue.
size_t	itemSize	Size of each item in the queue.
bool	locked	Lock status.
size_t	processed	Number of items removed from the queue.
size_t	total	Number of items introduced to the queue.

Macro Definition Documentation

QTIP_CPP_SUPPORT_START

#define QTIP_CPP_SUPPORT_START

Definition at line 22 of file qtip.h.

QTIP_CPP_SUPPORT_END

#define QTIP_CPP_SUPPORT_END

Definition at line 23 of file qtip.h.

QTIP_IS_CPP

#define QTIP_IS_CPP   (0U)

Definition at line 24 of file qtip.h.

SIZE_TYPE

#define SIZE_TYPE   size_t

Type for holding the number of items in queue.

Definition at line 37 of file qtip.h.

Typedef Documentation

qtipSize_t

typedef size_t qtipSize_t

Number of items in queue.

Definition at line 45 of file qtip.h.

Enumeration Type Documentation

qtipStatus_t

enum qtipStatus_t

Queue operation status.

Enumerator
QTIP_STATUS_OK	Operation succeded.
QTIP_STATUS_FULL	Queue is full.
QTIP_STATUS_EMPTY	Queue is empty.
QTIP_STATUS_NULL_PTR	Null pointer encountered.
QTIP_STATUS_INVALID_SIZE	Invalid queue size.
QTIP_STATUS_LOCKED	Queue is locked.

Definition at line 54 of file qtip.h.

{
    QTIP_STATUS_OK,           
    QTIP_STATUS_FULL,         
    QTIP_STATUS_EMPTY,        
    QTIP_STATUS_NULL_PTR,     
    QTIP_STATUS_INVALID_SIZE, 
    QTIP_STATUS_LOCKED        
} qtipStatus_t;

Function Documentation

qtip_init()

qtipStatus_t qtip_init	(	qtipContext_t *	pContext,
		void *	pQueue,
		qtipSize_t	maxItems,
		size_t	itemSize
	)

Initialize queue context.

Initializes the queue context struct with default values.

Parameters

[in]	pContext	Pointer to queue context
[in]	pQueue	Pointer to queue in memory.
[in]	maxItems	Maximum number of items allowed in the queue
[in]	itemSize	Size of the item to store in the queue

Note

pQueue must be at least maxItems * itemSize bytes

Returns

Operation status

Returned qtipStatus_t	Reason
QTIP_STATUS_OK	Operation successful
QTIP_STATUS_LOCKED	NA
QTIP_STATUS_NULL_PTR	pContext is NULL
QTIP_STATUS_FULL	NA
QTIP_STATUS_EMPTY	NA
QTIP_STATUS_INVALID_SIZE	itemSize or maxItems is 0

Definition at line 163 of file qtip.c.

{
    qtipStatus_t status = QTIP_STATUS_OK;
 
#ifndef SKIP_ARG_CHECK
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pContext));
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pBuffer));
    status = CHECK_STATUS(status, (maxItems > 0U) ? QTIP_STATUS_OK : QTIP_STATUS_INVALID_SIZE);
    status = CHECK_STATUS(status, (itemSize > 0U) ? QTIP_STATUS_OK : QTIP_STATUS_INVALID_SIZE);
#endif
 
#ifndef DISABLE_LOCK
    status = CHECK_STATUS(status, IS_LOCKED(pContext));
#endif
 
    if (status == QTIP_STATUS_OK)
    {
        pContext->itemSize = itemSize;
        pContext->maxItems = maxItems;
        pContext->start    = pBuffer;
        pContext->front    = 0U;
        pContext->rear     = 0U;
        pContext->qty      = 0U;
#ifndef DISABLE_LOCK
        pContext->locked = false;
#endif
#ifndef DISABLE_TELEMETRY
        pContext->total     = 0U;
        pContext->processed = 0U;
#endif
    }
 
    return status;
}

qtip_put()

qtipStatus_t qtip_put	(	qtipContext_t *	pContext,
		void *	pItem
	)

Put an item in a queue.

Copies the value of pItem to the back of the queue.

Parameters

[in]	pContext	Pointer to queue context
[in]	pItem	Pointer to item to store in the queue

Returns

Operation status

Returned qtipStatus_t	Reason
QTIP_STATUS_OK	Operation successful
QTIP_STATUS_LOCKED	Queue is locked
QTIP_STATUS_NULL_PTR	pContext or pItem is NULL
QTIP_STATUS_FULL	Queue is full
QTIP_STATUS_EMPTY	NA
QTIP_STATUS_INVALID_SIZE	NA

Definition at line 198 of file qtip.c.

{
    qtipStatus_t status = QTIP_STATUS_OK;
 
#ifndef SKIP_ARG_CHECK
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pContext));
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pItem));
#endif
 
#ifndef DISABLE_LOCK
    status = CHECK_STATUS(status, IS_LOCKED(pContext));
#endif
 
    if (status == QTIP_STATUS_OK)
    {
        if (!is_full(pContext))
        {
#ifndef DISABLE_LOCK
            lock_queue(pContext);
#endif
            pContext->rear = move_index(pContext, pContext->rear);
 
            write_item_absolute(pContext, pContext->rear, pItem);
            pContext->qty++;
 
#ifndef DISABLE_TELEMETRY
            pContext->total++;
#endif
 
#ifndef DISABLE_LOCK
            unlock_queue(pContext);
#endif
        }
        else
        {
            status = QTIP_STATUS_FULL;
        }
    }
 
    return status;
}

qtip_pop()

qtipStatus_t qtip_pop	(	qtipContext_t *	pContext,
		void *	pItem
	)

Extract the next item from the queue.

Pulls and removes the the next item in the queue and puts it into pItem.

Parameters

[in]	pContext	Pointer to queue context
[out]	pItem	Pointer to item to store in the queue

Returns

Operation status

Returned qtipStatus_t	Reason
QTIP_STATUS_OK	Operation successful
QTIP_STATUS_LOCKED	Queue is locked
QTIP_STATUS_NULL_PTR	pContext or pItem is NULL
QTIP_STATUS_FULL	NA
QTIP_STATUS_EMPTY	Queue is empty
QTIP_STATUS_INVALID_SIZE	NA

Definition at line 240 of file qtip.c.

{
    qtipStatus_t status = QTIP_STATUS_OK;
 
#ifndef SKIP_ARG_CHECK
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pContext));
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pItem));
#endif
 
#ifndef DISABLE_LOCK
    status = CHECK_STATUS(status, IS_LOCKED(pContext));
#endif
 
    if (status == QTIP_STATUS_OK)
    {
        if (!is_empty(pContext))
        {
#ifndef DISABLE_LOCK
            lock_queue(pContext);
#endif
            read_item_absolute(pContext, pContext->front, pItem);
            delete_item_absolute(pContext, pContext->front);
            pContext->qty--;
 
            pContext->front = move_index(pContext, pContext->front);
 
#ifndef DISABLE_TELEMETRY
            pContext->processed++;
#endif
 
#ifndef DISABLE_LOCK
            unlock_queue(pContext);
#endif
        }
        else
        {
            status = QTIP_STATUS_EMPTY;
        }
    }
 
    return status;
}

qtip_peek()

qtipStatus_t qtip_peek	(	qtipContext_t *	pContext,
		void *	pBuffer,
		qtipSize_t *	pSize
	)

Copies every element of the queue into a buffer.

Reads every item in the queue and stores a copy in pBuffer

Parameters

[in]	pContext	Pointer to queue context
[in]	pBuffer	Pointer to buffer to store the copy of the queue
[out]	pSize	Pointer to variable to store the number of items in the queue

Note

pBuffer should be maxItems * itemSize bytes

Returns

Operation status

Returned qtipStatus_t	Reason
QTIP_STATUS_OK	Operation successful
QTIP_STATUS_LOCKED	Queue is locked
QTIP_STATUS_NULL_PTR	pContext, pItem, or pSIze is NULL
QTIP_STATUS_FULL	NA
QTIP_STATUS_EMPTY	NA
QTIP_STATUS_INVALID_SIZE	NA

Definition at line 283 of file qtip.c.

{
    qtipStatus_t status = QTIP_STATUS_OK;
 
#ifndef SKIP_ARG_CHECK
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pContext));
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pBuffer));
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pSize));
#endif
 
#ifndef DISABLE_LOCK
    status = CHECK_STATUS(status, IS_LOCKED(pContext));
#endif
 
    if (status == QTIP_STATUS_OK)
    {
#ifndef DISABLE_LOCK
        lock_queue(pContext);
#endif
        *pSize = count_items(pContext);
        for (qtipSize_t i = 0U; i < pContext->qty; i++)
        {
            read_item_relative(pContext, i, pBuffer + i * pContext->itemSize);
        }
 
#ifndef DISABLE_LOCK
        unlock_queue(pContext);
#endif
    }
 
    return status;
}

qtip_purge()

qtipStatus_t qtip_purge

(

qtipContext_t *

pContext

)

Removes all the items from the queue.

Deletes the items from the queue and sets the queue in a known state.

Parameters

[in]

pContext

Pointer to queue context

Returns

Operation status

Returned qtipStatus_t	Reason
QTIP_STATUS_OK	Operation successful
QTIP_STATUS_LOCKED	Queue is locked
QTIP_STATUS_NULL_PTR	pContext is NULL
QTIP_STATUS_FULL	NA
QTIP_STATUS_EMPTY	NA
QTIP_STATUS_INVALID_SIZE	NA

Definition at line 316 of file qtip.c.

{
    qtipStatus_t status = QTIP_STATUS_OK;
 
#ifndef SKIP_ARG_CHECK
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pContext));
#endif
 
#ifndef DISABLE_LOCK
    status = CHECK_STATUS(status, IS_LOCKED(pContext));
#endif
 
    if (status == QTIP_STATUS_OK)
    {
#ifndef DISABLE_LOCK
        lock_queue(pContext);
#endif
 
        reset_queue(pContext);
        pContext->qty   = 0U;
        pContext->front = move_index(pContext, pContext->front);
        pContext->rear  = move_index(pContext, pContext->rear);
 
#ifndef DISABLE_LOCK
        unlock_queue(pContext);
#endif
    }
 
    return status;
}

qtip_get_front()

qtipStatus_t qtip_get_front	(	qtipContext_t *	pContext,
		void *	pItem
	)

Gets the item at the front of the queue.

The item at the front of the queue is fetched, but not removed.

Parameters

[in]	pContext	Pointer to queue context
[out]	pItem	Pointer to the item at the front of the queue

Returns

Operation status

Returned qtipStatus_t	Reason
QTIP_STATUS_OK	Operation successful
QTIP_STATUS_LOCKED	Queue is locked
QTIP_STATUS_NULL_PTR	pContext or pItem is NULL
QTIP_STATUS_FULL	NA
QTIP_STATUS_EMPTY	Queue is empty
QTIP_STATUS_INVALID_SIZE	NA

Definition at line 383 of file qtip.c.

{
    qtipStatus_t status = QTIP_STATUS_OK;
 
#ifndef SKIP_ARG_CHECK
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pContext));
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pItem));
#endif
 
#ifndef DISABLE_LOCK
    status = CHECK_STATUS(status, IS_LOCKED(pContext));
#endif
 
    if (status == QTIP_STATUS_OK)
    {
        if (!is_empty(pContext))
        {
#ifndef DISABLE_LOCK
            lock_queue(pContext);
#endif
 
            read_item_absolute(pContext, pContext->front, pItem);
 
#ifndef DISABLE_LOCK
            unlock_queue(pContext);
#endif
        }
        else
        {
            status = QTIP_STATUS_EMPTY;
        }
    }
 
    return status;
}

qtip_get_rear()

qtipStatus_t qtip_get_rear	(	qtipContext_t *	pContext,
		void *	pItem
	)

Gets the item at the rear of the queue.

The item at the rear of the queue is fetched, but not removed.

Parameters

[in]	pContext	Pointer to queue context
[out]	pItem	Pointer to the item at the rear of the queue

Returns

Operation status

Returned qtipStatus_t	Reason
QTIP_STATUS_OK	Operation successful
QTIP_STATUS_LOCKED	Queue is locked
QTIP_STATUS_NULL_PTR	pContext or pItem is NULL
QTIP_STATUS_FULL	NA
QTIP_STATUS_EMPTY	Queue is empty
QTIP_STATUS_INVALID_SIZE	NA

Definition at line 347 of file qtip.c.

{
    qtipStatus_t status = QTIP_STATUS_OK;
 
#ifndef SKIP_ARG_CHECK
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pContext));
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pItem));
#endif
 
#ifndef DISABLE_LOCK
    status = CHECK_STATUS(status, IS_LOCKED(pContext));
#endif
 
    if (status == QTIP_STATUS_OK)
    {
        if (!is_empty(pContext))
        {
#ifndef DISABLE_LOCK
            lock_queue(pContext);
#endif
 
            read_item_absolute(pContext, pContext->rear, pItem);
 
#ifndef DISABLE_LOCK
            unlock_queue(pContext);
#endif
        }
        else
        {
            status = QTIP_STATUS_EMPTY;
        }
    }
 
    return status;
}

qtip_is_full()

qtipStatus_t qtip_is_full

(

qtipContext_t *

pContext

)

Checks whether the queue is full.

Parameters

[in]

pContext

Pointer to queue context

Returns

Operation status

Returned qtipStatus_t	Reason
QTIP_STATUS_OK	Queue is not full
QTIP_STATUS_LOCKED	Queue is locked
QTIP_STATUS_NULL_PTR	pContext is NULL
QTIP_STATUS_FULL	Queue is full
QTIP_STATUS_EMPTY	NA
QTIP_STATUS_INVALID_SIZE	NA

Definition at line 472 of file qtip.c.

{
    qtipStatus_t status = QTIP_STATUS_OK;
 
#ifndef SKIP_ARG_CHECK
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pContext));
#endif
 
    if (status == QTIP_STATUS_OK)
    {
        status = (is_full(pContext)) ? QTIP_STATUS_FULL : QTIP_STATUS_OK;
    }
 
    return status;
}

qtip_is_empty()

qtipStatus_t qtip_is_empty

(

qtipContext_t *

pContext

)

Checks whether the queue is empty.

Parameters

[in]

pContext

Pointer to queue context

Note

This function is part of the extended API

Returns

Operation status

Returned qtipStatus_t	Reason
QTIP_STATUS_OK	Queue is not empty
QTIP_STATUS_LOCKED	Queue is locked
QTIP_STATUS_NULL_PTR	pContext is NULL
QTIP_STATUS_FULL	NA
QTIP_STATUS_EMPTY	Queue is empty
QTIP_STATUS_INVALID_SIZE	NA

Definition at line 488 of file qtip.c.

{
    qtipStatus_t status = QTIP_STATUS_OK;
 
#ifndef SKIP_ARG_CHECK
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pContext));
#endif
 
    if (status == QTIP_STATUS_OK)
    {
        status = (is_empty(pContext)) ? QTIP_STATUS_FULL : QTIP_STATUS_OK;
    }
 
    return status;
}

qtip_count_items()

qtipStatus_t qtip_count_items	(	qtipContext_t *	pContext,
		qtipSize_t *	pResult
	)

Gets the number of items in the queue.

Parameters

[in]	pContext	Pointer to queue context
[out]	pResult	Pointer to the variable to hold the result

Returns

Operation status

Returned qtipStatus_t	Reason
QTIP_STATUS_OK	Operation successful
QTIP_STATUS_LOCKED	NA
QTIP_STATUS_NULL_PTR	pContext is NULL
QTIP_STATUS_FULL	NA
QTIP_STATUS_EMPTY	NA
QTIP_STATUS_INVALID_SIZE	NA

Definition at line 504 of file qtip.c.

{
    qtipStatus_t status = QTIP_STATUS_OK;
 
#ifndef SKIP_ARG_CHECK
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pContext));
#endif
 
    if (status == QTIP_STATUS_OK)
    {
        *pResult = count_items(pContext);
    }
 
    return status;
}

qtip_get_item_index()

qtipStatus_t qtip_get_item_index	(	qtipContext_t *	pContext,
		qtipSize_t	index,
		void *	pItem
	)

Gets the item from an intex in the queue.

Returns the item in the requested position, where index = 0 results in the item at the front of the queue.

Parameters

[in]	pContext	Pointer to queue context
[in]	index	Item index relative to the front of the queue (0 -> front)
[out]	pItem	Pointer to the variable to hold the result

Returns

Operation status

Returned qtipStatus_t	Reason
QTIP_STATUS_OK	Operation successful
QTIP_STATUS_LOCKED	Queue is locked
QTIP_STATUS_NULL_PTR	pContext or pItem is NULL
QTIP_STATUS_FULL	NA
QTIP_STATUS_EMPTY	NA
QTIP_STATUS_INVALID_SIZE	Index unavailable

Definition at line 520 of file qtip.c.

{
    qtipStatus_t status = QTIP_STATUS_OK;
 
#ifndef SKIP_ARG_CHECK
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pContext));
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pItem));
#endif
 
#ifndef DISABLE_LOCK
    status = CHECK_STATUS(status, IS_LOCKED(pContext));
#endif
 
    status = CHECK_STATUS(status, (index <= pContext->qty) ? QTIP_STATUS_OK : QTIP_STATUS_INVALID_SIZE);
 
    if (status == QTIP_STATUS_OK)
    {
        read_item_relative(pContext, index, pItem);
    }
 
    return status;
}

qtip_remove_item_index()

qtipStatus_t qtip_remove_item_index	(	qtipContext_t *	pContext,
		qtipSize_t	index
	)

Removes the item from an intex in the queue.

Removes the item in the requested position, where index = 0 is the item at the front of the queue.

Parameters

[in]	pContext	Pointer to queue context
[in]	index	Item index relative to the front of the queue (0 -> front)

Returns

Operation status

Returned qtipStatus_t	Reason
QTIP_STATUS_OK	Operation successful
QTIP_STATUS_LOCKED	Queue is locked
QTIP_STATUS_NULL_PTR	pContext is NULL
QTIP_STATUS_FULL	NA
QTIP_STATUS_EMPTY	NA
QTIP_STATUS_INVALID_SIZE	Index unavailable

Definition at line 543 of file qtip.c.

{
    qtipStatus_t status = QTIP_STATUS_OK;
 
#ifndef SKIP_ARG_CHECK
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pContext));
#endif
 
#ifndef DISABLE_LOCK
    status = CHECK_STATUS(status, IS_LOCKED(pContext));
#endif
 
    status = CHECK_STATUS(status, (index <= pContext->qty) ? QTIP_STATUS_OK : QTIP_STATUS_INVALID_SIZE);
 
    if (status == QTIP_STATUS_OK)
    {
        delete_item_relative(pContext, index);
        sweep_items(pContext, index);
        pContext->qty--;
    }
 
    return status;
}

qtip_get_pop_index()

qtipStatus_t qtip_get_pop_index	(	qtipContext_t *	pContext,
		qtipSize_t	index,
		void *	pItem
	)

Pops the item from an intex in the queue.

Returns and removes the item in the requested position, where index = 0 is the item at the front of the queue.

Parameters

[in]	pContext	Pointer to queue context
[in]	index	Item index relative to the front of the queue (0 -> front)
[out]	pItem	Pointer to the variable to hold the result

Returns

Operation status

Returned qtipStatus_t	Reason
QTIP_STATUS_OK	Operation successful
QTIP_STATUS_LOCKED	Queue is locked
QTIP_STATUS_NULL_PTR	pContext or pItem is NULL
QTIP_STATUS_FULL	NA
QTIP_STATUS_EMPTY	NA
QTIP_STATUS_INVALID_SIZE	Index unavailable

Definition at line 567 of file qtip.c.

{
    qtipStatus_t status = QTIP_STATUS_OK;
 
#ifndef SKIP_ARG_CHECK
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pContext));
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pItem));
#endif
 
#ifndef DISABLE_LOCK
    status = CHECK_STATUS(status, IS_LOCKED(pContext));
#endif
 
    status = CHECK_STATUS(status, (index <= pContext->qty) ? QTIP_STATUS_OK : QTIP_STATUS_INVALID_SIZE);
 
    if (status == QTIP_STATUS_OK)
    {
        read_item_relative(pContext, index, pItem);
        delete_item_relative(pContext, index);
        sweep_items(pContext, index);
        pContext->qty--;
    }
 
    return status;
}

qtip_is_locked()

qtipStatus_t qtip_is_locked

(

qtipContext_t *

pContext

)

Checks whether the queue is locked.

Deletes the items from the queue and sets the queue in a known state.

Parameters

[in]

pContext

Pointer to queue context

Returns

Operation status

Returned qtipStatus_t	Reason
QTIP_STATUS_OK	Queue is not locked
QTIP_STATUS_LOCKED	Queue is locked
QTIP_STATUS_NULL_PTR	pContext is NULL
QTIP_STATUS_FULL	NA
QTIP_STATUS_EMPTY	NA
QTIP_STATUS_INVALID_SIZE	NA

Definition at line 421 of file qtip.c.

{
    qtipStatus_t status = QTIP_STATUS_OK;
 
#ifndef SKIP_ARG_CHECK
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pContext));
#endif
 
    if (status == QTIP_STATUS_OK)
    {
        status = IS_LOCKED(pContext);
    }
 
    return status;
}

qtip_lock()

qtipStatus_t qtip_lock

(

qtipContext_t *

pContext

)

Locks the queue.

Parameters

[in]

pContext

Pointer to queue context

Returns

Operation status

Returned qtipStatus_t	Reason
QTIP_STATUS_OK	Operation successful
QTIP_STATUS_LOCKED	NA
QTIP_STATUS_NULL_PTR	pContext is NULL
QTIP_STATUS_FULL	NA
QTIP_STATUS_EMPTY	NA
QTIP_STATUS_INVALID_SIZE	NA

Definition at line 437 of file qtip.c.

{
    qtipStatus_t status = QTIP_STATUS_OK;
 
#ifndef SKIP_ARG_CHECK
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pContext));
#endif
 
    if (status == QTIP_STATUS_OK)
    {
        lock_queue(pContext);
    }
 
    return status;
}

qtip_unlock()

qtipStatus_t qtip_unlock

(

qtipContext_t *

pContext

)

Unlocks the queue.

Parameters

[in]

pContext

Pointer to queue context

Returns

Operation status

Returned qtipStatus_t	Reason
QTIP_STATUS_OK	Operation successful
QTIP_STATUS_LOCKED	NA
QTIP_STATUS_NULL_PTR	pContext is NULL
QTIP_STATUS_FULL	NA
QTIP_STATUS_EMPTY	NA
QTIP_STATUS_INVALID_SIZE	NA

Definition at line 453 of file qtip.c.

{
    qtipStatus_t status = QTIP_STATUS_OK;
 
#ifndef SKIP_ARG_CHECK
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pContext));
#endif
 
    if (status == QTIP_STATUS_OK)
    {
        unlock_queue(pContext);
    }
 
    return status;
}

qtip_total_enqueued_items()

qtipStatus_t qtip_total_enqueued_items	(	qtipContext_t *	pContext,
		size_t *	pResult
	)

Get number of items inserted in the queue.

The result considers the all-time number of inserted items.

Parameters

[in]	pContext	Pointer to queue context
[out]	pResult	Pointer to variable to hold the result

Returns

Operation status

Returned qtipStatus_t	Reason
QTIP_STATUS_OK	Operation successful
QTIP_STATUS_LOCKED	NA
QTIP_STATUS_NULL_PTR	pContext or pResult is NULL
QTIP_STATUS_FULL	NA
QTIP_STATUS_EMPTY	NA
QTIP_STATUS_INVALID_SIZE	NA

Definition at line 597 of file qtip.c.

{
    qtipStatus_t status = QTIP_STATUS_OK;
 
#ifndef SKIP_ARG_CHECK
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pContext));
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pResult));
#endif
 
    if (status == QTIP_STATUS_OK)
    {
        *pResult = pContext->total;
    }
 
    return status;
}

qtip_total_processed_items()

qtipStatus_t qtip_total_processed_items	(	qtipContext_t *	pContext,
		size_t *	pResult
	)

Get number of processed items in the queue.

The result considers the all-time number of popped items.

Parameters

[in]	pContext	Pointer to queue context
[out]	pResult	Pointer to variable to hold the result

Returns

Operation status

Returned qtipStatus_t	Reason
QTIP_STATUS_OK	Operation successful
QTIP_STATUS_LOCKED	NA
QTIP_STATUS_NULL_PTR	pContext or pResult is NULL
QTIP_STATUS_FULL	NA
QTIP_STATUS_EMPTY	NA
QTIP_STATUS_INVALID_SIZE	NA

Definition at line 614 of file qtip.c.

{
    qtipStatus_t status = QTIP_STATUS_OK;
 
#ifndef SKIP_ARG_CHECK
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pContext));
    status = CHECK_STATUS(status, CHECK_NULL_PRT(pResult));
#endif
 
    if (status == QTIP_STATUS_OK)
    {
        *pResult = pContext->processed;
    }
 
    return status;
}