Modules

Revision as of 12:07, 8 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

Software Drivers

• 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

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

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

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

• gsmcodec - GSM 06.10 codec
• speexcodec - Speex NB, WB and UWB codec
• ilbccodec - iLBC codec
• amrnbcodec - AMR-NB codec

Test Modules

• msgsniff - message sniffer
• callgen - call generator
• analyzer - audio path quality analyzer

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 - PostgreSQL database driver
• mysqldb - 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
• subscriptions - manages rosters

Miscellaneous support 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

• YateClient - a skinnable Qt4 user interface allowing the use of Yate as an universal 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.