packet_list.h

[詳解]

 
#ifndef PACKET_LIST_H_
#define PACKET_LIST_H_
 
#include <stddef.h>
 
#include "common_cmd_packet.h"
#include "block_command_table.h"
 
 
// 自己参照用
typedef struct PL_Node PL_Node;
 
 
typedef enum
{
  PL_PACKET_TYPE_CTCP,    
  PL_PACKET_TYPE_CTP,     
  PL_PACKET_TYPE_CCP,     
  PL_PACKET_TYPE_OTHER    
} PL_PACKET_TYPE;
 
typedef enum
{
  PL_SUCCESS,            
  PL_LIST_FULL,          
  PL_LIST_EMPTY,         
  PL_PACKET_TYPE_ERR,    
  PL_TLC_PAST_TIME,      
  PL_TLC_ALREADY_EXISTS, 
  PL_TLC_ON_TIME,        
  PL_TLC_NOT_YET,        
  PL_BC_INACTIVE_BLOCK,  
  PL_BC_LIST_CLEARED,    
  PL_BC_TIME_ADJUSTED,   
  PL_NO_SUCH_NODE        
} PL_ACK;
 
struct PL_Node
{
  void* packet;           
  struct PL_Node* next;   
};
 
typedef struct
{
  uint16_t total_nodes_;        
  uint32_t executed_nodes_;     
  uint16_t active_nodes_;       
  uint16_t packet_size_;        
  PL_PACKET_TYPE packet_type_;  
 
  PL_Node* pl_node_stock_;      
  void*    packet_stock_;       
  PL_Node* inactive_list_head_; 
  PL_Node* active_list_head_;   
  PL_Node* active_list_tail_;   
} PacketList;
 
 
PL_ACK PL_initialize(PL_Node* pl_node_stock,
                     void* packet_stock,
                     uint16_t node_num,
                     PL_PACKET_TYPE packet_type,
                     uint16_t packet_size,
                     PacketList* pl);
 
void PL_clear_list(PacketList* pl);
 
uint32_t PL_count_executed_nodes(const PacketList* pl);
 
uint16_t PL_count_active_nodes(const PacketList* pl);
 
uint16_t PL_count_inactive_nodes(const PacketList* pl);
 
uint16_t PL_get_total_node_num(const PacketList* pl);
 
uint16_t PL_get_packet_size(const PacketList* pl);
 
PL_PACKET_TYPE PL_get_packet_type(const PacketList* pl);
 
int PL_is_empty(const PacketList* pl);
 
int PL_is_full(const PacketList* pl);
 
const PL_Node* PL_get_head(const PacketList* pl);
 
const PL_Node* PL_get_tail(const PacketList* pl);
 
const PL_Node* PL_get_next(const PL_Node* node);
 
PL_ACK PL_push_front(PacketList* pl, const void* packet);
 
PL_ACK PL_push_back(PacketList* pl, const void* packet);
 
PL_ACK PL_insert_after(PacketList* pl, PL_Node* pos, const void* packet);
 
PL_ACK PL_drop_executed(PacketList* pl);
 
PL_ACK PL_drop_node(PacketList* pl, PL_Node* prev, PL_Node* current);
 
 
// 以下，特定の packet を想定した PacketList の関数
 
PL_ACK PL_insert_tl_cmd(PacketList* pl, const CommonCmdPacket* packet, cycle_t now);
 
PL_ACK PL_deploy_block_cmd(PacketList* pl, const bct_id_t block, cycle_t start_at);
 
PL_ACK PL_check_tl_cmd(const PacketList* pl, cycle_t time);
 
#endif