README.md

Welcome to NkSIP Documentation

1. User Guide

• Introduction
• Features
• Concepts
• Starting NkSIP
• Starting a Service
• Sending Requests
• Receiving Requests

2. Reference Guide

• Configuration
• Sending Functions
• Sending Options
• Callback Functions
• Replying Options
• Metadata Options
• Logging System

3. API

• Service API
• Requests API
• Responses API
• Dialogs API
• Subscriptions API
• SDP API

4. Standard Plugins

• Registrar
• Event State Compositor
• Reliable Provisional Responses
• Session Timers
• GRUU
• Outbound
• Refer
• Auto Authentication
• Auto Register
• Auto Outbound
• Trace
• Stats

5. Cookbook

• Generic
  • Sending a request
  • Managing authentication
  • Replying to a request
• Services
  • Stateless proxy server
  • Stateful proxy server
  • Registrar server
  • Redirect server
  • B2BUA
  • A load tester
• Specific aspects
  • Header manipulation
  • Events
  • Refer
  • Publish
  • Message
  • Resolver
  • Session Timers
  • IPv6
  • Websockets

6. Advanced Concepts

• Resolver
• Runtime configuration
• Plugin architecture
• How to write a plugin
• Plugin callback reference

7. Roadmap

8. Changelog