57,7 → 57,7 |
/*@{*/ |
|
/** Finds the packet mapping. |
* @param packet_id The packet identifier to be found. Input parameter. |
* @param[in] packet_id The packet identifier to be found. |
* @returns The found packet reference. |
* @returns NULL if the mapping does not exist. |
*/ |
64,7 → 64,7 |
packet_t pm_find( packet_id_t packet_id ); |
|
/** Adds the packet mapping. |
* @param packet The packet to be remembered. Input parameter. |
* @param[in] packet The packet to be remembered. |
* @returns EOK on success. |
* @returns EINVAL if the packet is not valid. |
* @returns EINVAL if the packet map is not initialized. |
85,10 → 85,10 |
/** Add packet to the sorted queue. |
* The queue is sorted in the ascending order. |
* The packet is inserted right before the packets of the same order value. |
* @param first The first packet of the queue. May be NULL. Input parameter. |
* @param packet The packet to be added. Input parameter. |
* @param order The packet order value. Input parameter. |
* @param metric The metric value of the packet. Input parameter. |
* @param[in] first The first packet of the queue. May be NULL. |
* @param[in] packet The packet to be added. |
* @param[in] order The packet order value. |
* @param[in] metric The metric value of the packet. |
* @returns The first packet of the queue. The original first packet may be shifted by the new packet. |
* @returns NULL if the packet is not valid. |
*/ |
95,8 → 95,8 |
packet_t pq_add( packet_t first, packet_t packet, size_t order, size_t metric ); |
|
/** Finds the packet with the given order. |
* @param first The first packet of the queue. Input parameter. |
* @param order The packet order value. Input parameter. |
* @param[in] first The first packet of the queue. |
* @param[in] order The packet order value. |
* @returns The packet with the given order. |
* @returns NULL if the first packet is not valid. |
* @returns NULL if the packet is not found. |
104,8 → 104,8 |
packet_t pq_find( packet_t first, size_t order ); |
|
/** Inserts packet after the given one. |
* @param packet The packet in the queue. Input parameter. |
* @param new_packet The new packet to be inserted. Input parameter. |
* @param[in] packet The packet in the queue. |
* @param[in] new_packet The new packet to be inserted. |
* @returns EOK on success. |
* @returns EINVAL if etiher of the packets is invalid. |
*/ |
112,7 → 112,7 |
int pq_insert_after( packet_t packet, packet_t new_packet ); |
|
/** Detach the packet from the queue. |
* @param packet The packet to be detached. Input parameter. |
* @param[in] packet The packet to be detached. |
* @returns The next packet in the queue. If the packet is the first one of the queue, this becomes the new first one. |
* @returns NULL if there is no packet left. |
* @returns NULL if the packet is not valid. |
120,9 → 120,9 |
packet_t pq_detach( packet_t packet ); |
|
/** Sets the packet order and metric attributes. |
* @param packet The packet to be set. Input parameter. |
* @param order The packet order value. Input parameter. |
* @param metric The metric value of the packet. Input parameter. |
* @param[in] packet The packet to be set. |
* @param[in] order The packet order value. |
* @param[in] metric The metric value of the packet. |
* @returns EOK on success. |
* @returns EINVAL if the packet is invalid.. |
*/ |
129,9 → 129,9 |
int pq_set_order( packet_t packet, size_t order, size_t metric ); |
|
/** Sets the packet order and metric attributes. |
* @param packet The packet to be set. Input parameter. |
* @param order The packet order value. Output parameter. |
* @param metric The metric value of the packet. Ouput parameter. |
* @param[in] packet The packet to be set. |
* @param[out] order The packet order value. |
* @param[out] metric The metric value of the packet. |
* @returns EOK on success. |
* @returns EINVAL if the packet is invalid.. |
*/ |
139,13 → 139,13 |
|
/** Releases the whole queue. |
* Detaches all packets of the queue and calls the packet_release() for each of them. |
* @param first The first packet of the queue. Input parameter. |
* @param packet_release The releasing function called for each of the packets after its detachment. Input parameter. |
* @param[in] first The first packet of the queue. |
* @param[in] packet_release The releasing function called for each of the packets after its detachment. |
*/ |
void pq_destroy( packet_t first, void ( * packet_release )( packet_t packet )); |
|
/** Returns the next packet in the queue. |
* @param packet The packet queue member. Input parameter. |
* @param[in] packet The packet queue member. |
* @returns The next packet in the queue. |
* @returns NULL if there is no next packet. |
* @returns NULL if the packet is not valid. |
153,7 → 153,7 |
packet_t pq_next( packet_t packet ); |
|
/** Returns the previous packet in the queue. |
* @param packet The packet queue member. Input parameter. |
* @param[in] packet The packet queue member. |
* @returns The previous packet in the queue. |
* @returns NULL if there is no previous packet. |
* @returns NULL if the packet is not valid. |