Programmer's guide

From Yate Documentation
(Difference between revisions)
Jump to: navigation, search
(→‎Javascript)
 
(51 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
Yate has 3 major API's to build applications on top of it: C API, Javascript and extmodule (you can use your favorite language like PHP, Python, Ruby, Lisp).
  
−
The most important parts of Yate are described bellow and also some libraries used to communicate with Yate.<br>
+
But all Yate API's are quite unified, so all Yate design pages, apply to all API's. Enjoy.
−
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.
+
== About Yate design and implementation ==
  
−
The software is written in C++ and it supports scripting in various programming languages like PHP, Python and Javascript.
+
{|class="yate-table"
 +
|class="yate-header-right"|Yate for programmers
 +
|-
 +
|class="yate-content-right"|
 +
* [[Yate Design]]
 +
Yate arhitecture and design.
 +
* [http://yate.null.ro/docs/ Yate C++ API]
 +
Documentation for Yate C++ API
  
−
{| style="background:transparent;"
+
* [[Messages]]
−
| style="width:1000px; vertical-align:top; border:1px solid #aaa;" |
+
Components of messages and how messages are processed by messages handlers.
  
−
;[[Yate Design]]
+
{|class="yate-subtable"
−
:Yate arhitecture and design.
+
|-
−
;[[Messages]]
+
|class="yate-page-subtitle"|
−
: Components of messages and how messages are processed by messages handlers.
+
* [[Standard Messages]]
−
:* [[Standard Messages]]
+
All standard messages in Yate.
−
:: All standard messages in Yate
+
* [[Message Flows]]
−
:* [[Message Flows]]
+
Flow messages for an incoming call.
−
:: Flow messages for an incoming call.
+
−
;[[Coding style]]
+
−
: Rules for coding Yate
+
−
;[http://yate.null.ro/docs/ Yate C++ API]
+
−
: Documentation for Yate C++ API
+
−
;[[Yate's PHP library]]
+
−
: The library used by PHP to comunicate with Yate.
+
−
:*[[Using Yate's PHP library on windows]]
+
−
:: Test an existing PHP script on Windows.
+
−
;[[YAYPM|YAYPM Yet Another Yate Python Module]]
+
−
: The library used by Python Module to comunicate with Yate.
+
−
:* [[YAYPM_Installation_on_windows|Using YAYPM on windows]]
+
−
; [[YIAX design]]
+
−
: YIAX library in Yate.
+
−
;[[Mutexes and locking]]
+
−
:
+
−
:* [[Locking Issues]]
+
−
:* [[Important Mutexes]]
+
−
;[[Debug Output]]
+
−
: How to enable debug in Yate.
+
 
|}
 
|}
 +
 +
* [[Coding style]]
 +
Rules for coding Yate
 +
 +
* [[Mutexes and locking]]
 +
Yate's implementation provides classes for mutual exclusion and locking.
 +
{|class="yate-subtable"
 +
|-
 +
|class="yate-page-subtitle"|
 +
* [[Locking Issues]]
 +
Provide an overview of problems caused by improper locking and how to troubleshoot them.
 +
* [[Important Mutexes]]
 +
Some noteworthy mutexes that have program-wide implications in Yate code.
 +
|}
 +
* [[YIAX design]]
 +
YIAX library in Yate.
 +
|}
 +
 +
==Scripting languages supported by Yate ==
 +
 +
=== Javascript ===
 +
 +
{|class="yate-table"
 +
 +
|class="yate-header-right"|Yate for programmers
 +
|-
 +
|class="yate-content-right"|
 +
 +
* [[Javascript]]
 +
Yate offers a embedded Javascript implementation.
 +
 +
{|"yate-subtable"
 +
|-
 +
|class="yate-page-subtitle"|
 +
* [[Javascript module]]
 +
Configuring Javascript module to use routing or global scripts.
 +
* [[Including other files]]
 +
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.
 +
|}
 +
 +
|}
 +
 +
=== PHP ===
 +
 +
{|class="yate-table"
 +
 +
|class="yate-header-right"|Yate for programmers
 +
|-
 +
|class="yate-content-right"|
 +
* [[Yate's PHP library]]
 +
The library used by PHP to comunicate with Yate.
 +
{|"yate-subtable"
 +
|-
 +
|class="yate-page-subtitle"|
 +
*[[IVR Setup]]
 +
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.
 +
|}
 +
|}
 +
 +
===Python===
 +
 +
{|class="yate-table"
 +
 +
|class="yate-header-right"|Yate for programmers
 +
|-
 +
|class="yate-content-right"|
 +
* [[YAYPM|YAYPM Yet Another Yate Python Module]]
 +
The library used by Python Module to comunicate with Yate.
 +
{|"yate-subtable"
 +
|-
 +
|class="yate-page-subtitle"|
 +
* [[YAYPM:Simple IVR]]
 +
How to write a simple IVR in Yate.
 +
* [[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.
 +
|}
 +
|}
 +
 +
==Debugging ==
 +
 +
{|class="yate-table"
 +
 +
|class="yate-header-right"|Yate for programmers
 +
|-
 +
|class="yate-content-right"|
 +
 +
* [[Debugging in Yate]]
 +
How to debug in Yate.
 +
{|"yate-subtable"
 +
|-
 +
|class="yate-page-subtitle"|
 +
 +
* [[Debug Output]]
 +
How to enable debug in Yate.
 +
* [[Debugging and, or Investigation of messages]]
 +
You can use the msgsniff module to investigate the messages in yate.
 +
|}
 +
|}
 +
 +
 +
'''See also'''
 +
 +
* [[Telephony]]
 +
 +
[[Category:Programmers]] [[Category:Javascript]] [[Category:IVR]] [[Category:Messages]] [[Category:Debug]]

Latest revision as of 11:01, 10 March 2016

Yate has 3 major API's to build applications on top of it: C API, Javascript and extmodule (you can use your favorite language like PHP, Python, Ruby, Lisp).

But all Yate API's are quite unified, so all Yate design pages, apply to all API's. Enjoy.

Contents

[edit] About Yate design and implementation

Yate for programmers

Yate arhitecture and design.

Documentation for Yate C++ API

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

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.

YIAX library in Yate.

[edit] Scripting languages supported by Yate

[edit] Javascript

Yate for programmers

Yate offers a embedded Javascript implementation.

Configuring Javascript module to use routing or global 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.

[edit] 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.

[edit] 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.

[edit] 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

Retrieved from "https://docs.yate.ro/wiki/index.php?title=Programmer%27s_guide&oldid=7913"
Personal tools
Namespaces

Variants
Actions
Preface
Configuration
Administrators
Developers