PJSIP开发指南英文版本0.5.4_pjsip开发者手册资源-CSDN文库

PJSIP

需积分: 2 55 浏览量 2023-02-16 17:36:15 上传评论收藏 922KB PDF 举报

资源推荐

资源详情

资源评论

PJSIP

Developer’s Guide

Version 0.5.4

PJSIP Developer’s Guide
Table of Contents
 TABLE OF CONTENTS                                                                                                                            .......................................................................................................................   4  
 TABLE OF FIGURES                                                                                                                                 ............................................................................................................................   8  
 TABLE OF CODES                                                                                                                                     ................................................................................................................................   8  
CHAPTER 1: GENERAL DESIGN                                                                                                          .....................................................................................................   11  
1  ARCHITECTURE                                                                                                                                       ..................................................................................................................................   11  
1.1  Communication Diagram                                                                                                           ......................................................................................................   11  
1.2  Class Diagram                                                                                                                            .......................................................................................................................   11  
2  THE ENDPOINT                                                                                                                                       ..................................................................................................................................   12  
2.1  Pool Allocations and Deallocations                                                                                           ......................................................................................   12  
2.2  Timer Management                                                                                                                     ................................................................................................................   12  
2.3  Polling the Stack                                                                                                                         ....................................................................................................................   13  
3  THREAD SAFETY AND THREAD COMPLICATIONS                                                                                          .....................................................................................   13  
3.1  Thread Safety                                                                                                                              .........................................................................................................................   13  
3.2  The Complications                                                                                                                      .................................................................................................................   13  
3.3  The Relief                                                                                                                                    ...............................................................................................................................   14  
CHAPTER 2: MODULE                                                                                                                            .......................................................................................................................   15  
1.1  Module Declaration                                                                                                                    ...............................................................................................................   15  
1.2  Module Priorities                                                                                                                        ...................................................................................................................   16  
1.3  Incoming Message Processing by Modules                                                                                ...........................................................................   17  
1.4  Outgoing Message Processing by Modules                                                                                ...........................................................................   17  
1.5  Transaction User and State Callback                                                                                         ....................................................................................   18  
1.6  Module Specific Data                                                                                                                 ............................................................................................................   18  
1.7  Callback Summary                                                                                                                      .................................................................................................................   19  
1.8  Sample Callback Diagrams                                                                                                        ...................................................................................................   20  
2  MODULE MANAGEMENT                                                                                                                          .....................................................................................................................   21  
2.1  Module Management API                                                                                                           ......................................................................................................   21  
2.2  Module Capabilities                                                                                                                   ..............................................................................................................   21  
CHAPTER 3: MESSAGE ELEMENTS                                                                                                   ..............................................................................................   23  
1  UNIFORM RESOURCE INDICATOR (URI)                                                                                                    ...............................................................................................   23  
1.1  URI “Class Diagram”                                                                                                                ...........................................................................................................   23  
1.2  URI Context                                                                                                                                ...........................................................................................................................   23  
1.3  Base URI                                                                                                                                     ................................................................................................................................   24  
1.4  SIP and SIPS URI                                                                                                                       ..................................................................................................................   25  
1.5  Tel URI                                                                                                                                       ..................................................................................................................................   25  
1.6  Name Address                                                                                                                             ........................................................................................................................   26  
1.7  Sample URI Manipulation Program                                                                                           ......................................................................................   26  
2  SIP METHODS                                                                                                                                       ..................................................................................................................................   27  
2.1  SIP Method Representation (pjsip_method)                                                                               ..........................................................................   27  
2.2  SIP Method API                                                                                                                          .....................................................................................................................   28  
3  HEADER FIELDS                                                                                                                                     ................................................................................................................................   29  
3.1  Header “Class Diagram”                                                                                                          .....................................................................................................   29  
3.2  Header Structure                                                                                                                        ...................................................................................................................   29  
3.3  Common Header Functions                                                                                                        ...................................................................................................   30  
3.4  Supported Header Fields                                                                                                            .......................................................................................................   31  
3.5  Header Array Elements                                                                                                              .........................................................................................................   31  
4  MESSAGE BODY (PJSIP_MSG_BODY)                                                                                                          .....................................................................................................   32  
5  MESSAGE (PJSIP_MSG)                                                                                                                            .......................................................................................................................   33  
6  SIP STATUS CODES                                                                                                                                ...........................................................................................................................   34  
7  NON-STANDARD PARAMETER ELEMENTS                                                                                                   ..............................................................................................   35  
7.1  Data Structure Representation (pjsip_param)                                                                           ......................................................................   36  
7.2  Non-Standard Parameter Manipulation                                                                                     ................................................................................   36  
8  ESCAPEMENT RULES                                                                                                                               ..........................................................................................................................   36  
Page 4

PJSIP Developer’s Guide
CHAPTER 4: PARSER                                                                                                                              .........................................................................................................................   38  
1  FEATURES                                                                                                                                              .........................................................................................................................................   38  
2  FUNCTIONS                                                                                                                                            .......................................................................................................................................   39  
2.1  Message Parsing                                                                                                                         ....................................................................................................................   39  
2.2  URI Parsing                                                                                                                                ...........................................................................................................................   39  
2.3  Header Parsing                                                                                                                           ......................................................................................................................   39  
3  EXTENDING PARSER                                                                                                                                ...........................................................................................................................   40  
CHAPTER 5: MESSAGE BUFFERS                                                                                                       ..................................................................................................   41  
1  RECEIVE DATA BUFFER                                                                                                                          .....................................................................................................................   41  
1.1  Receive Data Buffer Structure                                                                                                    ...............................................................................................   41  
2  TRANSMIT DATA BUFFER (PJSIP_TX_DATA)                                                                                               ..........................................................................................   42  
CHAPTER 6: TRANSPORT LAYER                                                                                                      .................................................................................................   43  
1  TRANSPORT LAYER DESIGN                                                                                                                     ................................................................................................................   43  
1.1  “Class Diagram”                                                                                                                       ..................................................................................................................   43  
1.2  Transport Manager                                                                                                                     ................................................................................................................   43  
1.3  Transport Factory                                                                                                                       ..................................................................................................................   44  
1.4  Transport                                                                                                                                    ..............................................................................................................................   44  
2  USING TRANSPORTS                                                                                                                                ...........................................................................................................................   46  
2.1  Function Reference                                                                                                                     ................................................................................................................   46  
3  EXTENDING TRANSPORTS                                                                                                                         ....................................................................................................................   46  
4  INITIALIZING TRANSPORTS                                                                                                                        ...................................................................................................................   46  
4.1  UDP Transport Initialization                                                                                                     ................................................................................................   47  
4.2  TCP Transport Initialization                                                                                                      .................................................................................................   47  
4.3  TLS Transport Initialization                                                                                                       ..................................................................................................   47  
4.4  SCTP Transport Initialization                                                                                                    ...............................................................................................   47  
CHAPTER 7: SENDING MESSAGES                                                                                                     ................................................................................................   48  
1  SENDING MESSAGES OVERVIEW                                                                                                               ..........................................................................................................   48  
1.1  Creating Messages                                                                                                                     ................................................................................................................   48  
1.2  Sending Messages                                                                                                                       ..................................................................................................................   48  
2  FUNCTION REFERENCE                                                                                                                             ........................................................................................................................   49  
2.1  Sending Response                                                                                                                       ..................................................................................................................   49  
2.2  Sending Request                                                                                                                          .....................................................................................................................   50  
2.3  Stateless Proxy Forwarding                                                                                                       ..................................................................................................   52  
3  EXAMPLES                                                                                                                                             ........................................................................................................................................   53  
3.1  Sending Responses                                                                                                                      .................................................................................................................   53  
3.2  Sending Requests                                                                                                                        ...................................................................................................................   54  
3.3  Stateless Forwarding                                                                                                                  .............................................................................................................   55  
CHAPTER 8: TRANSACTIONS                                                                                                              .........................................................................................................   56  
1  DESIGN                                                                                                                                                 ............................................................................................................................................   56  
1.1  Introduction                                                                                                                                ...........................................................................................................................   56  
1.2  Timers and Retransmissions                                                                                                       ..................................................................................................   56  
1.3  INVITE Final Response and ACK Request                                                                                 ............................................................................   56  
1.4  Incoming ACK Request                                                                                                               ..........................................................................................................   57  
1.5  Server Resolution and Transports                                                                                              .........................................................................................   57  
1.6  Via Header                                                                                                                                  .............................................................................................................................   58  
2  REFERENCE                                                                                                                                            .......................................................................................................................................   58  
2.1  Base Functions                                                                                                                           ......................................................................................................................   58  
2.2  Composite Functions                                                                                                                  .............................................................................................................   59  
3  SENDING STATEFULL RESPONSES                                                                                                              .........................................................................................................   60  
3.1  Usage Examples                                                                                                                         ....................................................................................................................   60  
4  SENDING STATEFULL REQUEST                                                                                                                 ............................................................................................................   60  
4.1  Usage Examples                                                                                                                         ....................................................................................................................   61  
5  STATEFULL PROXY FORWARDING                                                                                                              .........................................................................................................   61  
5.1  Usage Examples                                                                                                                         ....................................................................................................................   61  
CHAPTER 9: AUTHENTICATION FRAMEWORK                                                                            .......................................................................   63  
Page 5