[linux-2.6-block.git] / Documentation / networking / sctp.rst

.. SPDX-License-Identifier: GPL-2.0

=================
Linux Kernel SCTP
=================

This is the current BETA release of the Linux Kernel SCTP reference
implementation.

SCTP (Stream Control Transmission Protocol) is a IP based, message oriented,
reliable transport protocol, with congestion control, support for
transparent multi-homing, and multiple ordered streams of messages.
RFC2960 defines the core protocol.  The IETF SIGTRAN working group originally
developed the SCTP protocol and later handed the protocol over to the
Transport Area (TSVWG) working group for the continued evolvement of SCTP as a
general purpose transport.

See the IETF website (http://www.ietf.org) for further documents on SCTP.
See http://www.ietf.org/rfc/rfc2960.txt

The initial project goal is to create an Linux kernel reference implementation
of SCTP that is RFC 2960 compliant and provides an programming interface
referred to as the  UDP-style API of the Sockets Extensions for SCTP, as
proposed in IETF Internet-Drafts.

Caveats
=======

- lksctp can be built as statically or as a module.  However, be aware that
  module removal of lksctp is not yet a safe activity.

- There is tentative support for IPv6, but most work has gone towards
  implementation and testing lksctp on IPv4.


For more information, please visit the lksctp project website:

   http://www.sf.net/projects/lksctp

Or contact the lksctp developers through the mailing list:

   <linux-sctp@vger.kernel.org>
Commit	Line	Data
671d114d MCC	1	.. SPDX-License-Identifier: GPL-2.0
	2
	3	=================
	4	Linux Kernel SCTP
	5	=================
1da177e4 LT	6
1da177e4 LT	7	This is the current BETA release of the Linux Kernel SCTP reference
671d114d	8	implementation.
1da177e4 LT	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
671d114d MCC	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.
1da177e4	17
671d114d MCC	18	See the IETF website (http://www.ietf.org) for further documents on SCTP.
671d114d MCC	19	See http://www.ietf.org/rfc/rfc2960.txt
1da177e4 LT	20
1da177e4 LT	21	The initial project goal is to create an Linux kernel reference implementation
671d114d MCC	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.
1da177e4	25
671d114d MCC	26	Caveats
671d114d MCC	27	=======
1da177e4	28
671d114d MCC	29	- lksctp can be built as statically or as a module. However, be aware that
671d114d MCC	30	module removal of lksctp is not yet a safe activity.
1da177e4	31
671d114d MCC	32	- There is tentative support for IPv6, but most work has gone towards
671d114d MCC	33	implementation and testing lksctp on IPv4.
1da177e4 LT	34
	35
	36	For more information, please visit the lksctp project website:
671d114d	37
1da177e4 LT	38	http://www.sf.net/projects/lksctp
	39
	40	Or contact the lksctp developers through the mailing list:
671d114d	41
91705c61	42	<linux-sctp@vger.kernel.org>