mirror of
https://gitlab.com/d3tn/ud3tn.git
synced 2026-08-13 12:33:27 +02:00
6880b22b90
Previously the maximum waiting time was just over 24 days. In a DTN setup we may want to wait longer, e.g., for contacts to occur. This allows for waiting about 292 years. If the provided delay exceeds this threshold, an infinite delay is assumed. Signed-off-by: Felix Walter <felix.walter@d3tn.com>
102 lines
3.5 KiB
C
102 lines
3.5 KiB
C
// SPDX-License-Identifier: BSD-3-Clause OR Apache-2.0
|
|
/*
|
|
* hal_queue.h
|
|
*
|
|
* Description: contains the definitions of the hardware abstraction
|
|
* layer interface for queue-related functionality
|
|
*
|
|
*/
|
|
|
|
#ifndef HAL_QUEUE_H_INCLUDED
|
|
#define HAL_QUEUE_H_INCLUDED
|
|
|
|
#include "platform/hal_types.h"
|
|
|
|
#include "ud3tn/result.h"
|
|
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
|
|
/**
|
|
* @brief hal_queue_create Creates a new channel for inter-task communication
|
|
* @param queueLength The maximum number of items than can be stored inside
|
|
* the queue
|
|
* @param itemSize The size of one item in bytes
|
|
* @return A queue identifier
|
|
*/
|
|
QueueIdentifier_t hal_queue_create(int queue_length, int item_size);
|
|
|
|
|
|
/**
|
|
* @brief hal_queue_delete Deletes a specified queue and frees its memory
|
|
* @param queue The queue that should be deleted
|
|
*/
|
|
void hal_queue_delete(QueueIdentifier_t queue);
|
|
|
|
/**
|
|
* @brief hal_queue_push_to_back Attach a given item to the back of the queue.
|
|
* Has blocking behaviour, i.e. tries to insert
|
|
* the element in the underlying OS structure
|
|
* indefinitely
|
|
* @param queue The identifier of the Queue that the element should be
|
|
* inserted
|
|
* @param item The target item
|
|
*/
|
|
void hal_queue_push_to_back(QueueIdentifier_t queue, const void *item);
|
|
|
|
/**
|
|
* @brief hal_queue_try_push_to_back Attach a given item to the back of the
|
|
* queue.
|
|
* Has blocking behaviour, i.e. tries to insert
|
|
* the element in the underlying OS structure
|
|
* indefinitely
|
|
* @param queue The identifier of the Queue that the element should be
|
|
* inserted
|
|
* @param item The target item
|
|
* @param timeout After which time (in milliseconds) the "push attempt"
|
|
* should be aborted.
|
|
* If this value is -1 or larger than 9223372036854, pushing
|
|
* will block indefinitely (see hal_semaphore_try_take)
|
|
* @return Whether the attachment attempt was successful
|
|
*/
|
|
enum ud3tn_result hal_queue_try_push_to_back(QueueIdentifier_t queue,
|
|
const void *item,
|
|
int64_t timeout);
|
|
|
|
/**
|
|
* @brief hal_queue_override_to_back Attach a given item to the back of the
|
|
* queue. If there is no space available, override
|
|
* previous elements
|
|
* @param queue The identifier of the Queue that the element should be
|
|
* inserted
|
|
* @param item The target item
|
|
* @return Whether the attachment attempt was successful --> that is per
|
|
* functionality of this function always true!
|
|
*/
|
|
enum ud3tn_result hal_queue_override_to_back(QueueIdentifier_t queue,
|
|
const void *item);
|
|
|
|
/**
|
|
* @brief hal_queue_receive Receive a item from the specific queue
|
|
* Has blocking behaviour!
|
|
* @param queue The identifier of the Queue that the element should be read
|
|
* from
|
|
* @param targetBuffer A pointer to the memory where the received item should
|
|
* be stored
|
|
* @param timeout After which time (in milliseconds) the receiving attempt
|
|
* should be aborted.
|
|
* If this value is -1 or larger than 9223372036854, receiving
|
|
* will block indefinitely (see hal_semaphore_try_take)
|
|
* @return Whether the receiving was successful
|
|
*/
|
|
enum ud3tn_result hal_queue_receive(QueueIdentifier_t queue,
|
|
void *targetBuffer,
|
|
int64_t timeout);
|
|
|
|
/**
|
|
* @brief hal_queue_reset Reset (i.e. empty) the specific queue
|
|
* @param queue The queue that should be cleared
|
|
*/
|
|
void hal_queue_reset(QueueIdentifier_t queue);
|
|
|
|
#endif /* HAL_QUEUE_H_INCLUDED */
|