Merge tag 'timers-urgent-2020-12-27' of git://git.kernel.org/pub/scm/linux/kernel...
[linux-2.6-microblaze.git] / Documentation / networking / sctp.rst
1 .. SPDX-License-Identifier: GPL-2.0
2
3 =================
4 Linux Kernel SCTP
5 =================
6
7 This is the current BETA release of the Linux Kernel SCTP reference
8 implementation.
9
10 SCTP (Stream Control Transmission Protocol) is a IP based, message oriented,
11 reliable transport protocol, with congestion control, support for
12 transparent multi-homing, and multiple ordered streams of messages.
13 RFC2960 defines the core protocol.  The IETF SIGTRAN working group originally
14 developed the SCTP protocol and later handed the protocol over to the
15 Transport Area (TSVWG) working group for the continued evolvement of SCTP as a
16 general purpose transport.
17
18 See the IETF website (http://www.ietf.org) for further documents on SCTP.
19 See http://www.ietf.org/rfc/rfc2960.txt
20
21 The initial project goal is to create an Linux kernel reference implementation
22 of SCTP that is RFC 2960 compliant and provides an programming interface
23 referred to as the  UDP-style API of the Sockets Extensions for SCTP, as
24 proposed in IETF Internet-Drafts.
25
26 Caveats
27 =======
28
29 - lksctp can be built as statically or as a module.  However, be aware that
30   module removal of lksctp is not yet a safe activity.
31
32 - There is tentative support for IPv6, but most work has gone towards
33   implementation and testing lksctp on IPv4.
34
35
36 For more information, please visit the lksctp project website:
37
38    http://www.sf.net/projects/lksctp
39
40 Or contact the lksctp developers through the mailing list:
41
42    <linux-sctp@vger.kernel.org>