Standard Messages

From Yate Documentation
(Difference between revisions)
Jump to: navigation, search
(Call messages)
(Miscellaneous messages)
 
(41 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
 +
Below you will find a list with all standards messages in Yate.
 +
 +
The main component of Yate are messages. Modules are passing around messages between them. This allows us to have a bigger flexibility than functions, mainly because messages in Yate can have an arbitrary number of parameters.
 +
 
== Engine messages==
 
== Engine messages==
  
      [[engine.start]]
+
{|class="yate-table"
      [[engine.stop]]
+
|class="yate-header-right"|Messages
      [[engine.halt]]
+
|-
      [[engine.init]]
+
|class="yate-content-right"|
      [[engine.busy]]
+
* [[engine.start]]
      [[engine.help]]
+
* [[engine.stop]]
      [[engine.command]]
+
* [[engine.halt]]
      [[engine.status]]
+
* [[engine.init]]
      [[engine.timer]]
+
* [[engine.busy]]
      [[engine.cipher]]
+
* [[engine.help]]
      [[module.update]]
+
* [[engine.command]]
 +
* [[engine.status]]
 +
* [[engine.timer]]
 +
* [[engine.cipher]]
 +
* [[module.update]]
 +
|}
  
 
==Channel messages==
 
==Channel messages==
  
      [[chan.attach]]
+
{|class="yate-table"
      [[chan.connected]]
+
|class="yate-header-right"|Messages
      [[chan.disconnected]]
+
|-
      [[chan.dtmf]]
+
|class="yate-content-right"|
      [[chan.hangup]]
+
* [[chan.attach]]
      [[chan.masquerade]]
+
* [[chan.connected]]
      [[chan.notify]]
+
* [[chan.disconnected]]
      [[chan.record]]
+
* [[chan.dtmf]]
      [[chan.rtp]]
+
* [[chan.hangup]]
      [[chan.startup]]
+
* [[chan.masquerade]]
      [[chan.text]]
+
* [[chan.notify]]
      [[chan.connect]]
+
* [[chan.record]]
      [[chan.locate]]
+
* [[chan.rtp]]
      [[chan.control]]
+
* [[chan.startup]]
      [[chan.replaced]]
+
* [[chan.text]]
      [[chan.transfer]]
+
* [[chan.connect]]
 +
* [[chan.locate]]
 +
* [[chan.control]]
 +
* [[chan.replaced]]
 +
* [[chan.transfer]]
 +
* [[chan.operation]]
 +
|}
  
 
== Call messages==
 
== Call messages==
  
      [[call.answered]]
+
{|class="yate-table"
      [[call.cdr]]
+
|class="yate-header-right"|Messages
      [[call.drop]]
+
|-
      [[call.execute]]
+
|class="yate-content-right"|
      [[call.progress]]
+
* [[call.answered]]
      [[call.ringing]]
+
* [[call.cdr]]
      [[call.route]]
+
* [[call.drop]]
      [[call.preroute]]
+
* [[call.execute]]
      [[call.update]]
+
* [[call.progress]]
      [[call.conference]]
+
* [[call.ringing]]
      [[mwi]]
+
* [[call.route]]
 +
* [[call.preroute]]
 +
* [[call.update]]
 +
* [[call.conference]]
 +
* [[mwi]]
 +
|}
  
 
== User messages==
 
== User messages==
  
      [[user.account]]
+
{|class="yate-table"
 
+
|class="yate-header-right"|Messages
      [[user.auth]]
+
|-
 
+
|class="yate-content-right"|
      [[user.login]]
+
* [[user.auth]]
 
+
* [[user.account]]
      [[user.notify]]
+
* [[user.login]]
 
+
* [[user.notify]]
      [[user.register]]
+
* [[user.register]]
 
+
* [[user.unregister]]
      [[user.unregister]]
+
* [[user.roster]]
 
+
* [[user.update]]
      [[user.roster]]
+
|}
 
+
      [[user.update]]
+
  
 
== Resource subscribe/notify messages==
 
== Resource subscribe/notify messages==
  
      [[resource.subscribe]]
+
{|class="yate-table"
 
+
|class="yate-header-right"|Messages
      [[resource.notify]]
+
|-
 +
|class="yate-content-right"|
 +
* [[resource.subscribe]]
 +
* [[resource.notify]]
 +
|}
  
 
== SIP messages==
 
== SIP messages==
  
      [[SIP Generic Message|sip.methodname]]
+
{|class="yate-table"
      [[xsip.generate]]
+
|class="yate-header-right"|Messages
 +
|-
 +
|class="yate-content-right"|
 +
* [[SIP Generic Message|sip.<methodname>]]
 +
* [[xsip.generate]]
 +
|}
  
 
== Encode or decode protocol specific messages==
 
== Encode or decode protocol specific messages==
  
      [[isup.decode]]
+
{|class="yate-table"
 
+
|class="yate-header-right"|Messages
      [[isup.encode]]
+
|-
 
+
|class="yate-content-right"|
      [[isup.mangle]]
+
* [[isup.decode]]
 
+
* [[isup.encode]]
      [[sccp.generate]]
+
* [[sccp.generate]]
 +
|}
  
 
== Socket operation messages==
 
== Socket operation messages==
  
      [[socket.stun]]
 
 
      [[socket.ssl]]
 
 
      [[socket.peel]]
 
  
      [[socket.sctp]]
+
{|class="yate-table"
 +
|class="yate-header-right"|Messages
 +
|-
 +
|class="yate-content-right"|
 +
* [[socket.stun]]
 +
* [[socket.ssl]]
 +
* [[socket.sctp]]
 +
|}
  
 
== Clustering related messages==
 
== Clustering related messages==
  
      [[cluster.locate]]
+
{|class="yate-table"
 
+
|class="yate-header-right"|Messages
      [[cluster.send]]
+
|-
 +
|class="yate-content-right"|
 +
* [[cluster.locate]]
 +
* [[cluster.send]]
 +
|}
  
 
== Instant messaging related messages==
 
== Instant messaging related messages==
  
      [[msg.route]]
+
{|class="yate-table"
 
+
|class="yate-header-right"|Messages
      [[msg.execute]]
+
|-
 
+
|class="yate-content-right"|
      [[contact.info]]
+
* [[msg.route]]
 +
* [[msg.execute]]
 +
* [[contact.info]]
 +
|}
  
 
== Jabber / XMPP messages==
 
== Jabber / XMPP messages==
 +
 +
{|class="yate-table"
 +
|class="yate-header-right"|Messages
 +
|-
 +
|class="yate-content-right"|
 +
* [[xmpp.iq]]
 +
* [[jabber.iq]]
 +
* [[jabber.item]]
 +
|}
  
      [[xmpp.generate]]
+
== Miscellaneous messages==
  
      [[xmpp.iq]]
+
{|class="yate-table"
 
+
|class="yate-header-right"|Messages
      [[jabber.iq]]
+
|-
 
+
|class="yate-content-right"|
      [[jabber.item]]
+
* [[database]]
 
+
* [[monitor.query]]
== Miscellaneous messages==
+
* [[monitor.notify]]
 +
* [[MessageQueue]]
 +
* [[isup.mangle]]
 +
* [[radio.create]]
 +
|}
 +
 
  
      [[database]]
+
'''See also'''
  
      [[monitor.query]]
+
*[[Message Flows]]
  
      [[monitor.notify]]
+
[[Category:Messages]] [[Category:Programmers]]

Latest revision as of 11:19, 25 May 2018

Below you will find a list with all standards messages in Yate.

The main component of Yate are messages. Modules are passing around messages between them. This allows us to have a bigger flexibility than functions, mainly because messages in Yate can have an arbitrary number of parameters.

Contents

[edit] Engine messages

Messages

[edit] Channel messages

Messages

[edit] Call messages

Messages

[edit] User messages

Messages

[edit] Resource subscribe/notify messages

Messages

[edit] SIP messages

Messages

[edit] Encode or decode protocol specific messages

Messages

[edit] Socket operation messages

Messages

[edit] Clustering related messages

Messages

[edit] Instant messaging related messages

Messages

[edit] Jabber / XMPP messages

Messages

[edit] Miscellaneous messages

Messages


See also

Personal tools
Namespaces

Variants
Actions
Preface
Configuration
Administrators
Developers