Programmer's guide

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.

[edit] About Yate design and implementation

Yate for programmers

Yate Design

Yate arhitecture and design.

Yate C++ API

Documentation for Yate C++ API

Messages

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

Standard Messages

All standard messages in Yate.

Message Flows

Flow messages for an incoming call.

Coding style

Rules for coding Yate

Mutexes and locking

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

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.

[edit] Scripting languages supported by Yate

[edit] Javascript

Yate for programmers

Javascript

Yate offers a embedded Javascript implementation.

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.

[edit] PHP

Yate for programmers

Yate's PHP library

The library used by PHP to comunicate with Yate.

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.

[edit] Python

Yate for programmers

YAYPM Yet Another Yate Python Module

The library used by Python Module to comunicate with Yate.

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

Using YAYPM on windows

How to install YAYPM on Windows.

[edit] Debugging

Yate for programmers

Debugging in Yate

How to debug in Yate.

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

@@ 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 ==
+{|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
+* [[Messages]]
+Components of messages and how messages are processed by messages handlers.
+{|class="yate-subtable"
+|-
+|class="yate-page-subtitle"|
+* [[Standard Messages]]
+All standard messages in Yate.
+* [[Message Flows]]
+Flow messages for an incoming call.
+|}
+* [[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 ===
-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="telephony-content-right"|
+|class="yate-content-right"|
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Yate Design]]</font><br/>
-<div class="yate-page-desc">Yate arhitecture and design.</div>
+* [[Javascript]]
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Yate Design]]</font><br/>
+Yate offers a embedded Javascript implementation.
-<div class="yate-page-desc">Yate arhitecture and design.</div>
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Messages]]</font><br/>
+{|"yate-subtable"
-<div class="yate-page-desc">Components of messages and how messages are processed by messages handlers.</div>
+|-
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Standard Messages]]</font><br/>
+|class="yate-page-subtitle"|
-<div class="yate-page-desc">All standard messages in Yate.</div>
+* [[Javascript module]]
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Message Flows]]</font><br/>
+Configuring Javascript module to use routing or global scripts.
-<div class="yate-page-desc">Flow messages for an incoming call.</div>
+* [[Including other files]]
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Coding style]]</font><br/>
+Language extensions for including other files and libraries.
-<div class="yate-page-desc">Rules for coding Yate</div>
+* [[Constructors and prototypes]]
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[http://yate.null.ro/docs/ Yate C++ API]</font><br/>
+Object construction and prototypal inheritance in Javascript.
-<div class="yate-page-desc">Documentation for Yate C++ API</div>
+* [[Messages in JS]]
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Yate's PHP library]]</font><br/>
+Messages in JavaScript
-<div class="yate-page-desc">The library used by PHP to comunicate with Yate.</div>
+* [[Time events in Javascript]]
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Using Yate's PHP library on windows]]</font><br/>
+Describes implemented methods that process actions in certain time intervals.
-<div class="yate-page-desc">Test an existing PHP script on Windows.</div>
+* [[Sharing data in Javascript]]
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[YAYPM|YAYPM Yet Another Yate Python Module]]</font><br/>
+Methods of sharing data between different Javascript instances.
-<div class="yate-page-desc">The library used by Python Module to comunicate with Yate.</div>
+* [[How to do routing using javascript]]
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[YAYPM_Installation_on_windows|Using YAYPM on windows]]</font><br/>
+Routing rules written in a script using Yate's Javascript module.
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[YIAX design]]</font><br/>
+* [[How to access a database from Yate's Javascript module]]
-<div class="yate-page-desc">YIAX library in Yate.</div>
+Accessing the database from javascript module.
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Mutexes and locking]]</font><br/>
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Locking Issues]]</font><br/>
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Important Mutexes]]</font><br/>
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Debug Output]]</font><br/>
-<div class="yate-page-desc">How to enable debug in Yate.</div>
 |}
+|}
+=== 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]]

Programmer's guide

Latest revision as of 11:01, 10 March 2016

Contents

[edit] About Yate design and implementation

[edit] Scripting languages supported by Yate

[edit] Javascript

[edit] PHP

[edit] Python

[edit] Debugging

Personal tools

Namespaces

Variants

Views

Actions

Search

Preface

Configuration

Administrators

Developers