db_carrierroute.h File Reference

Database support for modules. More...

#include "../../db/db.h"
#include "../../str.h"
#include "../../ut.h"
#include <string.h>

Include dependency graph for db_carrierroute.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	carrier_name_DB_COLS
#define	carrier_name_DB_TABLE   { "carrier_name_table", STR_PARAM, &carrierroute_table.s },
#define	carrierfailureroute_DB_COLS
#define	carrierfailureroute_DB_TABLE   { "carrierfailureroute_table", STR_PARAM, &carrierroute_table.s },
#define	carrierroute_DB_COLS
#define	carrierroute_DB_TABLE   { "carrierroute_table", STR_PARAM, &carrierroute_table.s },
#define	carrierroute_DB_URL   { "db_url", STR_PARAM, &carrierroute_db_url.s },
#define	domain_name_DB_COLS
#define	domain_name_DB_TABLE   { "domain_name_table", STR_PARAM, &carrierroute_table.s },
Functions
void	carrierroute_db_close (void)
int	carrierroute_db_init (void)
int	carrierroute_db_open (void)
void	carrierroute_db_vars (void)
Variables
str	carrier_name_carrier_col
str	carrier_name_id_col
str	carrier_name_table
const unsigned int	carrier_name_version
str	carrierfailureroute_carrier_col
str	carrierfailureroute_description_col
str	carrierfailureroute_domain_col
str	carrierfailureroute_flags_col
str	carrierfailureroute_host_name_col
str	carrierfailureroute_id_col
str	carrierfailureroute_mask_col
str	carrierfailureroute_next_domain_col
str	carrierfailureroute_reply_code_col
str	carrierfailureroute_scan_prefix_col
str	carrierfailureroute_table
const unsigned int	carrierfailureroute_version
str	carrierroute_carrier_col
str	carrierroute_db_url
db_func_t	carrierroute_dbf
db_con_t *	carrierroute_dbh
str	carrierroute_description_col
str	carrierroute_domain_col
str	carrierroute_flags_col
str	carrierroute_id_col
str	carrierroute_mask_col
str	carrierroute_prob_col
str	carrierroute_rewrite_host_col
str	carrierroute_rewrite_prefix_col
str	carrierroute_rewrite_suffix_col
str	carrierroute_scan_prefix_col
str	carrierroute_strip_col
str	carrierroute_table
const unsigned int	carrierroute_version
str	domain_name_domain_col
str	domain_name_id_col
str	domain_name_table
const unsigned int	domain_name_version

---

Detailed Description

Database support for modules.

Database support functions for modules.

Definition in file db_carrierroute.h.

---

Define Documentation

#define carrier_name_DB_COLS

Value:

{ "carrier_name_id_col", STR_PARAM, &carrier_name_id_col.s }, \
{ "carrier_name_carrier_col", STR_PARAM, &carrier_name_carrier_col.s }, \

Definition at line 111 of file db_carrierroute.h.

#define carrier_name_DB_TABLE   { "carrier_name_table", STR_PARAM, &carrierroute_table.s },

Definition at line 104 of file db_carrierroute.h.

#define carrierfailureroute_DB_COLS

Definition at line 89 of file db_carrierroute.h.

#define carrierfailureroute_DB_TABLE   { "carrierfailureroute_table", STR_PARAM, &carrierroute_table.s },

Definition at line 74 of file db_carrierroute.h.

#define carrierroute_DB_COLS

Definition at line 57 of file db_carrierroute.h.

#define carrierroute_DB_TABLE   { "carrierroute_table", STR_PARAM, &carrierroute_table.s },

Definition at line 40 of file db_carrierroute.h.

#define carrierroute_DB_URL   { "db_url", STR_PARAM, &carrierroute_db_url.s },

Definition at line 38 of file db_carrierroute.h.

#define domain_name_DB_COLS

Value:

{ "domain_name_id_col", STR_PARAM, &domain_name_id_col.s }, \
{ "domain_name_domain_col", STR_PARAM, &domain_name_domain_col.s }, \

Definition at line 125 of file db_carrierroute.h.

#define domain_name_DB_TABLE   { "domain_name_table", STR_PARAM, &carrierroute_table.s },

Definition at line 118 of file db_carrierroute.h.

---

Function Documentation

void carrierroute_db_close

(

void

)

Definition at line 87 of file db_carrierroute.c.

References db_func::close, and NULL.

Referenced by carrierroute_db_init(), mod_destroy(), and mod_init().

int carrierroute_db_init

(

void

)

Initialises the DB API, check the table version and closes the connection. This should be called from the mod_init function.

Returns:

0 means ok, -1 means an error occured.

Definition at line 101 of file db_carrierroute.c.

References carrier_name_version, carrierfailureroute_version, carrierroute_db_close(), carrierroute_db_url, carrierroute_version, db_bind_mod(), db_check_table_version(), domain_name_version, db_func::init, _str::len, LM_ERR, NULL, and _str::s.

Referenced by mod_init().

int carrierroute_db_open

(

void

)

Initialize the DB connection without checking the table version and DB URL. This should be called from child_init. An already existing database connection will be closed, and a new one created.

Returns:

0 means ok, -1 means an error occured.

Definition at line 136 of file db_carrierroute.c.

References carrierroute_db_url, db_func::close, db_func::init, LM_ERR, and NULL.

Referenced by child_init(), mi_child_init(), and mod_init().

void carrierroute_db_vars

(

void

)

Update the variable length after eventual assignments from the config script. This is necessary because we're using the 'str' type.

Definition at line 152 of file db_carrierroute.c.

References carrierroute_db_url, _str::len, and _str::s.

Referenced by mod_init().

---

Variable Documentation

str carrier_name_carrier_col

Definition at line 69 of file db_carrierroute.c.

str carrier_name_id_col

Definition at line 68 of file db_carrierroute.c.

str carrier_name_table

Definition at line 65 of file db_carrierroute.c.

Referenced by load_carrier_map().

const unsigned int carrier_name_version

Definition at line 72 of file db_carrierroute.c.

Referenced by carrierroute_db_init().

str carrierfailureroute_carrier_col

Definition at line 52 of file db_carrierroute.c.

str carrierfailureroute_description_col

Definition at line 60 of file db_carrierroute.c.

str carrierfailureroute_domain_col

Definition at line 53 of file db_carrierroute.c.

str carrierfailureroute_flags_col

Definition at line 57 of file db_carrierroute.c.

str carrierfailureroute_host_name_col

Definition at line 55 of file db_carrierroute.c.

str carrierfailureroute_id_col

Definition at line 51 of file db_carrierroute.c.

str carrierfailureroute_mask_col

Definition at line 58 of file db_carrierroute.c.

str carrierfailureroute_next_domain_col

Definition at line 59 of file db_carrierroute.c.

str carrierfailureroute_reply_code_col

Definition at line 56 of file db_carrierroute.c.

str carrierfailureroute_scan_prefix_col

Definition at line 54 of file db_carrierroute.c.

str carrierfailureroute_table

Definition at line 48 of file db_carrierroute.c.

Referenced by load_route_data_db().

const unsigned int carrierfailureroute_version

Definition at line 63 of file db_carrierroute.c.

Referenced by carrierroute_db_init().

str carrierroute_carrier_col

Definition at line 33 of file db_carrierroute.c.

str carrierroute_db_url

Definition at line 54 of file carrierroute.c.

Referenced by carrierroute_db_init(), carrierroute_db_open(), and carrierroute_db_vars().

db_func_t carrierroute_dbf

Definition at line 27 of file db_carrierroute.c.

Referenced by load_carrier_map(), load_domain_map(), load_route_data_db(), and load_user_carrier().

db_con_t* carrierroute_dbh

Definition at line 26 of file db_carrierroute.c.

Referenced by load_carrier_map(), load_domain_map(), load_route_data_db(), and load_user_carrier().

str carrierroute_description_col

Definition at line 43 of file db_carrierroute.c.

str carrierroute_domain_col

Definition at line 34 of file db_carrierroute.c.

str carrierroute_flags_col

Definition at line 36 of file db_carrierroute.c.

str carrierroute_id_col

Definition at line 32 of file db_carrierroute.c.

str carrierroute_mask_col

Definition at line 37 of file db_carrierroute.c.

str carrierroute_prob_col

Definition at line 38 of file db_carrierroute.c.

str carrierroute_rewrite_host_col

Definition at line 40 of file db_carrierroute.c.

str carrierroute_rewrite_prefix_col

Definition at line 41 of file db_carrierroute.c.

str carrierroute_rewrite_suffix_col

Definition at line 42 of file db_carrierroute.c.

str carrierroute_scan_prefix_col

Definition at line 35 of file db_carrierroute.c.

str carrierroute_strip_col

Definition at line 39 of file db_carrierroute.c.

str carrierroute_table

Definition at line 29 of file db_carrierroute.c.

Referenced by load_route_data_db().

const unsigned int carrierroute_version

Definition at line 46 of file db_carrierroute.c.

Referenced by carrierroute_db_init().

str domain_name_domain_col

Definition at line 78 of file db_carrierroute.c.

str domain_name_id_col

Definition at line 77 of file db_carrierroute.c.

str domain_name_table

Definition at line 74 of file db_carrierroute.c.

Referenced by load_domain_map().

const unsigned int domain_name_version

Definition at line 81 of file db_carrierroute.c.

Referenced by carrierroute_db_init().