port_queue.h

Go to the documentation of this file.

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef __PORT_QUEUE_H__
#define __PORT_QUEUE_H__

#include <stdbool.h>
#include <inttypes.h>

#include "rofl.h"
#include "platform/lock.h"

#define PORT_QUEUE_MAX_LEN_NAME 32

//Opaque platform queue state (to be used, maybe, for platform hooks)
typedef void platform_queue_state_t;

typedef struct queue_stats {
        uint64_t tx_packets;    /* Number of transmitted packets by the queue. */
        uint64_t tx_bytes;      /* Number of transmitted bytes by the queue. */
        uint64_t overrun;       /* Number of packets dropped due to overrun. */
        
        //Mutex for statistics
        platform_mutex_t* mutex;
}queue_stats_t;


typedef struct port_queue{

        bool set; //Signal if queue is set (running or used)
        
        uint32_t id; 
                
        char name[PORT_QUEUE_MAX_LEN_NAME];

        uint16_t length;

        uint16_t min_rate;

        uint16_t max_rate;

        queue_stats_t stats;

        /* Opaque platform queue specific extra state */
        platform_queue_state_t* platform_queue_state; 
}port_queue_t;


/* 
* Functions
*/

//C++ extern C
ROFL_BEGIN_DECLS

/*
* @brief Init a port_queue structure.
* @ingroup  mgmt
*/
rofl_result_t __port_queue_init(port_queue_t* queue, uint32_t id, char* name, uint16_t length, uint16_t min_rate, uint16_t max_rate);

/*
* @brief Destroy a port_queue structure
* @ingroup  mgmt
*/
rofl_result_t __port_queue_destroy(port_queue_t* queue);

//C++ extern C
ROFL_END_DECLS

#endif //PORT_QUEUE