Programmer's guide

From Yate Documentation
(Difference between revisions)
Jump to: navigation, search
(About Yate design and implementation)
Line 40: Line 40:
 
{|class="yate-page-subtitle"
 
{|class="yate-page-subtitle"
 
|-
 
|-
 +
|class="yate-page-subtitle"|
 
* [[Locking Issues]]
 
* [[Locking Issues]]
 
Provide an overview of problems caused by improper locking and how to troubleshoot them.
 
Provide an overview of problems caused by improper locking and how to troubleshoot them.
Line 62: Line 63:
 
{|"yate-page-subtitle"
 
{|"yate-page-subtitle"
 
|-
 
|-
 +
|class="yate-page-subtitle"|
 
* [[Javascript routing]]
 
* [[Javascript routing]]
 
Configuring Javascript module to use routing scripts.
 
Configuring Javascript module to use routing scripts.
Line 93: Line 95:
 
{|"yate-page-subtitle"
 
{|"yate-page-subtitle"
 
|-
 
|-
 +
|class="yate-page-subtitle"|
 
*[[IVR Setup]]
 
*[[IVR Setup]]
 
How to setup an IVR in Yate.
 
How to setup an IVR in Yate.
Line 117: Line 120:
 
{|"yate-page-subtitle"
 
{|"yate-page-subtitle"
 
|-
 
|-
 +
|class="yate-page-subtitle"|
 
* [[YAYPM:Simple IVR]]
 
* [[YAYPM:Simple IVR]]
 
How to write a simple IVR in Yate.
 
How to write a simple IVR in Yate.
Line 142: Line 146:
 
{|"yate-page-subtitle"
 
{|"yate-page-subtitle"
 
|-
 
|-
 +
|class="yate-page-subtitle"|
 +
 
* [[Debug Output]]
 
* [[Debug Output]]
 
How to enable debug in Yate.
 
How to enable debug in Yate.

Revision as of 18:02, 1 November 2013

The most important parts of Yate are described bellow and also some libraries used to communicate with Yate.
The purpose of Yate is to provide an extensible telephony engine. Holding the base code as simple as possible and adding functionality as needed allows one to find the best balance between desired functionality, performance and stability.

Yate is a next-generation telephony engine; while currently focused on Voice over Internet Protocol (VoIP), its power lies in its ability to be easily extended. Voice, video, data and instant messaging can all be unified under Yate's flexible routing engine, maximizing infrastructure and communications in business.

The software is written in C++ and supports scripting in various programming languages like PHP, Python and Javascript.

Contents

About Yate design and implementation

Yate for programmers

Yate arhitecture and design.

Components of messages and how messages are processed by messages handlers.

All standard messages in Yate.

Flow messages for an incoming call.

Rules for coding Yate

Documentation for Yate C++ API

YIAX library in Yate.

Yate's implementation provides classes for mutual exclusion and locking.

Provide an overview of problems caused by improper locking and how to troubleshoot them.

Some noteworthy mutexes that have program-wide implications in Yate code.

Scripting languages supported by Yate

Javascript

Yate for programmers

Yate offers a embedded Javascript implementation.

Configuring Javascript module to use routing scripts.

Language extensions for including other files and libraries.

Object construction and prototypal inheritance in Javascript.

Messages in JavaScript

Describes implemented methods that process actions in certain time intervals.

Methods of sharing data between different Javascript instances.

Routing rules written in a script using Yate's Javascript module.

Accessing the database from javascript module.

PHP

Yate for programmers

The library used by PHP to comunicate with Yate.

How to setup an IVR in Yate.

How to write an IVR.

Test an existing PHP script on Windows.

Test an existing PHP script on Windows.

Python

Yate for programmers


The library used by Python Module to comunicate with Yate.

How to write a simple IVR in Yate.

How to write a simple IVR with Inline Callbacks in Yate.

How to bridge and then unbridge.

How to bridge and then redirect after a hangup

How to install YAYPM on Windows.

Debugging

Yate for programmers

How to debug in Yate.

How to enable debug in Yate.

You can use the msgsniff module to investigate the messages in yate.


See also

Personal tools
Namespaces

Variants
Actions
Preface
Configuration
Administrators
Developers