http://www.asipto.com/pub/kamailio-devel-guide/
Abstract
This book documents the internal architecture of KAMAILIO (OPENSER) SIP Server, providing the details useful to develop extensions in the core or as a module.
The focus will be on major components of the SIP server, such as memory manager, locking system, parser, database API, configuration file, MI commands, pseudo-variables and module interface.
Examples, API and the architecture are based on current development version of KAMAILIO (OPENSER) - 1.4.0 - at April 2, 2008. Some may change until 1.4.0 is released as stable. The document will be timely updated accordingly, check for updates at www.asipto.com or www.kamailio.org.
This document is free to use for anybody. The authors are not liable in any way for the consequences you may get due to usage of this document.
Table of Contents
-
1. Introduction
- 2. KAMAILIO (OPENSER) Architecture
- 3. Locking system
- 4. Memory Manager
- 5. Data structures
- 6. SIP Parser
- 7. Transport Layer
- 8. Extending configuration file
- 9. Database API
-
-
9.1. DB API Structure
9.2. DB API Functions
-
-
9.2.1. Function init(...)
9.2.2. Function close(...)
9.2.3. Function use_table(...)
9.2.4. Function query(...)
9.2.5. Function fetch_result(...)
9.2.6. Function raw_query(...)
9.2.7. Function free_result(...)
9.2.8. Function insert(...)
9.2.9. Function delete(...)
9.2.10. Function update(...)
9.2.11. Function replace(...)
9.2.12. Function last_inserted_id(...)
9.2.13. Function insert_update(...)
9.3. DB API Data Types
- 9.4. Macros 9.5. Example of usage
10. Management Interface
-
- 11. Pseudo-variables
- 12. Transformations
- 13. Statistics
- 14. Data Lumps 15. Timer
- 16. Module Development
-
-
16.1. module_exports type
16.2. cmd_export_t type
16.3. param_export_t type
16.4. proc_export_t type
16.5. stat_export_t type
16.6. mi_export_t type
16.7. pv_export_t
16.8. Functions Types
16.9. Command Functions
- 16.10. Developing a new module
-
-
16.10.1. Naming the module
16.10.2. Makefile
16.10.3. Main File
16.10.4. Add Module Parameter
16.10.5. Module Init Function
16.10.6. Module Child Init Function
16.10.7. Module Destroy Function
16.10.8. Add Command Function
16.10.9. Add Pseudo-Variable
16.10.10. Add MI Command
16.10.11. Add Extra Process
16.10.12. CFGUTILS module_exports
17. Licensing
18. References
19. Contact Details
List of Figures