Modules

Latest revision as of 15:25, 1 October 2019

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.

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 explicitly
if modload=no only explicitly enabled modules are loaded

1 Software Drivers
2 Hardware Drivers
3 Signalling Modules
4 Routing Modules
5 Registering Modules
6 PBX Modules
7 CDR Modules
8 Transcoding Modules (codecs)
9 Test Modules
10 Remote Control
11 Billing Modules
12 External Module
13 Database Drivers
14 Resource subscribe/notify modules
15 SS7
16 Miscellaneous support modules
17 GUI Modules
18 Monitoring
19 Private Modules

[edit] Software Drivers

Modules

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

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

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

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

regfile

Registration and routing from a file

lateroute

Makes a late routing decision, simplifies call forking and divert implementation (Yate >= 2.0)

YRadius

Routing using a radius server

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

Ysigchan

This module is based on the signalling library and uses driver module(s) (e.g. zapcard, wpcard) to create interfaces and circuits used to transfer signalling packets and audio data.

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

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

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

cdrcombine

Transforms mutliple cdr entries(per each call leg) to single cdr entry(per call).

[edit] Transcoding Modules (codecs)

Modules

gsmcodec

GSM 06.10 codec

speexcodec

Speex NB, WB and UWB codec

ilbccodec

iLBC codec

amrnbcodec

AMR-NB codec

[edit] Test Modules

Modules

msgsniff

Message sniffer

callgen

Call generator

analyzer

Audio path quality analyzer

[edit] Remote Control

Modules

rmanager

Remote manager accessible from telnet

[edit] Billing Modules

Modules

register

Billing in a database

YRadius

RADIUS module

[edit] External Module

Modules

extmodule

External module allows you to use a channel or global scripts in Yate.

[edit] Database Drivers

Modules

pgsqldb

PostgreSQL database driver

mysqldb

MySQL database driver

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

[edit] SS7

Modules

Signalling

Introduction on how the PSTN signalling modules are working together in Yate

MGCP call agent module

Allows Yate to control analog or digital Media Gateways

LkSCTP

Provides support for SCTP sockets based on the Linux kernel implementation

Ysigchan

Signalling module

ISUP Mangler

Allows intercepting and mangling ISUP messages that pass through the STP.

SigTransport

Standard factory for the common lower layer of SIGTRAN protocols

CiscoSM

Implements signal link backhauling using the Cisco Signaling Link Terminal protocol

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

[edit] GUI Modules

Modules

YateClient

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

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

[edit] Private Modules

Modules

ydiameter

Diameter protocol support.

HTTP Client

Provides HTTP client connections

Note: Some modules appear in more than one category because they may implement multiple functions on top of the same protocol or connection.

See also

How To's

Modules

Latest revision as of 15:25, 1 October 2019

Contents

[edit] Software Drivers

[edit] Hardware Drivers

[edit] Signalling Modules

[edit] Routing Modules

[edit] Registering Modules

[edit] PBX Modules

[edit] CDR Modules

[edit] Transcoding Modules (codecs)

[edit] Test Modules

[edit] Remote Control

[edit] Billing Modules

[edit] External Module

[edit] Database Drivers

[edit] Resource subscribe/notify modules

[edit] SS7

[edit] Miscellaneous support modules

[edit] GUI Modules

[edit] Monitoring

[edit] Private Modules

Personal tools

Namespaces

Variants

Views

Actions

Search

Preface

Configuration

Administrators

Developers

@@ Line 18: / Line 18: @@
 {|class="yate-table"
-|class="yate-header-right"|Modules
+|class="yate-header-right" colspan="2"|Modules
 |-
-|class="yate-content-right"|
+|class="yate-content-left"|
 * [[H323_channel_module|h323chan]]
 VoIP H.323 driver requiring the [http://yate.null.ro/tarballs/openh323/ OpenH323] Library
@@ Line 39: / Line 39: @@
 * [[tonegen]]
 This module supports the tones (dial,busy,congestion) for Yate
+|class="yate-content-right"|
 * [[wavefile]]
 This module can play or record on a certain channel
@@ Line 64: / Line 66: @@
 {|class="yate-table"
-|class="yate-header-right"|Modules
+|class="yate-header-right" colspan="2"|Modules
 |-
-|class="yate-content-right"|
+|class="yate-content-left"|
 * [[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)
 * [[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-content-right"|
 * [[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)
@@ Line 85: / Line 88: @@
 {|class="yate-table"
-|class="yate-header-right"|Modules
+|class="yate-header-right" colspan="2"|Modules
 |-
-|class="yate-content-right"|
+|class="yate-content-left"|
 * [[MGCP_call_agent_module|mgcpca]]
 MGCP (Media Gateway Control Protocol) - Call Agent
@@ Line 94: / Line 97: @@
 * [[SigTransport]]
 SIGTRAN connection provider (SS7 over IP)
+|class="yate-content-right"|
 * [[LkSCTP]]
 SCTP sockets provider using Linux Kernel
@@ Line 103: / Line 107: @@
 {|class="yate-table"
-|class="yate-header-right"|Modules
+|class="yate-header-right" colspan="2"|Modules
 |-
-|class="yate-content-right"|
+|class="yate-content-left"|
 * [[Regular expressions|regexroute]]
 Route with regular expressions
 * [[register]]
 Route from a database
-* [[Javascript_routing|javascript]]
+* [[Javascript_module|javascript]]
 Routing using the embedded Javascript language
 * [[ENUM_Routing|enumroute]]
@@ Line 118: / Line 122: @@
 * [[Call Forker|callfork]]
 It can be used for fallback routing, executes a call in parallel or sequence to multiple targets
+* [[regfile]]
+Registration and routing from a file
+|class="yate-content-right"|
 * [[Late routing Module|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
 * [[Call Counters|callcounters]]
 Adds active call counters to be used in
@@ Line 132: / Line 138: @@
 * [[Cache module|cache]]
 CNAM and LNP memory caches. Set caller name or routing number if found in cache
+* [[Ysigchan]]
+This module is based on the signalling library and uses driver module(s) (e.g. zapcard, wpcard) to create interfaces and circuits used to transfer signalling packets and audio data.
 |}
@@ Line 137: / Line 145: @@
 {|class="yate-table"
-|class="yate-header-right"|Modules
+|class="yate-header-right" colspan="2"|Modules
 |-
-|class="yate-content-right"|
+|class="yate-content-left"|
 * [[accfile]]
 This module allows Yate to act as a SIP or H.323 client
 * [[regfile]]
 Registration and routing from a file
+|class="yate-content-right"|
 * [[register]]
 Register users in a database
@@ Line 153: / Line 163: @@
 {|class="yate-table"
-|class="yate-header-right"|Modules
+|class="yate-header-right" colspan="2"|Modules
 |-
-|class="yate-content-right"|
+|class="yate-content-left"|
 * [[Music On Hold Module|moh]]
 Music on hold
@@ Line 164: / Line 174: @@
 * [[Call Pickup|pickup]]
 Call pickup
+|class="yate-content-right"|
 * [[pbxassist]]
 Configurable PBX with hold, transfer and conference capabilities
@@ Line 177: / Line 189: @@
 {|class="yate-table"
-|class="yate-header-right"|Modules
+|class="yate-header-right" colspan="2"|Modules
 |-
-|class="yate-content-right"|
+|class="yate-content-left"|
 * [[CDR Build Module|cdrbuild]] module
 Builds the cdr so other modules can use it
@@ Line 186: / Line 198: @@
 * [[register]]
 Writes the cdr in a database
+|class="yate-content-right"|
 * [[Call Counters|callcounters]]
 Count active calls per user specified context
@@ Line 195: / Line 208: @@
 {|class="yate-table"
-|class="yate-header-right"|Modules
+|class="yate-header-right" colspan="2"|Modules
 |-
-|class="yate-content-right"|
+|class="yate-content-left"|
 * [[gsmcodec]]
 GSM 06.10 codec
 * [[speexcodec]]
 Speex NB, WB and UWB codec
+|class="yate-content-right"|
 * [[ilbccodec]]
 iLBC codec
@@ Line 211: / Line 226: @@
 {|class="yate-table"
-|class="yate-header-right"|Modules
+|class="yate-header-right" colspan="2"|Modules
 |-
+|class="yate-content-left"|
+* [[Debugging and, or Investigation of messages|msgsniff]]
+Message sniffer
+* [[Call generator|callgen]]
+Call generator
 |class="yate-content-right"|
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Debugging and, or Investigation of messages|msgsniff]] </font><br/>
+* [[Quality analyzer module|analyzer]]
-<div class="yate-page-desc">Message sniffer</div>
+Audio path quality analyzer
-<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[Call generator|callgen]] </font><br/>
-<div class="yate-page-desc">Call generator</div>
-<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[Quality analyzer module|analyzer]] </font><br/>
-<div class="yate-page-desc">Audio path quality analyzer</div>
 |}
@@ Line 225: / Line 242: @@
 {|class="yate-table"
-|class="yate-header-right"|Modules
+|class="yate-header-right" colspan="2"|Modules
 |-
+|class="yate-content-left"|
+* [[rmanager]]
+Remote manager accessible from telnet
 |class="yate-content-right"|
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[rmanager]] </font><br/>
-<div class="yate-page-desc">Remote manager accessible from telnet</div>
 |}
@@ Line 235: / Line 254: @@
 {|class="yate-table"
-|class="yate-header-right"|Modules
+|class="yate-header-right" colspan="2"|Modules
 |-
+|class="yate-content-left"|
+* [[register]]
+Billing in a database
 |class="yate-content-right"|
-<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[YRadius]] </font><br/>
+* [[YRadius]]
-<div class="yate-page-desc"> RADIUS module</div>
+RADIUS module
-<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[register]] </font><br/>
-<div class="yate-page-desc">Billing in a database</div>
 |}
@@ Line 247: / Line 267: @@
 {|class="yate-table"
-|class="yate-header-right"|Modules
+|class="yate-header-right" colspan="2"|Modules
 |-
+|class="yate-content-left"|
+* [[External Module|extmodule]]
+External module allows you to use a channel or global scripts in Yate.
 |class="yate-content-right"|
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[External Module|extmodule]] </font><br/>
-<div class="yate-page-desc">External module allows you to use a channel or global scripts in Yate. </div>
 |}
@@ Line 257: / Line 279: @@
 {|class="yate-table"
-|class="yate-header-right"|Modules
+|class="yate-header-right" colspan="2"|Modules
 |-
+|class="yate-content-left"|
+* [[PostgreSQL|pgsqldb]]
+[http://www.postgresql.org/ PostgreSQL] database driver
 |class="yate-content-right"|
-<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[PostgreSQL|pgsqldb]] </font><br/>
+* [[MySQL|mysqldb]]
-<div class="yate-page-desc"> [http://www.postgresql.org/ PostgreSQL] database driver</div>
+[http://www.mysql.com/ MySQL] database driver
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[MySQL|mysqldb]] </font><br/>
-<div class="yate-page-desc"> [http://www.mysql.com/ MySQL] database driver</div>
 |}
@@ Line 269: / Line 293: @@
 {|class="yate-table"
-|class="yate-header-right"|Modules
+|class="yate-header-right" colspan="2"|Modules
 |-
+|class="yate-content-left"|
+* [[SIP Features Module|sipfeatures]]
+Handle sip.subscribe and resource.notify messages
+* [[register]]
+Writes the subscriptions in the database and notify the subscribers
+* [[Queues Notify Module|queuesnotify]]
+Notify changes in the status of queued calls
+|class="yate-content-right"|
+* [[presence]]
+Implements presence service for SIP clients
+* [[subscriptions]]
+Manages rosters
+|}
+==SS7==
+{|class="yate-table"
+|class="yate-header-right" colspan="2"|Modules
+|-
+|class="yate-content-left"|
+*[[Signalling|Signalling]]
+Introduction on how the PSTN signalling modules are working together in Yate
+*[[MGCP call agent module|MGCP call agent module]]
+Allows Yate to control analog or digital Media Gateways
+* [[LkSCTP|LkSCTP]]
+Provides support for SCTP sockets based on the Linux kernel implementation
+*[[Ysigchan|Ysigchan]]
+Signalling module
 |class="yate-content-right"|
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[SIP Features Module|sipfeatures]] </font><br/>
+*[[ISUP Mangler|ISUP Mangler]]
-<div class="yate-page-desc">Handle sip.subscribe and resource.notify messages</div>
+Allows intercepting and mangling ISUP messages that pass through the STP.
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[register]] </font><br/>
+*[[SigTransport|SigTransport]]
-<div class="yate-page-desc">Writes the subscriptions in the database and notify the subscribers</div>
+Standard factory for the common lower layer of SIGTRAN protocols
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Queues Notify Module|queuesnotify]] </font><br/>
+*[[CiscoSM]]
-<div class="yate-page-desc">Notify changes in the status of queued calls</div>
+Implements signal link backhauling using the Cisco Signaling Link Terminal protocol
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[presence]] </font><br/>
-<div class="yate-page-desc">Implements presence service for SIP clients</div>
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[subscriptions]] </font><br/>
-<div class="yate-page-desc">Manages rosters</div>
 |}
@@ Line 287: / Line 337: @@
 {|class="yate-table"
-|class="yate-header-right"|Modules
+|class="yate-header-right" colspan="2"|Modules
 |-
+|class="yate-content-left"|
+* [[Tone detector|tonedetect]]
+Inband DTMF and Fax tone detector
+* [[OpenSSL]]
+SSL/TLS sockets provider using the [http://www.openssl.org/ OpenSSL] library
+* [[LkSCTP]]
+SCTP sockets provider using Linux Kernel
 |class="yate-content-right"|
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[Tone detector|tonedetect]] </font><br/>
+* [[ccongestion]]
-<div class="yate-page-desc">Inband DTMF and Fax tone detector</div>
+Reject calls based on CPU load (depends on [[cpuload]])
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[OpenSSL]] </font><br/>
+* [[gvoice]]
-<div class="yate-page-desc">SSL/TLS sockets provider using the [http://www.openssl.org/ OpenSSL] library</div>
+Google Voice support module (Yate 4+)
-<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">[[ccongestion]] </font><br/>
-<div class="yate-page-desc">Reject calls based on CPU load (depends on [[cpuload]])</div>
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[gvoice]] </font><br/>
-<div class="yate-page-desc">Google Voice support module (Yate 4+)</div>
 |}
@@ Line 305: / Line 357: @@
 {|class="yate-table"
-|class="yate-header-right"|Modules
+|class="yate-header-right" colspan="2"|Modules
 |-
+|class="yate-content-left"|
+* [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-content-right"|
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[http://yateclient.yate.ro/ YateClient] </font><br/>
-<div class="yate-page-desc">A skinnable Qt4 user interface allowing the use of Yate as an universal [http://www.fcc.gov/voip/ VoIP] client</div>
 |}
@@ Line 315: / Line 369: @@
 {|class="yate-table"
-|class="yate-header-right"|Modules
+|class="yate-header-right" colspan="2"|Modules
 |-
+|class="yate-content-left"|
+* [[SNMP Agent|ysnmpagent]]
+The SNMP agent
+* [[cpuload]]
+Monitors CPU load
 |class="yate-content-right"|
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[SNMP Agent|ysnmpagent]]</font><br/>
+* [[monitoring]]
-<div class="yate-page-desc">The SNMP agent</div>
+Monitors database accounts, QoS, routing, RTP, SIP, etc.
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[cpuload]] </font><br/>
+* [[eventlogs]]
-<div class="yate-page-desc">Monitors CPU load</div>
+Write events and alarms to log files.
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[monitoring]] </font><br/>
-<div class="yate-page-desc">Monitors database accounts, QoS, routing, RTP, SIP, etc.</div>
-<div class="bullet">&nbsp;</div><font class="yate-page-title">[[eventlogs]] </font><br/>
-<div class="yate-page-desc">Write events and alarms to log files.</div>
 |}
-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.
+==Private Modules==
+{|class="yate-table"
+|class="yate-header-right" colspan="2"|Modules
+|-
+|class="yate-content-left"|
+* [[ydiameter]]
+Diameter protocol support.
+|class="yate-content-right"|
+* [[HTTP Client]]
+Provides HTTP client connections
+|}
+ Note: Some modules appear in more than one category because they may implement multiple functions on top of the same protocol or connection.
@@ Line 334: / Line 403: @@
 * [[How To's]]
+[[Category:Administrate]]