pjnath.rst

PJNATH - NAT Traversal

PJNATH (PJSIP NAT Helper) is an open source library providing NAT traversal functionalities using standard based protocols such as STUN, TURN, and ICE.

Introduction

• Samples <generated/pjnath/group/group__samples__page>

API Reference

Basic Types and Functions

• Basic Initialization <generated/pjnath/group/group__PJNATH>
• Configurations <generated/pjnath/group/group__PJNATH__CONFIG>
• Error Codes <generated/pjnath/group/group__PJNATH__ERROR>

ICE (Interactive Connectivity Establishment)

• High-level ICE Transport <generated/pjnath/group/group__PJNATH__ICE__STREAM__TRANSPORT>
• Transport-independent ICE Session <generated/pjnath/group/group__PJNATH__ICE__SESSION>

STUN (Session Traversal Utilities for NAT)

• High-level STUN Transport <generated/pjnath/group/group__PJNATH__STUN__SOCK>
• Transport-independent STUN Session <generated/pjnath/group/group__PJNATH__STUN__SESSION>
• Basic Objects:
  • STUN Authentication <generated/pjnath/group/group__PJNATH__STUN__AUTH>
  • STUN Config <generated/pjnath/group/group__PJNATH__STUN__CONFIG>
  • STUN Message and Parsing <generated/pjnath/group/group__PJNATH__STUN__MSG>
  • STUN Client Transaction <generated/pjnath/group/group__PJNATH__STUN__TRANSACTION>

TURN (Traversal Using Relays around NAT)

• High-level UDP/TCP/TLS TURN Client Transport <generated/pjnath/group/group__PJNATH__TURN__SOCK>
• Transport-independent TURN Client Session <generated/pjnath/group/group__PJNATH__TURN__SESSION>

NAT Type Detection

• NAT Type Detection Tool <generated/pjnath/group/group__PJNATH__NAT__DETECT>