Modules

From Yate Documentation
(Difference between revisions)
Jump to: navigation, search
(→‎Software Drivers)
Line 64: Line 64:
 
==Hardware Drivers==
 
==Hardware Drivers==
  
−
:* [[wpcard]] - ISDN E1/T1 driver over Wanpipe for Linux. Supports [http://www.sangoma.com Sangoma] AFT voice series cards. Very efficient. (for Yate >= 2.0)
+
{|class="yate-table"
−
:* [[wpcard|wpcardw]] - ISDN E1/T1 driver over Wanpipe for Windows. Wanpipe drivers for windows are really different from the Linux version including the API. (for Yate >= 2.0)
+
|class="yate-header-right"|Modules
−
:* [[zapcard]] - ISDN E1/T1 TDM/FXO/FXS [http://www.asterisk.org/downloads Zaptel] driver. It supports some of the cards made by [http://www.digium.com Digium] - [http://www.digium.com/index.php?menu=wildcard_e100p E100P], [http://www.digium.com/index.php?menu=wildcard_t100p T100P], [http://www.digium.com/en/products/digital/te405p.php TE405P], [http://www.digium.com/en/products/digital/te410p.php TE410P]. (for Yate >= 2.0)
+
|-
−
:* [[wpchan]] - ISDN E1/T1 driver over Wanpipe for Linux. Supports [http://www.sangoma.com Sangoma] AFT voice series cards. Very efficient. (for Yate < 2.0)
+
|class="yate-content-right"|
−
:* [[wpchanw]] - ISDN E1/T1 driver over Wanpipe for Windows. Wanpipe drivers for windows are really different from the Linux version including the API. (for Yate < 2.0)
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[wpcard]]</font><br/>
−
:* [[zapchan]] - ISDN E1/T1/BRI driver, requires [http://www.asterisk.org/index.php?menu=download Zaptel] and [http://www.asterisk.org/index.php?menu=download libpri] .It supports some of the cards made by [http://www.digium.com Digium] - [http://www.digium.com/index.php?menu=wildcard_e100p E100P], [http://www.digium.com/index.php?menu=wildcard_t100p T100P], [http://www.digium.com/index.php?menu=wildcard_te405p TE405P], [http://www.digium.com/index.php?menu=wildcard_te410p TE410P] or you can use [http://www.voip-info.org/tiki-index.php?page=Asterisk+TDMoE ethernet] emulation and [http://www.voip-info.org/wiki-Asterisk+timer+ztdummy ztdummy] , and also all ISDN BRI cards based on the Cologne chip - [[zaphfc]]. (for Yate < 2.0)
+
<div class="yate-page-desc">ISDN E1/T1 driver over Wanpipe for Linux. Supports [http://www.sangoma.com Sangoma] AFT voice series cards. Very efficient. (for Yate >= 2.0)</div>
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[wpcard|wpcardw]] </font><br/>
 +
<div class="yate-page-desc"> ISDN E1/T1 driver over Wanpipe for Windows. Wanpipe drivers for windows are really different from the Linux version including the API. (for Yate >= 2.0)</div>
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[zapcard]]</font><br/>
 +
<div class="yate-page-desc"> ISDN E1/T1 TDM/FXO/FXS [http://www.asterisk.org/downloads Zaptel] driver. It supports some of the cards made by [http://www.digium.com Digium] - [http://www.digium.com/index.php?menu=wildcard_e100p E100P], [http://www.digium.com/index.php?menu=wildcard_t100p T100P], [http://www.digium.com/en/products/digital/te405p.php TE405P], [http://www.digium.com/en/products/digital/te410p.php TE410P]. (for Yate >= 2.0)</div>
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[wpchan]] </font><br/>
 +
<div class="yate-page-desc"> ISDN E1/T1 driver over Wanpipe for Linux. Supports [http://www.sangoma.com Sangoma] AFT voice series cards. Very efficient. (for Yate < 2.0)</div>
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[wpchanw]] </font><br/>
 +
<div class="yate-page-desc">ISDN E1/T1 driver over Wanpipe for Windows. Wanpipe drivers for windows are really different from the Linux version including the API. (for Yate < 2.0)</div>
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[zapchan]] </font><br/>
 +
<div class="yate-page-desc"> ISDN E1/T1/BRI driver, requires [http://www.asterisk.org/index.php?menu=download Zaptel] and [http://www.asterisk.org/index.php?menu=download libpri] .It supports some of the cards made by [http://www.digium.com Digium] - [http://www.digium.com/index.php?menu=wildcard_e100p E100P], [http://www.digium.com/index.php?menu=wildcard_t100p T100P], [http://www.digium.com/index.php?menu=wildcard_te405p TE405P], [http://www.digium.com/index.php?menu=wildcard_te410p TE410P] or you can use [http://www.voip-info.org/tiki-index.php?page=Asterisk+TDMoE ethernet] emulation and [http://www.voip-info.org/wiki-Asterisk+timer+ztdummy ztdummy] , and also all ISDN BRI cards based on the Cologne chip - [[zaphfc]]. (for Yate < 2.0)</div.
 +
|}
  
 
==[[Signalling]] Modules==
 
==[[Signalling]] Modules==
  
−
:* [[MGCP_call_agent_module|mgcpca]] - MGCP (Media Gateway Control Protocol) - Call Agent
+
{|class="yate-table"
−
:* [[CiscoSM]] - Cisco SLT (Signaling Link Transport) control (SS7 MTP2 backhaul over IP)
+
|class="yate-header-right"|Modules
−
:* [[SigTransport]] - SIGTRAN connection provider (SS7 over IP)
+
|-
−
:* [[LkSCTP]] - SCTP sockets provider using Linux Kernel
+
|class="yate-content-right"|
−
:* [[ISUP Mangler|isupmangler]] - Modifies parameters of ISUP messages passed through in STP mode
+
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[MGCP_call_agent_module|mgcpca]] </font><br/>
 +
<div class="yate-page-desc"> MGCP (Media Gateway Control Protocol) - Call Agent</div>
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[CiscoSM]] </font><br/>
 +
<div class="yate-page-desc"> Cisco SLT (Signaling Link Transport) control (SS7 MTP2 backhaul over IP)</div>
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[SigTransport]]</font><br/>
 +
<div class="yate-page-desc"> SIGTRAN connection provider (SS7 over IP)</div>
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[LkSCTP]] </font><br/>
 +
<div class="yate-page-desc"> SCTP sockets provider using Linux Kernel</div>
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[ISUP Mangler|isupmangler]] </font><br/>
 +
<div class="yate-page-desc"> Modifies parameters of ISUP messages passed through in STP mode</div>
 +
|}
  
 
==[[Routing]] Modules==
 
==[[Routing]] Modules==
−
:* [[Regular expressions|regexroute]] - route with regular expressions
+
 
−
:* [[register]] - route from a database
+
{|class="yate-table"
−
:* [[Javascript_routing|javascript]] - routing using the embedded Javascript language
+
|class="yate-header-right"|Modules
−
:* [[ENUM_Routing|enumroute]] - [http://www.ietf.org/html.charters/enum-charter.html ENUM] based routing
+
|-
−
:* [[clustering]] - forwards calls to other servers in a cluster based on [[Node Name]] (Yate >= 2.0)
+
|class="yate-content-right"|
−
:* [[Call Forker|callfork]] - it can be used for fallback routing, executes a call in parallel or sequence to multiple targets
+
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[Regular expressions|regexroute]] </font><br/>
−
:* [[Late routing Module|lateroute]] - makes a late routing decision, simplifies call forking and divert implementation (Yate >= 2.0)
+
<div class="yate-page-desc"> Route with regular expressions</div>
−
:* [[YRadius]] - routing using a radius server
+
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[register]] </font><br/>
−
:* [[regfile]] - registration and routing from a file
+
<div class="yate-page-desc">Route from a database</div>
−
:* [[Call Counters|callcounters]] - adds active call counters to be used in
+
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[Javascript_routing|javascript]] </font><br/>
−
:* [[ISUP Mangler|isupmangler]] - Modifies parameters of ISUP messages passed through in STP mode
+
<div class="yate-page-desc">Routing using the embedded Javascript language</div>
−
:* [[SIP query for CNAM and LNP|sip_cnam_lnp]] - Perform CNAM and LNP queries via SIP INVITE / 3xx
+
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[ENUM_Routing|enumroute]] </font><br/>
−
:* [[Cache module|cache]] - CNAM and LNP memory caches. Set caller name or routing number if found in cache
+
<div class="yate-page-desc"> [http://www.ietf.org/html.charters/enum-charter.html ENUM] based routing</div>
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[clustering]] </font><br/>
 +
<div class="yate-page-desc">Forwards calls to other servers in a cluster based on [[Node Name]] (Yate >= 2.0)</div>
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[Call Forker|callfork]] </font><br/>
 +
<div class="yate-page-desc">It can be used for fallback routing, executes a call in parallel or sequence to multiple targets</div>
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[Late routing Module|lateroute]] </font><br/>
 +
<div class="yate-page-desc">Makes a late routing decision, simplifies call forking and divert implementation (Yate >= 2.0)</div>
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[YRadius]] </font><br/>
 +
<div class="yate-page-desc">Routing using a radius server</div>
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[regfile]] </font><br/>
 +
<div class="yate-page-desc">Registration and routing from a file</div>
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[Call Counters|callcounters]] </font><br/>
 +
- adds active call counters to be used in
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[ISUP Mangler|isupmangler]] </font><br/>
 +
- Modifies parameters of ISUP messages passed through in STP mode
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[SIP query for CNAM and LNP|sip_cnam_lnp]] </font><br/>
 +
- Perform CNAM and LNP queries via SIP INVITE / 3xx
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[Cache module|cache]] </font><br/>
 +
- CNAM and LNP memory caches. Set caller name or routing number if found in cache
 +
|}
  
 
==Registering Modules==
 
==Registering Modules==
  
−
:* [[accfile]] - this module allows Yate to act as a SIP or H.323 client
+
{|class="yate-table"
−
:* [[regfile]] - registration and routing from a file
+
|class="yate-header-right"|Modules
−
:* [[register]] - register users in a database
+
|-
−
:* [[clustering]] - adds [[Node Name]] information to routes registered with other modules (for Yate 2)
+
|class="yate-content-right"|
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[accfile]] </font><br/>
 +
- this module allows Yate to act as a SIP or H.323 client
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[regfile]] </font><br/>
 +
- registration and routing from a file
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[register]]</font><br/>
 +
- register users in a database
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[clustering]]</font><br/>
 +
- adds [[Node Name]] information to routes registered with other modules (for Yate 2)
 +
|}
  
 
==PBX Modules==
 
==PBX Modules==
  
−
:* [[Music On Hold Module|moh]] - music on hold
+
{|class="yate-table"
−
:* [[conference]] - conference room with arbitrary number of seats
+
|class="yate-header-right"|Modules
−
:* [[Park Module|park]] - call parking
+
|-
−
:* [[Call Pickup|pickup]]
+
|class="yate-content-right"|
−
:* [[pbxassist]] - configurable PBX with hold, transfer and conference capabilities
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Music On Hold Module|moh]] </font><br/>
−
:* [[PBX Module|pbx]] - miscellaneous script-usable PBX features
+
- music on hold
−
:* [[Queues Module|queues]] - queues and distributes incoming calls to operators
+
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[conference]] </font><br/>
−
:* [[dbpbx]] - PBX, IVR and multi routing from a database
+
- conference room with arbitrary number of seats
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[Park Module|park]] </font><br/>
 +
- call parking
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[Call Pickup|pickup]]</font><br/>
 +
- call pickup
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[pbxassist]] </font><br/>
 +
- configurable PBX with hold, transfer and conference capabilities
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[PBX Module|pbx]] </font><br/>
 +
- miscellaneous script-usable PBX features
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[Queues Module|queues]] </font><br/>
 +
queues and distributes incoming calls to operators
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[dbpbx]] </font><br/>
 +
- PBX, IVR and multi routing from a database
 +
|}
  
 
==[[Call Detail Records Modules|CDR]] Modules==
 
==[[Call Detail Records Modules|CDR]] Modules==
  
−
:* [[CDR Build Module|cdrbuild]] module - builds the cdr so other modules can use it
+
{|class="yate-table"
−
:* [[CDR File Module|cdrfile]] module - writes the cdr in a file
+
|class="yate-header-right"|Modules
−
:* [[register]] - writes the cdr in a database
+
|-
−
:* [[Call Counters|callcounters]] - count active calls per user specified context
+
|class="yate-content-right"|
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[CDR Build Module|cdrbuild]] module </font><br/>
 +
- builds the cdr so other modules can use it
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[CDR File Module|cdrfile]] module </font><br/>
 +
- writes the cdr in a file
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[register]] </font><br/>
 +
- writes the cdr in a database
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[Call Counters|callcounters]] </font><br/>
 +
- count active calls per user specified context
 +
|}
  
 
==[[Transcoding]] Modules (codecs)==
 
==[[Transcoding]] Modules (codecs)==
  
−
:* [[gsmcodec]] - GSM 06.10 codec
+
{|class="yate-table"
−
:* [[speexcodec]] - Speex NB, WB and UWB codec
+
|class="yate-header-right"|Modules
−
:* [[ilbccodec]] - iLBC codec
+
|-
−
:* [[amrnbcodec]] - AMR-NB codec
+
|class="yate-content-right"|
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[gsmcodec]] </font><br/>
 +
- GSM 06.10 codec
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[speexcodec]]</font><br/>
 +
- Speex NB, WB and UWB codec
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[ilbccodec]] </font><br/>
 +
- iLBC codec
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[amrnbcodec]] </font><br/>
 +
- AMR-NB codec
 +
|}
  
 
==Test Modules==
 
==Test Modules==
  
−
:* [[Debugging and, or Investigation of messages|msgsniff]] - message sniffer
+
{|class="yate-table"
−
:* [[Call generator|callgen]] - call generator
+
|class="yate-header-right"|Modules
−
:* [[Quality analyzer module|analyzer]] - audio path quality analyzer
+
|-
 +
|class="yate-content-right"|
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[Debugging and, or Investigation of messages|msgsniff]] </font><br/>
 +
- message sniffer
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[Call generator|callgen]] </font><br/>
 +
- call generator
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[Quality analyzer module|analyzer]] </font><br/>
 +
- audio path quality analyzer
 +
|}
  
 
==Remote Control==
 
==Remote Control==
  
−
:* [[rmanager]] - remote manager accessible from telnet
+
{|class="yate-table"
 +
|class="yate-header-right"|Modules
 +
|-
 +
|class="yate-content-right"|
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[rmanager]] </font><br/>
 +
- remote manager accessible from telnet
 +
|}
  
 
==Billing Modules==
 
==Billing Modules==
  
−
:* [[YRadius]] - RADIUS module
+
{|class="yate-table"
−
:* [[register]] - billing in a database
+
|class="yate-header-right"|Modules
 +
|-
 +
|class="yate-content-right"|
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[YRadius]] </font><br/>
 +
- RADIUS module
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[register]] </font><br/>
 +
- billing in a database
 +
|}
  
 
==External Module==
 
==External Module==
  
−
:* [[External Module|extmodule]] - for Linux
+
{|class="yate-table"
 +
|class="yate-header-right"|Modules
 +
|-
 +
|class="yate-content-right"|
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[External Module|extmodule]] </font><br/>
 +
- for Linux
 +
|}
  
 
==Database Drivers==
 
==Database Drivers==
  
−
:* [[PostgreSQL|pgsqldb]] - [http://www.postgresql.org/ PostgreSQL] database driver
+
{|class="yate-table"
−
:* [[MySQL|mysqldb]] - [http://www.mysql.com/ MySQL] database driver
+
|class="yate-header-right"|Modules
 +
|-
 +
|class="yate-content-right"|
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[PostgreSQL|pgsqldb]] </font><br/>
 +
- [http://www.postgresql.org/ PostgreSQL] database driver
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[MySQL|mysqldb]] </font><br/>
 +
- [http://www.mysql.com/ MySQL] database driver
 +
|}
  
 
==Resource subscribe/notify modules==
 
==Resource subscribe/notify modules==
  
−
:* [[SIP Features Module|sipfeatures]] - handle sip.subscribe and resource.notify messages
+
{|class="yate-table"
−
:* [[register]] - writes the subscriptions in the database and notify the subscribers
+
|class="yate-header-right"|Modules
−
:* [[Queues Notify Module|queuesnotify]] - notify changes in the status of queued calls
+
|-
−
:* [[presence]] - implements presence service for SIP clients
+
|class="yate-content-right"|
−
:* [[subscriptions]] - manages rosters
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[SIP Features Module|sipfeatures]] </font><br/>
 +
- handle sip.subscribe and resource.notify messages
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[register]] </font><br/>
 +
- writes the subscriptions in the database and notify the subscribers
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[Queues Notify Module|queuesnotify]] </font><br/>
 +
- notify changes in the status of queued calls
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[presence]] </font><br/>
 +
- implements presence service for SIP clients
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[subscriptions]] </font><br/>
 +
- manages rosters
 +
|}
  
 
==Miscellaneous support modules==
 
==Miscellaneous support modules==
  
−
:* [[Tone detector|tonedetect]] - inband DTMF and Fax tone detector
+
{|class="yate-table"
−
:* [[OpenSSL]] - SSL/TLS sockets provider using the [http://www.openssl.org/ OpenSSL] library
+
|class="yate-header-right"|Modules
−
:* [[LkSCTP]] - SCTP sockets provider using Linux Kernel
+
|-
−
:* [[ccongestion]] - Reject calls based on CPU load (depends on [[cpuload]])
+
|class="yate-content-right"|
−
:* [[gvoice]] - Google Voice support module (Yate 4+)
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[Tone detector|tonedetect]] </font><br/>
 +
- inband DTMF and Fax tone detector
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[OpenSSL]] </font><br/>
 +
- SSL/TLS sockets provider using the [http://www.openssl.org/ OpenSSL] library
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[LkSCTP]] </font><br/>
 +
- SCTP sockets provider using Linux Kernel
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[ccongestion]] </font><br/>
 +
- Reject calls based on CPU load (depends on [[cpuload]])
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[gvoice]] </font><br/>
 +
- Google Voice support module (Yate 4+)
 +
|}
  
 
==GUI Modules==
 
==GUI Modules==
  
−
:* [http://yateclient.yate.ro/ YateClient] - a skinnable Qt4 user interface allowing the use of Yate as an universal [http://www.fcc.gov/voip/ VoIP] client
+
{|class="yate-table"
 +
|class="yate-header-right"|Modules
 +
|-
 +
|class="yate-content-right"|
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [http://yateclient.yate.ro/ YateClient] </font><br/>
 +
- a skinnable Qt4 user interface allowing the use of Yate as an universal [http://www.fcc.gov/voip/ VoIP] client
 +
|}
  
 
==Monitoring==
 
==Monitoring==
  
−
:* [[SNMP Agent|ysnmpagent]] - the SNMP agent
+
{|class="yate-table"
−
:* [[cpuload]] - monitors CPU load
+
|class="yate-header-right"|Modules
−
:* [[monitoring]] - monitors database accounts, QoS, routing, RTP, SIP, etc.
+
|-
−
:* [[eventlogs]] - write events and alarms to log files
+
|class="yate-content-right"|
−
 
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[SNMP Agent|ysnmpagent]]</font><br/>
 +
- the SNMP agent
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[cpuload]] </font><br/>
 +
- monitors CPU load
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[monitoring]] </font><br/>
 +
- monitors database accounts, QoS, routing, RTP, SIP, etc.
 +
<div class="bullet">&nbsp;</div><font class="yate-page-title">:* [[eventlogs]] </font><br/>
 +
- write events and alarms to log files
 +
|}
 
You will note that some modules appear in more than one category because they may implement multiple functions on top of the same protocol or connection.
 
You will note that some modules appear in more than one category because they may implement multiple functions on top of the same protocol or connection.

Revision as of 14:42, 10 January 2013

By default Yate loads modules relevant to its current running mode:

  • all modules from the base module directory
  • in client mode modules from the client subdirectory
    • and all modules from the qt4 subdirectory in the Qt based client
  • in server mode modules from the server subdirectory
    • if yjinglechan is loaded also all modules from the jabber subdirectory

You just need to list all .yate files in those directories. Which exactly are there depends on what dependency libraries are detected at configure time or what packages or components you installed.

Loading of each module is controlled by the base name of each module in the [modules] section of the relevant main config file (yate.conf or yate-qt4.conf). The default is specified by modload= in section [general] of the same file:

  • if modload=yes (default) all modules are loaded if not disabled explicitely
  • if modload=no only explicitely enabled modules are loaded


Contents

Software Drivers

Modules
 
h323chan
VoIP H.323 driver requiring the OpenH323 Library
 
h323chan
VoIP H.323 driver requiring the OpenH323 Library
 
ysipchan
VoIP SIP driver based on our own YASS (Yet Another Sip Stack) library
 
yiaxchan
VoIP IAX2 driver using our own yiax (Yate IAX stack)
 
yjinglechan
VoIP Jingle external component driver using our own XMPP/Jingle (for Yate >= 1.2)
 
ysigchan
SS7/ISDN protocol implementations based on our own signalling library (for Yate >= 2.0)
 
analog
Analog channel (FXS/FXO) implementation based on our own signalling library (for Yate >= 2.0)
 
alsachan
This module supports almost any ALSA driven sound card
 
osschan
This module supports almost any OSS driven sound card
 
tonegen
This module supports the tones (dial,busy,congestion) for Yate
 
wavefile
This module can play or record on a certain channel
 
faxchan
This module can transmit or receive a fax, is based on spandsp
 
yrtpchan
Yate native RTP channel (for Yate >= 0.9)
 
sipfeatures
Implements miscellaneous SIP features
 
dumbchan
A "dumb" channel. most useful for channel-less entities like IVRs
 
dbwave
Play or record to a binary database record
 
mgcpca
MGCP (Media Gateway Control Protocol) - Call Agent
 
jabberserver
Jabber server
 
jbfeatures
Implements miscellaneous Jabber features
 
jabberclient
Jabber client

Hardware Drivers

Modules
 
wpcard
ISDN E1/T1 driver over Wanpipe for Linux. Supports Sangoma AFT voice series cards. Very efficient. (for Yate >= 2.0)
 
wpcardw
ISDN E1/T1 driver over Wanpipe for Windows. Wanpipe drivers for windows are really different from the Linux version including the API. (for Yate >= 2.0)
 
zapcard
ISDN E1/T1 TDM/FXO/FXS Zaptel driver. It supports some of the cards made by Digium - E100P, T100P, TE405P, TE410P. (for Yate >= 2.0)
 
wpchan
ISDN E1/T1 driver over Wanpipe for Linux. Supports Sangoma AFT voice series cards. Very efficient. (for Yate < 2.0)
 
wpchanw
ISDN E1/T1 driver over Wanpipe for Windows. Wanpipe drivers for windows are really different from the Linux version including the API. (for Yate < 2.0)
 
zapchan
ISDN E1/T1/BRI driver, requires Zaptel and libpri .It supports some of the cards made by Digium - E100P, T100P, TE405P, TE410P or you can use ethernet emulation and ztdummy , and also all ISDN BRI cards based on the Cologne chip - zaphfc. (for Yate < 2.0)</div.

Signalling Modules

Modules
 
mgcpca
MGCP (Media Gateway Control Protocol) - Call Agent
 
CiscoSM
Cisco SLT (Signaling Link Transport) control (SS7 MTP2 backhaul over IP)
 
SigTransport
SIGTRAN connection provider (SS7 over IP)
 
LkSCTP
SCTP sockets provider using Linux Kernel
 
isupmangler
Modifies parameters of ISUP messages passed through in STP mode

Routing Modules

Modules
 
regexroute
Route with regular expressions
 
register
Route from a database
 
javascript
Routing using the embedded Javascript language
 
enumroute
ENUM based routing
 
clustering
Forwards calls to other servers in a cluster based on Node Name (Yate >= 2.0)
 
callfork
It can be used for fallback routing, executes a call in parallel or sequence to multiple targets
 
lateroute
Makes a late routing decision, simplifies call forking and divert implementation (Yate >= 2.0)
 
YRadius
Routing using a radius server
 
regfile
Registration and routing from a file
 
callcounters

- adds active call counters to be used in

 
isupmangler

- Modifies parameters of ISUP messages passed through in STP mode

 
sip_cnam_lnp

- Perform CNAM and LNP queries via SIP INVITE / 3xx

 
cache

- CNAM and LNP memory caches. Set caller name or routing number if found in cache

Registering Modules

Modules
 
:* accfile

- this module allows Yate to act as a SIP or H.323 client

 
:* regfile

- registration and routing from a file

 
:* register
- register users in a database
 
:* clustering
- adds Node Name information to routes registered with other modules (for Yate 2)

PBX Modules

Modules
 
moh

- music on hold

 
conference

- conference room with arbitrary number of seats

 
park

- call parking

 
pickup

- call pickup

 
pbxassist

- configurable PBX with hold, transfer and conference capabilities

 
pbx

- miscellaneous script-usable PBX features

 
queues 
queues and distributes incoming calls to operators
 
dbpbx

- PBX, IVR and multi routing from a database

CDR Modules

Modules
 
:* cdrbuild module

- builds the cdr so other modules can use it

 
:* cdrfile module

- writes the cdr in a file

 
:* register

- writes the cdr in a database

 
:* callcounters

- count active calls per user specified context

Transcoding Modules (codecs)

Modules
 
:* gsmcodec

- GSM 06.10 codec

 
:* speexcodec
- Speex NB, WB and UWB codec
 
:* ilbccodec

- iLBC codec

 
:* amrnbcodec

- AMR-NB codec

Test Modules

Modules
 
:* msgsniff

- message sniffer

 
:* callgen

- call generator

 
:* analyzer

- audio path quality analyzer

Remote Control

Modules
 
:* rmanager

- remote manager accessible from telnet

Billing Modules

Modules
 
:* YRadius

- RADIUS module

 
:* register

- billing in a database

External Module

Modules
 
:* extmodule

- for Linux

Database Drivers

Modules
 
:* pgsqldb

- PostgreSQL database driver

 
:* mysqldb

- MySQL database driver

Resource subscribe/notify modules

Modules
 
:* sipfeatures

- handle sip.subscribe and resource.notify messages

 
:* register

- writes the subscriptions in the database and notify the subscribers

 
:* queuesnotify

- notify changes in the status of queued calls

 
:* presence

- implements presence service for SIP clients

 
:* subscriptions

- manages rosters

Miscellaneous support modules

Modules
 
:* tonedetect

- inband DTMF and Fax tone detector

 
:* OpenSSL

- SSL/TLS sockets provider using the OpenSSL library

 
:* LkSCTP

- SCTP sockets provider using Linux Kernel

 
:* ccongestion

- Reject calls based on CPU load (depends on cpuload)

 
:* gvoice

- Google Voice support module (Yate 4+)

GUI Modules

Modules
 
:* YateClient

- a skinnable Qt4 user interface allowing the use of Yate as an universal VoIP client

Monitoring

Modules
 
:* ysnmpagent
- the SNMP agent
 
:* cpuload

- monitors CPU load

 
:* monitoring

- monitors database accounts, QoS, routing, RTP, SIP, etc.

 
:* eventlogs

- write events and alarms to log files

You will note that some modules appear in more than one category because they may implement multiple functions on top of the same protocol or connection.
Retrieved from "https://docs.yate.ro/wiki/index.php?title=Modules&oldid=3173"
Personal tools
Namespaces

Variants
Actions
Preface
Configuration
Administrators
Developers