rr/api.h File Reference

Kamailio RR module (record-routing) API. More...

#include "../../str.h"
#include "../../sr_module.h"
#include "loose.h"
#include "rr_cb.h"

Include dependency graph for rr/api.h:

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

Go to the source code of this file.

Data Structures
struct	rr_binds
Typedefs
typedef int(*	add_rr_param_t )(struct sip_msg *, str *)
typedef int(*	check_route_param_t )(struct sip_msg *, regex_t *)
typedef int(*	get_route_param_t )(struct sip_msg *, str *, str *)
typedef int(*	is_direction_t )(struct sip_msg *, int)
typedef int(*	load_rr_f )(struct rr_binds *)
Functions
int	load_rr (struct rr_binds *)
	API bind function exported by the module - it will load the other functions.
static int	load_rr_api (struct rr_binds *rrb)
	Function to be called directly from other modules to load the RR API.

---

Detailed Description

Kamailio RR module (record-routing) API.

Kamailio RR module (record-routing) API. The RR module provides an internal API to be used by other Kamailio modules. The API offers support for SIP dialog based functionalities.

For internal(non-script) usage, the RR module offers to other module the possibility to register callback functions to be executed each time a local Route header is processed. The callback function will receive as parameter the register parameter and the Route header parameter string.

Definition in file rr/api.h.

---

Typedef Documentation

typedef int(* add_rr_param_t)(struct sip_msg *, str *)

Definition at line 49 of file rr/api.h.

typedef int(* check_route_param_t)(struct sip_msg *, regex_t *)

Definition at line 50 of file rr/api.h.

typedef int(* get_route_param_t)(struct sip_msg *, str *, str *)

Definition at line 52 of file rr/api.h.

typedef int(* is_direction_t)(struct sip_msg *, int)

Definition at line 51 of file rr/api.h.

typedef int(* load_rr_f)(struct rr_binds *)

Definition at line 65 of file rr/api.h.

---

Function Documentation

int load_rr

(

struct rr_binds *

rrb

)

API bind function exported by the module - it will load the other functions.

Parameters:

rr_binds

record-route API export binding

Returns:

1

API bind function exported by the module - it will load the other functions.

Parameters:

rrb

record-route API export binding

Returns:

1

Definition at line 57 of file rr/api.c.

References add_rr_param(), rr_binds::add_rr_param, append_fromtag, rr_binds::append_fromtag, check_route_param(), rr_binds::check_route_param, get_route_param(), rr_binds::get_route_param, is_direction(), rr_binds::is_direction, register_rrcb(), and rr_binds::register_rrcb.

static int load_rr_api

(

struct rr_binds *

rrb

)

[inline, static]

Function to be called directly from other modules to load the RR API.

Parameters:

rrb

record-route API export binding

Returns:

0 on success, -1 if the API loader could not imported

Definition at line 80 of file rr/api.h.

References find_export(), and LM_ERR.

Referenced by mod_init(), and ospInitMod().