Modules

From Yate Documentation
(Difference between revisions)
Jump to: navigation, search
(Created page with " Software Drivers ** h323chan - VoIP H.323 driver requiring the [http://www.voxgratia.org/modules/news/ OpenH323] Library ** ysipchan - VoIP SIP driver based on Yass (...")
 
Line 1: Line 1:
  
−
Software Drivers
+
==Software Drivers==
−
** [[h323chan]] - VoIP H.323 driver requiring the [http://www.voxgratia.org/modules/news/ OpenH323] Library
+
−
** [[ysipchan]] - VoIP SIP driver based on Yass (Yet Another Sip Stack)
+
−
** [[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 [http://soft-switch.org/ 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
+
:* [[h323chan]] - VoIP H.323 driver requiring the [http://www.voxgratia.org/modules/news/ OpenH323] Library
−
** [[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)
+
:* [[ysipchan]] - VoIP SIP driver based on Yass (Yet Another Sip Stack)
−
** [[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)
+
:* [[yiaxchan]] - VoIP IAX2 driver using our own [[yiax]] (Yate IAX stack)
−
** [[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)
+
:* [[yjinglechan]] - VoIP Jingle external component driver using our own XMPP/Jingle (for Yate >= 1.2)
−
** [[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)
+
:* [[ysigchan]] - SS7/ISDN protocol implementations based on our own [[signalling]] library (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)
+
:* [[analog]] - Analog channel (FXS/FXO) implementation based on our own [[signalling]] library  (for Yate >= 2.0)
−
** [[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)
+
:* [[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 [http://soft-switch.org/ 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
  
−
[[Signalling]] modules
+
==Hardware drivers==
−
** [[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
+
:* [[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)
−
** [[Regular expressions|regexroute]] - route with regular expressions
+
:* [[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)
−
** [[register]] - route from a database
+
:* [[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)
−
** [[JavascriptRouting|javascript]] - routing using the embedded Javascript language
+
:* [[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)
−
** [[enumroute]] - [[http://www.ietf.org/html.charters/enum-charter.html|ENUM]] based routing
+
:* [[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)
−
** [[clustering]] - forwards calls to other servers in a cluster based on [[node name]] (for Yate 2)
+
:* [[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)
−
** [[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 (for Yate 2)
+
−
** [[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
+
==[[Signalling]] 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
+
:* [[mgcpca]] - MGCP (Media Gateway Control Protocol) - Call Agent
−
** [[moh]] - music on hold
+
:* [[ciscosm]] - Cisco SLT (Signaling Link Transport) control (SS7 MTP2 backhaul over IP)
−
** [[conference]] - conference room with arbitrary number of seats
+
:* [[sigtransport]] - SIGTRAN connection provider (SS7 over IP)
−
** [[park]] - call parking
+
:* [[lksctp]] - SCTP sockets provider using Linux Kernel
−
** [[pbxassist]] - configurable PBX with hold, transfer and conference capabilities
+
:* [[isupmangler]] - Modifies parameters of ISUP messages passed through in STP mode
−
** [[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
+
==[[Routing]] modules==
−
** [[cdrbuild]] module - builds the cdr so other modules can use it
+
:* [[Regular expressions|regexroute]] - route with regular expressions
−
** [[cdrfile]] module - writes the cdr in a file
+
:* [[register]] - route from a database
−
** [[register]] - writes the cdr in a database
+
:* [[JavascriptRouting|javascript]] - routing using the embedded Javascript language
−
** [[callcounters]] - count active calls per user specified context
+
:* [[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]] (for Yate 2)
 +
:* [[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 (for Yate 2)
 +
:* [[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
  
−
[[Transcoding]] modules (codecs)
+
==Registering modules==
−
** [[gsmcodec]] - GSM 06.10 codec
+
−
** [[speexcodec]] - Speex NB, WB and UWB codec
+
−
** [[ilbccodec]] - iLBC codec
+
−
** [[amrnbcodec]] - AMR-NB codec
+
  
−
Test modules
+
:* [[accfile]] - this module allows Yate to act as a SIP or H.323 client
−
** [[msgsniff]] - message sniffer
+
:* [[regfile]] - registration and routing from a file
−
** [[callgen]] - call generator
+
:* [[register]] - register users in a database
−
** [[analyzer]] - audio path quality analyzer
+
:* [[clustering]] - adds [[node name]] information to routes registered with other modules (for Yate 2)
  
−
Remote control
+
==PBX modules==
−
** [[rmanager]] - remote manager accessible from telnet
+
  
−
Billing modules
+
:* [[moh]] - music on hold
−
** [[YRadius]] - RADIUS module
+
:* [[conference]] - conference room with arbitrary number of seats
−
** [[register]] - billing in a database
+
:* [[park]] - call parking
 +
:* [[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
  
−
External module
+
==Cdr modules==
−
** [[extmodule]] - for Linux
+
  
−
Database drivers
+
:* [[cdrbuild]] module - builds the cdr so other modules can use it
−
** [[pgsqldb]] - [http://www.postgresql.org/ PostgreSQL] database driver
+
:* [[cdrfile]] module - writes the cdr in a file
−
** [[mysqldb]] - [http://www.mysql.com/ MySQL] database driver
+
:* [[register]] - writes the cdr in a database
 +
:* [[callcounters]] - count active calls per user specified context
  
−
Resource subscribe/notify modules
+
==[[Transcoding]] modules (codecs)==
−
** [[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
+
−
** [[subscription]] - manages rosters
+
  
−
Miscellaneous support modules
+
:* [[gsmcodec]] - GSM 06.10 codec
−
** [[tonedetect]] - inband DTMF and Fax tone detector
+
:* [[speexcodec]] - Speex NB, WB and UWB codec
−
** [[openssl]] - SSL/TLS sockets provider using the [http://www.openssl.org/ OpenSSL] library
+
:* [[ilbccodec]] - iLBC codec
−
** [[lksctp]] - SCTP sockets provider using Linux Kernel
+
:* [[amrnbcodec]] - AMR-NB codec
−
** [[ccongestion]] - Reject calls based on CPU load (depends on [[cpuload]])
+
  
−
GUI modules
+
==Test modules==
−
** [[YateClient]] - a skinnable Qt4 user interface allowing the use of Yate as an universal [http://www.fcc.gov/voip/ VoIP] client
+
  
−
Monitoring
+
:* [[msgsniff]] - message sniffer
−
** [[ysnmpagent]] - the SNMP agent
+
:* [[callgen]] - call generator
−
** [[cpuload]] - monitors CPU load
+
:* [[analyzer]] - audio path quality analyzer
−
** [[monitoring]] - monitors database accounts, QoS, routing, RTP, SIP, etc.
+
 
−
** [[eventlogs]] - write events and alarms to log files
+
==Remote control==
 +
 
 +
:* [[rmanager]] - remote manager accessible from telnet
 +
 
 +
==Billing modules==
 +
 
 +
:* [[YRadius]] - RADIUS module
 +
:* [[register]] - billing in a database
 +
 
 +
==External module==
 +
 
 +
:* [[extmodule]] - for Linux
 +
 
 +
==Database drivers==
 +
 
 +
:* [[pgsqldb]] - [http://www.postgresql.org/ PostgreSQL] database driver
 +
:* [[mysqldb]] - [http://www.mysql.com/ MySQL] database driver
 +
 
 +
==Resource subscribe/notify 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
 +
:* [[subscription]] - manages rosters
 +
 
 +
==Miscellaneous support modules==
 +
 
 +
:* [[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
 +
:* [[ccongestion]] - Reject calls based on CPU load (depends on [[cpuload]])
 +
 
 +
==GUI modules==
 +
 
 +
:* [[YateClient]] - a skinnable Qt4 user interface allowing the use of Yate as an universal [http://www.fcc.gov/voip/ VoIP] client
 +
 
 +
==Monitoring==
 +
 
 +
:* [[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.
 
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 15:34, 16 October 2012

Contents

Software Drivers

  • h323chan - VoIP H.323 driver requiring the OpenH323 Library
  • ysipchan - VoIP SIP driver based on Yass (Yet Another Sip Stack)
  • 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

  • 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)

Signalling 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

  • regexroute - route with regular expressions
  • register - route from a database
  • javascript - routing using the embedded Javascript language
  • enumroute - [[1]] based routing
  • clustering - forwards calls to other servers in a cluster based on node name (for Yate 2)
  • 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 (for Yate 2)
  • 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

  • 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

  • moh - music on hold
  • conference - conference room with arbitrary number of seats
  • park - call parking
  • 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

  • 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)

Test modules

Remote control

  • rmanager - remote manager accessible from telnet

Billing modules

External module

Database drivers

Resource subscribe/notify 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
  • subscription - manages rosters

Miscellaneous support modules

GUI modules

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

Monitoring

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=852"
Personal tools
Namespaces

Variants
Actions
Preface
Configuration
Administrators
Developers