Let's also include aclocal.m4
[asterisk-bristuff.git] / doc / ip-tos.txt
blob36febd99a99da056267abe733833b78e7fd3ce19
1 IP Type of Service settings for VoIP channels
2 ---------------------------------------------
4 Asterisk can set the Type of Service (TOS) byte on outgoing IP packets
5 for various protocols.  The TOS byte is used by the network to provide
6 some level of Quality of Service (QoS) even if the network is
7 congested with other traffic. 
9 * SIP
10 -----
11 In sip.conf, there are three parameters that control the TOS settings:
12 "tos_sip", "tos_audio", and "tos_video".  tos_sip controls what TOS SIP call
13 signalling packets are set to.  tos_audio controls what TOS RTP audio
14 packets are set to.  tos_video controls what TOS RTP video packets are
15 set to.  
16 There is a "tos" parameter that is supported for backwards
17 compatibility.  The tos parameter should be avoided in sip.conf
18 because it sets all three tos settings in sip.conf to the same value.
20 * IAX2
21 ------
22 In iax.conf, there is a "tos" parameter that sets the global default TOS
23 for IAX packets generated by chan_iax2.  Since IAX connections combine
24 signalling, audio, and video into one UDP stream, it is not possible
25 to set the TOS separately for the different types of traffic.
27 In iaxprov.conf, there is a "tos" parameter that tells the IAXy what TOS
28 to set on packets it generates.  As with the parameter in iax.conf,
29 IAX packets generated by an IAXy cannot have different TOS settings
30 based upon the type of packet.  However different IAXy devices can
31 have different TOS settings.
33 The allowable values for any of the tos* parameters are:
34 CS0, CS1, CS2, CS3, CS4, CS5, CS6, CS7, AF11, AF12, AF13,
35 AF21, AF22, AF23, AF31, AF32, AF33, AF41, AF42, AF43 and
36 ef (expedited forwarding),
38 The tos* parameters also take numeric values.
40 The lowdelay, throughput, reliability, mincost, and none values are
41 deprecated because they set the IP TOS using the outdated "IP
42 precedence" model as defined in RFC 791 and RFC 1349. They still
43 work in this version of Asterisk, but will be removed in future releases.
45 ===========================================
46 Configuration   Parameter       Recommended
47 File                            Setting
48 -------------------------------------------
49 sip.conf        tos_sip         cs3
50 sip.conf        tos_audio       ef
51 sip.conf        tos_video       af41
52 -------------------------------------------
53 iax.conf        tos             ef
54 -------------------------------------------
55 iaxprov.conf    tos             ef
56 ===========================================
59 * REFERENCE
60 -----------
61 RFC 2474 - "Definition of the Differentiated Services Field
62 (DS field) in the IPv4 and IPv6 Headers", Nichols, K., et al,
63 December 1998.
65 IANA Assignments, DSCP registry
66 Differentiated Services Field Codepoints
67 http://www.iana.org/assignments/dscp-registry
69 To get the most out of setting the TOS on packets generated by
70 Asterisk, you will need to ensure that your network handles packets
71 with a TOS properly.  For Cisco devices, see the previously mentioned
72 "Enterprise QoS Solution Reference Network Design Guide".  For Linux
73 systems see the "Linux Advanced Routing & Traffic Control HOWTO" at
74 <http://www.lartc.org/>.
76 For more information on Quality of
77 Service for VoIP networks see the "Enterprise QoS Solution Reference
78 Network Design Guide" version 3.3 from Cisco at:
80 <http://www.cisco.com/application/pdf/en/us/guest/netsol/ns432/c649/ccmigration_09186a008049b062.pdf>