k/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 "loose.h"

Include dependency graph for k/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

  record-route API export binding More...
  

Typedefs

• typedef struct rr_binds rr_api_t

  record-route API export binding
  

Functions

• int load_rr (struct rr_binds *rrb)

  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. 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 k/rr/api.h.

---

Function Documentation

int load_rr

(

struct rr_binds *

rrb

)

Parameters:

rrb

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 k/rr/api.c.

References append_fromtag.

static int load_rr_api

(

struct rr_binds *

rrb

)

[inline, static]

Parameters:

rrb

record-route API export binding

Returns:

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

Definition at line 85 of file k/rr/api.h.

Referenced by mod_init().

Here is the caller graph for this function: