[DCCP]: Update Documentation
[safe/jmp/linux-2.6] / Documentation / networking / dccp.txt
1 DCCP protocol
2 ============
3
4
5 Contents
6 ========
7
8 - Introduction
9 - Missing features
10 - Socket options
11 - Notes
12
13 Introduction
14 ============
15
16 Datagram Congestion Control Protocol (DCCP) is an unreliable, connection
17 based protocol designed to solve issues present in UDP and TCP particularly
18 for real time and multimedia traffic.
19
20 It has a base protocol and pluggable congestion control IDs (CCIDs).
21
22 It is at experimental RFC status and the homepage for DCCP as a protocol is at:
23         http://www.read.cs.ucla.edu/dccp/
24
25 Missing features
26 ================
27
28 The DCCP implementation does not currently have all the features that are in
29 the RFC.
30
31 The known bugs are at:
32         http://linux-net.osdl.org/index.php/TODO#DCCP
33
34 Socket options
35 ==============
36
37 DCCP_SOCKOPT_PACKET_SIZE is used for CCID3 to set default packet size for
38 calculations.
39
40 DCCP_SOCKOPT_SERVICE sets the service. The specification mandates use of
41 service codes (RFC 4340, sec. 8.1.2); if this socket option is not set,
42 the socket will fall back to 0 (which means that no meaningful service code
43 is present). Connecting sockets set at most one service option; for
44 listening sockets, multiple service codes can be specified.
45
46 DCCP_SOCKOPT_SEND_CSCOV and DCCP_SOCKOPT_RECV_CSCOV are used for setting the
47 partial checksum coverage (RFC 4340, sec. 9.2). The default is that checksums
48 always cover the entire packet and that only fully covered application data is
49 accepted by the receiver. Hence, when using this feature on the sender, it must
50 be enabled at the receiver, too with suitable choice of CsCov.
51
52 DCCP_SOCKOPT_SEND_CSCOV sets the sender checksum coverage. Values in the
53         range 0..15 are acceptable. The default setting is 0 (full coverage),
54         values between 1..15 indicate partial coverage.
55 DCCP_SOCKOPT_SEND_CSCOV is for the receiver and has a different meaning: it
56         sets a threshold, where again values 0..15 are acceptable. The default
57         of 0 means that all packets with a partial coverage will be discarded.
58         Values in the range 1..15 indicate that packets with minimally such a
59         coverage value are also acceptable. The higher the number, the more
60         restrictive this setting (see [RFC 4340, sec. 9.2.1]).
61
62 Sysctl variables
63 ================
64 Several DCCP default parameters can be managed by the following sysctls
65 (sysctl net.dccp.default or /proc/sys/net/dccp/default):
66
67 request_retries
68         The number of active connection initiation retries (the number of
69         Requests minus one) before timing out. In addition, it also governs
70         the behaviour of the other, passive side: this variable also sets
71         the number of times DCCP repeats sending a Response when the initial
72         handshake does not progress from RESPOND to OPEN (i.e. when no Ack
73         is received after the initial Request).  This value should be greater
74         than 0, suggested is less than 10. Analogue of tcp_syn_retries.
75
76 retries1
77         How often a DCCP Response is retransmitted until the listening DCCP
78         side considers its connecting peer dead. Analogue of tcp_retries1.
79
80 retries2
81         The number of times a general DCCP packet is retransmitted. This has
82         importance for retransmitted acknowledgments and feature negotiation,
83         data packets are never retransmitted. Analogue of tcp_retries2.
84
85 send_ndp = 1
86         Whether or not to send NDP count options (sec. 7.7.2).
87
88 send_ackvec = 1
89         Whether or not to send Ack Vector options (sec. 11.5).
90
91 ack_ratio = 2
92         The default Ack Ratio (sec. 11.3) to use.
93
94 tx_ccid = 2
95         Default CCID for the sender-receiver half-connection.
96
97 rx_ccid = 2
98         Default CCID for the receiver-sender half-connection.
99
100 seq_window = 100
101         The initial sequence window (sec. 7.5.2).
102
103 Notes
104 =====
105
106 DCCP does not travel through NAT successfully at present on many boxes. This is
107 because the checksum covers the psuedo-header as per TCP and UDP. Linux NAT
108 support for DCCP has been added.