nm_gate.h

Go to the documentation of this file.

/*
 * NewMadeleine
 * Copyright (C) 2006-2025 (see AUTHORS file)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 */
 
#ifndef NM_GATE_H
#define NM_GATE_H
 
struct nm_gtag_s
{
  nm_seq_t recv_seq_number;                           
  nm_seq_t send_seq_number;                           
  struct nm_req_list_s unpacks;                       
  struct nm_req_list_s pending_packs;                 
  struct nm_unexpected_gtag_list_s unexpected;        
  struct nm_core_pending_event_list_s pending_events; 
};
static inline void nm_gtag_ctor(struct nm_gtag_s*p_gtag, nm_core_tag_t tag __attribute__((unused)))
{
  p_gtag->recv_seq_number = NM_SEQ_FIRST;
  p_gtag->send_seq_number = NM_SEQ_FIRST;
  nm_req_list_init(&p_gtag->unpacks);
  nm_req_list_init(&p_gtag->pending_packs);
  nm_unexpected_gtag_list_init(&p_gtag->unexpected);
  nm_core_pending_event_list_init(&p_gtag->pending_events);
}
static inline void nm_gtag_dtor(struct nm_gtag_s*p_gtag __attribute__((unused)))
{
  assert(nm_core_pending_event_list_empty(&p_gtag->pending_events));
}
 
NM_TAG_TABLE_TYPE(nm_gtag, struct nm_gtag_s);
 
struct nm_matching_gsession_s
{
  struct nm_req_list_s unpacks;                 
  struct nm_unexpected_gate_list_s unexpected;  
};
static inline void nm_matching_gsession_ctor(struct nm_matching_gsession_s*p_gsession, nm_core_tag_t tag __attribute__((unused)))
{
  nm_req_list_init(&p_gsession->unpacks);
  nm_unexpected_gate_list_init(&p_gsession->unexpected);
}
static inline void nm_matching_gsession_dtor(struct nm_matching_gsession_s*p_gsession __attribute__((unused)))
{
}
NM_TAG_TABLE_TYPE(nm_matching_gsession, struct nm_matching_gsession_s);
static inline struct nm_matching_gsession_s*nm_matching_gsession_bytag(struct nm_gate_s*p_gate, nm_core_tag_t core_tag);
 
struct nm_trk_s
{
  nm_trk_id_t trk_id;                               
  struct nm_gate_s*p_gate;                          
  struct nm_drv_s*p_drv;                            
  struct puk_receptacle_NewMad_minidriver_s receptacle; 
  puk_instance_t instance;                          
  struct nm_pkt_wrap_list_s active_pw_recv;         
  struct nm_pkt_wrap_list_s active_pw_send;         
  struct nm_pkt_wrap_list_s pending_pw_send;        
  void*binary_url;                                  
  size_t binary_url_size;                           
  nm_trk_kind_t kind;
};
 
PUK_HASHTABLE_TYPE(nm_trk, void*, struct nm_trk_s*,
                   &puk_hash_pointer_default_hash, &puk_hash_pointer_default_eq, NULL);
 
enum nm_gate_status_e
  {
    NM_GATE_STATUS_INIT,          
    NM_GATE_STATUS_CONNECTING,    
    NM_GATE_STATUS_CONNECTED,     
    NM_GATE_STATUS_DISCONNECTING, 
    NM_GATE_STATUS_DISCONNECTED   
  };
typedef enum nm_gate_status_e nm_gate_status_t;
 
 
PUK_LIST_DECLARE_TYPE(nm_gate);
PUK_LIST_DECLARE_TYPE2(nm_active_gate, struct nm_gate_s);
 
struct nm_gate_s
{
  PUK_LIST_LINK(nm_gate);
  PUK_LIST_LINK(nm_active_gate);
 
  nm_gate_status_t status;
 
  int n_trks;
 
  struct nm_trk_s*trks;
 
  struct nm_gtag_table_s tags;
 
  struct nm_matching_gsession_table_s gsessions;
 
  struct nm_pkt_wrap_list_s pending_large_recv;
  struct nm_pkt_wrap_list_s pending_large_send;
 
  struct puk_receptacle_NewMad_Strategy_s strategy_receptacle;
  puk_instance_t strategy_instance;
 
  struct nm_req_chunk_list_s req_chunk_list;
 
  struct nm_ctrl_chunk_list_s ctrl_chunk_list;
 
  struct nm_core*p_core;
};
 
PUK_LIST_CREATE_FUNCS(nm_gate);
PUK_LIST_CREATE_FUNCS(nm_active_gate);
 
#define NM_FOR_EACH_GATE(P_GATE, P_CORE)                        \
  puk_list_foreach(nm_gate, P_GATE, &(P_CORE)->gate_list)
 
#endif /* NM_GATE_H */