Programmer's guide: Difference between revisions

No edit summary
No edit summary
Line 6: Line 6:


The software is written in C++ and supports scripting in various programming languages like PHP, Python and Javascript.
The software is written in C++ and supports scripting in various programming languages like PHP, Python and Javascript.
{|class="yate-table"
{|class="yate-table"


|class="yate-header-right"|Yate for programmers
|class="yate-header-right"|Yate for programmers
|-
|-
|class="telephony-content-right"|
|class="yate-content-right"|
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Yate Design]]</font><br/>
* [[Yate Design]]
<div class="yate-page-desc">Yate arhitecture and design.</div>
Yate arhitecture and design.
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Messages]]</font><br/>
* [[Messages]]
<div class="yate-page-desc">Components of messages and how messages are processed by messages handlers.</div>
Components of messages and how messages are processed by messages handlers.


<div class="yate-page-subtitle"><div class="bullet">&nbsp;</div><font class="yate-page-title">[[Standard Messages]]</font><br/>
<div class="yate-page-subtitle">
<div class="yate-page-desc">All standard messages in Yate.</div>
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Message Flows]]</font><br/>
<div class="yate-page-desc">Flow messages for an incoming call.</div></div>


<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Coding style]]</font><br/>
* [[Standard Messages]]
<div class="yate-page-desc">Rules for coding Yate</div>
All standard messages in Yate.
<div class="bullet">&nbsp;</div><font class="yate-page-title">[http://yate.null.ro/docs/ Yate C++ API]</font><br/>
<div class="yate-page-desc">Documentation for Yate C++ API</div>


<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Javascript]]</font><br/>
* [[Message Flows]]
<div class="yate-page-desc">Yate offers a embedded Javascript implementation.</div>
Flow messages for an incoming call.


<div class="yate-page-subtitle"><div class="bullet">&nbsp;</div><font class="yate-page-title">[[Javascript routing]]</font><br/>
</div>
<div class="yate-page-desc">Configuring Javascript module to use routing scripts.</div>


<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Including other files]]</font><br/>
* [[Coding style]]
<div class="yate-page-desc">Language extensions for including other files and libraries.</div>
Rules for coding Yate
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Constructors and prototypes]]</font><br/>
* [http://yate.null.ro/docs/ Yate C++ API]
<div class="yate-page-desc">Object construction and prototypal inheritance in Javascript.</div>
Documentation for Yate C++ API
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Messages in JS]]</font><br/>
 
<div class="yate-page-desc">Messages in JavaScript</div>
* [[Javascript]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Time events in Javascript]]</font><br/>
Yate offers a embedded Javascript implementation.
<div class="yate-page-desc">Describes implemented methods that process actions in certain time intervals.</div>
 
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Sharing data in Javascript]]</font><br/>
<div class="yate-page-subtitle">
<div class="yate-page-desc">Methods of sharing data between different Javascript instances.</div>


<div class="bullet">&nbsp;</div><font class="yate-page-title">[[How to do routing using javascript]]</font><br/>
* [[Javascript routing]]
<div class="yate-page-desc">Routing rules written in a script using Yate's Javascript module.</div>
Configuring Javascript module to use routing scripts.
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[How to access a database from Yate's Javascript module]]</font><br/>
* [[Including other files]]
<div class="yate-page-desc">Accessing the database from javascript module.</div>
Language extensions for including other files and libraries.
* [[Constructors and prototypes]]
Object construction and prototypal inheritance in Javascript.
* [[Messages in JS]]
Messages in JavaScript
* [[Time events in Javascript]]
Describes implemented methods that process actions in certain time intervals.
* [[Sharing data in Javascript]]
Methods of sharing data between different Javascript instances.
* [[How to do routing using javascript]]
Routing rules written in a script using Yate's Javascript module.
* [[How to access a database from Yate's Javascript module]]
Accessing the database from javascript module.


</div>
</div>


<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Yate's PHP library]]</font><br/>
* [[Yate's PHP library]]
<div class="yate-page-desc">The library used by PHP to comunicate with Yate.</div>
The library used by PHP to comunicate with Yate.
 
<div class="yate-page-subtitle">


<div class="yate-page-subtitle"><div class="bullet">&nbsp;</div><font class="yate-page-title">[[IVR Setup]]</font><br/>
*[[IVR Setup]]
<div class="yate-page-desc">How to setup an IVR in Yate.</div>
How to setup an IVR in Yate.
* [[Writing an IVR]]
How to write an IVR.
* [[Using Yate's PHP library on windows]]
Test an existing PHP script on Windows.
* [[How To For External Modules In Telnet]]
Test an existing PHP script on Windows.
</div>


<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Writing an IVR]]</font><br/>
* [[YAYPM|YAYPM Yet Another Yate Python Module]]
<div class="yate-page-desc">How to write an IVR.</div>
The library used by Python Module to comunicate with Yate.


<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Using Yate's PHP library on windows]]</font><br/>
<div class="yate-page-subtitle">
<div class="yate-page-desc">Test an existing PHP script on Windows.</div>
* [[YAYPM:Simple IVR]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[How To For External Modules In Telnet]]</font><br/>
How to write a simple IVR in Yate.
<div class="yate-page-desc">Test an existing PHP script on Windows.</div>
* [[YAYPM:Simple IVR with Inline Callbacks]]
How to write a simple IVR with Inline Callbacks in Yate.
* [[YAYPM:Bridge and then unbridge]]
How to bridge and then unbridge.
* [[YAYPM:Bridge and then redirect after a hangup]]
How to bridge and then redirect after a hangup
* [[YAYPM_Installation_on_windows|Using YAYPM on windows]]
How to install YAYPM on Windows.
</div>
</div>
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[YAYPM|YAYPM Yet Another Yate Python Module]]</font><br/>
<div class="yate-page-desc">The library used by Python Module to comunicate with Yate.</div>


<div class="yate-page-subtitle"><div class="bullet">&nbsp;</div><font class="yate-page-title">[[YAYPM:Simple IVR]]</font><br/>
* [[YIAX design]]
<div class="yate-page-desc">How to write a simple IVR in Yate.</div>
YIAX library in Yate.
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[YAYPM:Simple IVR with Inline Callbacks]]</font><br/>
* [[Mutexes and locking]]
<div class="yate-page-desc">How to write a simple IVR with Inline Callbacks in Yate.</div>
Yate's implementation provides classes for mutual exclusion and locking.
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[YAYPM:Bridge and then unbridge]]</font><br/>
<div class="yate-page-subtitle">
<div class="yate-page-desc">How to bridge and then unbridge.</div>
* [[Locking Issues]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[YAYPM:Bridge and then redirect after a hangup]]</font><br/>
Provide an overview of problems caused by improper locking and how to troubleshoot them.
<div class="yate-page-desc">How to bridge and then redirect after a hangup</div>
* [[Important Mutexes]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[YAYPM_Installation_on_windows|Using YAYPM on windows]]</font><br/>
Some noteworthy mutexes that have program-wide implications in Yate code.
<div class="yate-page-desc">How to install YAYPM on Windows.</div></div>
</div>


<div class="bullet">&nbsp;</div><font class="yate-page-title">[[YIAX design]]</font><br/>
* [[Debugging in Yate]]
<div class="yate-page-desc">YIAX library in Yate.</div>
How to debug in Yate.
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Mutexes and locking]]</font><br/>
<div class="yate-page-desc">Yate's implementation provides classes for mutual exclusion and locking.</div>
<div class="yate-page-subtitle"><div class="bullet">&nbsp;</div><font class="yate-page-title">[[Locking Issues]]</font><br/>
<div class="yate-page-desc">Provide an overview of problems caused by improper locking and how to troubleshoot them.</div>
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Important Mutexes]]</font>
<div class="yate-page-desc">Some noteworthy mutexes that have program-wide implications in Yate code.</div>
</div>
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Debugging in Yate]]</font><br/>
<div class="yate-page-desc">How to debug in Yate.</div>
<div class="yate-page-subtitle">
<div class="yate-page-subtitle">
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Debug Output]]</font><br/>
* [[Debug Output]]
<div class="yate-page-desc">How to enable debug in Yate.</div>
How to enable debug in Yate.
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Debugging and, or Investigation of messages]]</font><br/>
* [[Debugging and, or Investigation of messages]]
<div class="yate-page-desc">You can use the msgsniff module to investigate the messages in yate.</div>
You can use the msgsniff module to investigate the messages in yate.
</div>
</div>
|}
|}

Revision as of 11:12, 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.


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

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.

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.

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.

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.

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