ext_node.h

Go to the documentation of this file.

#ifndef __SOLAR_CAPTURE_EXT_NODE_H__
#define __SOLAR_CAPTURE_EXT_NODE_H__


struct sc_node {
  const struct sc_node_type*  nd_type;      
  char*                       nd_name;      
  void*                       nd_private;   
};


struct sc_node_link {
  const char* name;   
};


struct sc_packet;
struct sc_packet_list;
struct sc_attr;
struct sc_node_factory;
struct sc_pool;


typedef int (sc_node_init_fn)(struct sc_node* node,
                              const struct sc_attr* attr,
                              const struct sc_node_factory*);

struct sc_node_factory {
  int                       nf_node_api_ver; 
  const char*               nf_name;         
  const char*               nf_source_file;  
  void*                     nf_private;      
  sc_node_init_fn*          nf_init_fn;      
  void*                     nf_reserved[8];
};


typedef int (sc_node_prep_fn)(struct sc_node* node,
                              const struct sc_node_link*const* links,
                              int n_links);


typedef void (sc_node_pkts_fn)(struct sc_node* node,
                               struct sc_packet_list* packet_list);


typedef int (sc_node_add_link_fn)(struct sc_node* from_node,
                                  const char* link_name,
                                  struct sc_node* to_node,
                                  const char* to_name_opt);


typedef struct sc_node*
  (sc_node_select_subnode_fn)(struct sc_node* node, const char* name,
                              char** new_name_out);

#if SC_API_VER >= 1

typedef void (sc_node_end_of_stream_fn)(struct sc_node* node);
#endif


struct sc_node_type {
  const char*                   nt_name; 
  void*                         nt_private; 
  sc_node_prep_fn*              nt_prep_fn; 
  sc_node_pkts_fn*              nt_pkts_fn; 
  sc_node_add_link_fn*          nt_add_link_fn; 
  sc_node_select_subnode_fn*    nt_select_subnode_fn; 
#if SC_API_VER >= 1
  sc_node_end_of_stream_fn*     nt_end_of_stream_fn; 
#endif
};


extern int sc_node_type_alloc(struct sc_node_type** nt_out,
                              const struct sc_attr* attr_opt,
                              const struct sc_node_factory* factory);


extern void sc_forward_list(struct sc_node* node,
                            const struct sc_node_link* link,
                            struct sc_packet_list* pl);

extern void sc_forward(struct sc_node* node, const struct sc_node_link* link,
                       struct sc_packet* packet);


extern int sc_node_init_get_arg_int(int* v_out, struct sc_node* node,
                                    const char* name, int v_default);

extern int sc_node_init_get_arg_str(const char** v_out, struct sc_node* node,
                                    const char* name, const char* v_default);


#if SC_API_VER >= 1

extern int sc_node_init_get_arg_obj(struct sc_object** obj_out,
                                    struct sc_node* node, const char* name,
                                    enum sc_object_type obj_type);
#endif


#if SC_API_VER >= 1

extern int sc_node_init_get_arg_dbl(double* v_out, struct sc_node* node,
                                    const char* name, double v_default);
#endif


extern const struct sc_node_link*
  sc_node_prep_get_link(struct sc_node* node, const char* link_name);

extern const struct sc_node_link*
  sc_node_prep_get_link_or_free(struct sc_node* node, const char* link_name);

extern int
  sc_node_prep_check_links(struct sc_node* node);

#if SC_API_VER >= 1

extern int sc_node_prep_get_pool(struct sc_pool** pool_out,
                                 const struct sc_attr* attr,
                                 struct sc_node* node,
                                 const struct sc_node_link*const* links,
                                 int n_links);
#endif

#if SC_API_VER >= 1

extern int __sc_node_set_error(struct sc_node* node, const char* file,
                               int line, const char* func, int errno_code,
                               const char* fmt, ...);

extern int __sc_node_fwd_error(struct sc_node* node, const char* file,
                               int line, const char* func, int rc);
#endif

#define sc_node_set_error(node, errno_code, ...)                \
  __sc_node_set_error((node), __FILE__, __LINE__, __func__,     \
                      (errno_code), __VA_ARGS__)

#define sc_node_fwd_error(node, rc)                                     \
  __sc_node_fwd_error((node), __FILE__, __LINE__, __func__, (rc))


#if SC_API_VER >= 1

extern void sc_node_link_end_of_stream(struct sc_node* node,
                                       const struct sc_node_link* link);
#endif


#if SC_API_VER >= 1

extern int sc_node_export_state(struct sc_node* node, const char* type_name,
                                int type_size, void* pp_area);
#endif


#endif  /* __SOLAR_CAPTURE_EXT_NODE_H__ */