Standard Messages

From Yate Documentation
(Difference between revisions)
Jump to: navigation, search
(Channel messages)
Line 10: Line 10:
 
|-
 
|-
 
|class="yate-content-right"|
 
|class="yate-content-right"|
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[engine.start]]</font><br/>
+
* [[engine.start]]
<div class="yate-page-desc"></div>
+
* [[engine.stop]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[engine.stop]]</font><br/>
+
* [[engine.halt]]
<div class="yate-page-desc"></div>
+
* [[engine.init]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[engine.halt]]</font><br/>
+
* [[engine.busy]]
<div class="yate-page-desc"></div>
+
* [[engine.help]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[engine.init]]</font><br/>
+
* [[engine.command]]
<div class="yate-page-desc"></div>
+
* [[engine.status]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[engine.busy]]</font><br/>
+
* [[engine.timer]]
<div class="yate-page-desc"></div>
+
* [[engine.cipher]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[engine.help]]</font><br/>
+
* [[module.update]]
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[engine.command]]</font><br/>
+
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[engine.status]]</font><br/>
+
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[engine.timer]]</font><br/>
+
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[engine.cipher]]</font><br/>
+
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[module.update]]</font><br/>
+
<div class="yate-page-desc"></div>
+
 
|}
 
|}
  
Line 40: Line 29:
 
|-
 
|-
 
|class="yate-content-right"|
 
|class="yate-content-right"|
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[chan.attach]]</font><br/>
+
* [[chan.attach]]
<div class="yate-page-desc"></div>
+
* [[chan.connected]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[chan.connected]]</font><br/>
+
* [[chan.disconnected]]
<div class="yate-page-desc"></div>
+
* [[chan.dtmf]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[chan.disconnected]]</font><br/>
+
* [[chan.hangup]]
<div class="yate-page-desc"></div>
+
* [[chan.masquerade]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[chan.dtmf]]</font><br/>
+
* [[chan.notify]]
<div class="yate-page-desc"></div>
+
* [[chan.record]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[chan.hangup]]</font><br/>
+
* [[chan.rtp]]
<div class="yate-page-desc"></div>
+
* [[chan.startup]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[chan.masquerade]]</font><br/>
+
* [[chan.text]]
<div class="yate-page-desc"></div>
+
* [[chan.connect]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[chan.notify]]</font><br/>
+
* [[chan.locate]]
<div class="yate-page-desc"></div>
+
* [[chan.control]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[chan.record]]</font><br/>
+
* [[chan.replaced]]
<div class="yate-page-desc"></div>
+
* [[chan.transfer]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[chan.rtp]]</font><br/>
+
* [[chan.operation]]
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[chan.startup]]</font><br/>
+
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[chan.text]]</font><br/>
+
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[chan.connect]]</font><br/>
+
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[chan.locate]]</font><br/>
+
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[chan.control]]</font><br/>
+
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[chan.replaced]]</font><br/>
+
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[chan.transfer]]</font><br/>
+
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[chan.operation]]</font><br/>
+
<div class="yate-page-desc"></div>
+
 
|}
 
|}
  
Line 82: Line 54:
 
|-
 
|-
 
|class="yate-content-right"|
 
|class="yate-content-right"|
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[call.answered]]</font><br/>
+
* [[call.answered]]
<div class="yate-page-desc"></div>
+
* [[call.cdr]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[call.cdr]]</font><br/>
+
* [[call.drop]]
<div class="yate-page-desc"></div>
+
* [[call.execute]]
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[call.drop]]</font><br/>
+
* [[call.progress]]
<div class="yate-page-desc"></div>
+
* [[call.ringing]]
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[call.execute]]</font><br/>
+
* [[call.route]]
<div class="yate-page-desc"></div>
+
* [[call.preroute]]
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[call.progress]]</font><br/>
+
* [[call.update]]
<div class="yate-page-desc"></div>
+
* [[call.conference]]
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[call.ringing]]</font><br/>
+
* [[mwi]]
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[call.route]]</font><br/>
+
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[call.preroute]]</font><br/>
+
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[call.update]]</font><br/>
+
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[call.conference]]</font><br/>
+
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[mwi]]</font><br/>
+
<div class="yate-page-desc"></div>
+
 
|}
 
|}
  
Line 112: Line 73:
 
|-
 
|-
 
|class="yate-content-right"|
 
|class="yate-content-right"|
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[user.auth]]</font><br/>
+
* [[user.auth]]
<div class="yate-page-desc"></div>
+
* [[user.account]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[user.account]]</font><br/>
+
* [[user.login]]
<div class="yate-page-desc"></div>
+
* [[user.notify]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[user.login]]</font><br/>
+
* [[user.register]]
<div class="yate-page-desc"></div>
+
* [[user.unregister]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[user.notify]]</font><br/>
+
* [[user.roster]]
<div class="yate-page-desc"></div>
+
* [[user.update]]
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[user.register]]</font><br/>
+
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[user.unregister]]</font><br/>
+
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[user.roster]]</font><br/>
+
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title">[[user.update]]</font><br/>
+
<div class="yate-page-desc"></div>
+
 
|}
 
|}
  
Line 136: Line 89:
 
|-
 
|-
 
|class="yate-content-right"|
 
|class="yate-content-right"|
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[resource.subscribe]]</font><br/>
+
* [[resource.subscribe]]
<div class="yate-page-desc"></div> 
+
* [[resource.notify]]   
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[resource.notify]]</font><br/>
+
<div class="yate-page-desc"></div>  
+
 
|}
 
|}
  
Line 148: Line 99:
 
|-
 
|-
 
|class="yate-content-right"|
 
|class="yate-content-right"|
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[SIP Generic Message|sip.<methodname>]]</font><br/>
+
* [[SIP Generic Message|sip.<methodname>]]
<div class="yate-page-desc"></div> 
+
* [[xsip.generate]]
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[xsip.generate]]</font><br/>
+
<div class="yate-page-desc"></div> 
+
 
|}
 
|}
  
Line 160: Line 109:
 
|-
 
|-
 
|class="yate-content-right"|
 
|class="yate-content-right"|
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[isup.decode]]</font><br/>
+
* [[isup.decode]]
<div class="yate-page-desc"></div> 
+
* [[isup.encode]]
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[isup.encode]]</font><br/>
+
* [[sccp.generate]]
<div class="yate-page-desc"></div> 
+
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[sccp.generate]]</font><br/>
+
<div class="yate-page-desc"></div>
+
 
|}
 
|}
  
Line 175: Line 121:
 
|-
 
|-
 
|class="yate-content-right"|
 
|class="yate-content-right"|
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[socket.stun]]</font><br/>
+
* [[socket.stun]]
<div class="yate-page-desc"></div> 
+
* [[socket.ssl]]
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[socket.ssl]]</font><br/>
+
* [[socket.sctp]]
<div class="yate-page-desc"></div> 
+
<!--<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[socket.peel]]</font><br/>
+
<div class="yate-page-desc"></div>  -->
+
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[socket.sctp]]</font><br/>
+
<div class="yate-page-desc"></div>
+
 
|}
 
|}
  
Line 191: Line 132:
 
|-
 
|-
 
|class="yate-content-right"|
 
|class="yate-content-right"|
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[cluster.locate]]</font><br/>
+
* [[cluster.locate]]
<div class="yate-page-desc"></div> 
+
* [[cluster.send]]   
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[cluster.send]]</font><br/>
+
<div class="yate-page-desc"></div>  
+
 
|}
 
|}
  
Line 203: Line 142:
 
|-
 
|-
 
|class="yate-content-right"|
 
|class="yate-content-right"|
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[msg.route]]</font><br/>
+
* [[msg.route]]
<div class="yate-page-desc"></div> 
+
* [[msg.execute]]
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[msg.execute]]</font><br/>
+
* [[contact.info]]
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[contact.info]]</font><br/>
+
<div class="yate-page-desc"></div>
+
 
|}
 
|}
  
Line 217: Line 153:
 
|-
 
|-
 
|class="yate-content-right"|
 
|class="yate-content-right"|
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[xmpp.iq]]</font><br/>
+
* [[xmpp.iq]]
<div class="yate-page-desc"></div> 
+
* [[jabber.iq]]
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[jabber.iq]]</font><br/>
+
* [[jabber.item]]
<div class="yate-page-desc"></div> 
+
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[jabber.item]]</font><br/>
+
<div class="yate-page-desc"></div>
+
 
|}
 
|}
  
Line 231: Line 164:
 
|-
 
|-
 
|class="yate-content-right"|
 
|class="yate-content-right"|
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[database]]</font><br/>
+
* [[database]]
<div class="yate-page-desc"></div> 
+
* [[monitor.query]]
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[monitor.query]]</font><br/>
+
* [[monitor.notify]]
<div class="yate-page-desc"></div>
+
* [[MessageQueue]]
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[monitor.notify]]</font><br/>
+
<div class="yate-page-desc"></div>
+
<div class="bullet">&nbsp;</div><font class="yate-page-title"> [[MessageQueue]]</font><br/>
+
<div class="yate-page-desc"></div>
+
 
|}
 
|}
 
    
 
    
Line 245: Line 174:
  
 
*[[Message Flows]]
 
*[[Message Flows]]
 +
 +
[[Category:Messages]] [[Category:Programmers]]

Revision as of 14:19, 1 November 2013

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

Engine messages

Messages

Channel messages

Messages

Call messages

Messages

User messages

Messages

Resource subscribe/notify messages

Messages

SIP messages

Messages

Encode or decode protocol specific messages

Messages

Socket operation messages

Messages

Clustering related messages

Messages

Instant messaging related messages

Messages

Jabber / XMPP messages

Messages

Miscellaneous messages

Messages


See also

Personal tools
Namespaces

Variants
Actions
Preface
Configuration
Administrators
Developers