draft-ietf-taps-transports-usage-02.txt   draft-ietf-taps-transports-usage-03.txt 
TAPS M. Welzl TAPS M. Welzl
Internet-Draft University of Oslo Internet-Draft University of Oslo
Intended status: Informational M. Tuexen Intended status: Informational M. Tuexen
Expires: May 4, 2017 Muenster Univ. of Appl. Sciences Expires: September 9, 2017 Muenster Univ. of Appl. Sciences
N. Khademi N. Khademi
University of Oslo University of Oslo
October 31, 2016 March 8, 2017
On the Usage of Transport Service Features Provided by IETF Transport On the Usage of Transport Features Provided by IETF Transport Protocols
Protocols draft-ietf-taps-transports-usage-03
draft-ietf-taps-transports-usage-02
Abstract Abstract
This document describes how transport protocols expose services to This document describes how TCP, MPTCP, SCTP, UDP and UDP-Lite expose
applications and how an application can configure and use the services to applications and how an application can configure and use
features of a transport service. the transport features that make up these services. It also
discusses the service provided by the LEDBAT congestion control
mechanism.
Status of this Memo Status of this Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on May 4, 2017. This Internet-Draft will expire on September 9, 2017.
Copyright Notice Copyright Notice
Copyright (c) 2016 IETF Trust and the persons identified as the Copyright (c) 2017 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
3. Pass 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 3. Pass 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.1. Primitives Provided by TCP . . . . . . . . . . . . . . . . 5 3.1. Primitives Provided by TCP . . . . . . . . . . . . . . . . 5
3.1.1. Excluded Primitives or Parameters . . . . . . . . . . 7 3.1.1. Excluded Primitives or Parameters . . . . . . . . . . 8
3.2. Primitives Provided by MPTCP . . . . . . . . . . . . . . . 8 3.2. Primitives Provided by MPTCP . . . . . . . . . . . . . . . 9
3.3. Primitives Provided by SCTP . . . . . . . . . . . . . . . 9 3.3. Primitives Provided by SCTP . . . . . . . . . . . . . . . 10
3.3.1. Excluded Primitives or Parameters . . . . . . . . . . 13 3.3.1. Excluded Primitives or Parameters . . . . . . . . . . 17
3.4. Primitives Provided by UDP and UDP-Lite . . . . . . . . . 14 3.4. Primitives Provided by UDP and UDP-Lite . . . . . . . . . 17
4. Pass 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 3.5. The service of LEDBAT . . . . . . . . . . . . . . . . . . 17
4.1. CONNECTION Related Primitives . . . . . . . . . . . . . . 14 4. Pass 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
4.2. DATA Transfer Related Primitives . . . . . . . . . . . . . 23 4.1. CONNECTION Related Primitives . . . . . . . . . . . . . . 19
5. Pass 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 4.2. DATA Transfer Related Primitives . . . . . . . . . . . . . 30
5.1. CONNECTION Related Transport Service Features . . . . . . 25 5. Pass 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
5.2. DATA Transfer Related Transport Service Features . . . . . 30 5.1. CONNECTION Related Transport Features . . . . . . . . . . 33
5.2.1. Sending Data . . . . . . . . . . . . . . . . . . . . . 30 5.2. DATA Transfer Related Transport Features . . . . . . . . . 39
5.2.2. Receiving Data . . . . . . . . . . . . . . . . . . . . 31 5.2.1. Sending Data . . . . . . . . . . . . . . . . . . . . . 39
5.2.3. Errors . . . . . . . . . . . . . . . . . . . . . . . . 31 5.2.2. Receiving Data . . . . . . . . . . . . . . . . . . . . 40
6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 32 5.2.3. Errors . . . . . . . . . . . . . . . . . . . . . . . . 40
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 32 6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 41
8. Security Considerations . . . . . . . . . . . . . . . . . . . 32 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 41
9. References . . . . . . . . . . . . . . . . . . . . . . . . . . 32 8. Security Considerations . . . . . . . . . . . . . . . . . . . 41
9.1. Normative References . . . . . . . . . . . . . . . . . . . 32 9. References . . . . . . . . . . . . . . . . . . . . . . . . . . 41
9.2. Informative References . . . . . . . . . . . . . . . . . . 33 9.1. Normative References . . . . . . . . . . . . . . . . . . . 41
Appendix A. Overview of RFCs used as input for pass 1 . . . . . . 35 9.2. Informative References . . . . . . . . . . . . . . . . . . 44
Appendix B. How to contribute . . . . . . . . . . . . . . . . . . 36 Appendix A. Overview of RFCs used as input for pass 1 . . . . . . 45
Appendix C. Revision information . . . . . . . . . . . . . . . . 37 Appendix B. How this document was developed . . . . . . . . . . . 45
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 38 Appendix C. Revision information . . . . . . . . . . . . . . . . 47
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 47
1. Terminology 1. Terminology
Transport Service Feature: a specific end-to-end feature that a Transport Feature: a specific end-to-end feature that the transport
transport service provides to its clients. Examples include layer provides to an application. Examples include
confidentiality, reliable delivery, ordered delivery, message- confidentiality, reliable delivery, ordered delivery, message-
versus-stream orientation, etc. versus-stream orientation, etc.
Transport Service: a set of transport service features, without an Transport Service: a set of Transport Features, without an
association to any given framing protocol, which provides a association to any given framing protocol, which provides a
complete service to an application. complete service to an application.
Transport Protocol: an implementation that provides one or more Transport Protocol: an implementation that provides one or more
different transport services using a specific framing and header different transport services using a specific framing and header
format on the wire. format on the wire.
Transport Protocol Component: an implementation of a transport Transport Protocol Component: an implementation of a Transport
service feature within a protocol. Feature within a protocol.
Transport Service Instance: an arrangement of transport protocols Transport Service Instance: an arrangement of transport protocols
with a selected set of features and configuration parameters that with a selected set of features and configuration parameters that
implements a single transport service, e.g., a protocol stack (RTP implements a single transport service, e.g., a protocol stack (RTP
over UDP). over UDP).
Application: an entity that uses the transport layer for end-to-end Application: an entity that uses the transport layer for end-to-end
delivery of data across the network (this may also be an upper delivery of data across the network (this may also be an upper
layer protocol or tunnel encapsulation). layer protocol or tunnel encapsulation).
Endpoint: an entity that communicates with one or more other Endpoint: an entity that communicates with one or more other
endpoints using a transport protocol. endpoints using a transport protocol.
Connection: shared state of two or more endpoints that persists Connection: shared state of two or more endpoints that persists
across messages that are transmitted between these endpoints. across messages that are transmitted between these endpoints.
Primitive: a function call that is used to locally communicate Primitive: a function call that is used to locally communicate
between an application and a transport endpoint and is related to between an application and a transport endpoint and is related to
one or more Transport Service Features. one or more Transport Features.
Parameter: a value passed between an application and a transport Parameter: a value passed between an application and a transport
protocol by a primitive. protocol by a primitive.
Socket: the combination of a destination IP address and a Socket: the combination of a destination IP address and a
destination port number. destination port number.
Transport Address: the combination of an IP address, transport Transport Address: the combination of an IP address, transport
protocol and the port number used by the transport protocol. protocol and the port number used by the transport protocol.
2. Introduction 2. Introduction
This document presents defined interactions between transport This document presents defined interactions between applications and
protocols and applications in the form of 'primitives' (function the transport protocols TCP, MPTCP, SCTP, UDP and UDP-Lite as well as
calls). Primitives can be invoked by an application or a transport the LEDBAT congestion control mechanism in the form of primitives and
protocol; the latter type is called an "event". The list of Transport Features. Primitives can be invoked by an application or a
transport service features and primitives in this document is transport protocol; the latter type is called an "event". The list
strictly based on the parts of protocol specifications that relate to of primitives and Transport Features in this document is strictly
what the protocol provides to an application using it and how the based on the parts of protocol specifications that describe what the
application interacts with it. It does not cover parts of a protocol protocol provides to an application using it and how the application
that are explicitly stated as optional to implement. interacts with it.
Parts of a protocol that are explicitly stated as optional to
implement are not covered. Interactions between the application and
a transport protocol that are not directly related to the operation
of the protocol are also not covered. For example, [RFC6458]
explains how an application can use socket options to indicate its
interest in receiving certain notifications. However, for the
purpose of identifying primitives and Transport Services, the ability
to enable or disable the reception of notifications is irrelevant.
Similarly, one-to-many style sockets described in [RFC6458] just
affect the application programming style, not how the underlying
protocol operates, and they are therefore not discussed here. The
same is true for the ability to obtain the unchanged value of a
parameter that an application has previously set (this is the case
for the "get" in many get/set operations in [RFC6458]).
The document presents a three-pass process to arrive at a list of The document presents a three-pass process to arrive at a list of
transport service features. In the first pass, the relevant RFC text Transport Features. In the first pass, the relevant RFC text is
is discussed per protocol. In the second pass, this discussion is discussed per protocol. In the second pass, this discussion is used
used to derive a list of primitives that are uniformly categorized to derive a list of primitives that are uniformly categorized across
across protocols. Here, an attempt is made to present or -- where protocols. Here, an attempt is made to present or -- where text
text describing primitives does not yet exist -- construct primitives describing primitives does not yet exist -- construct primitives in a
in a slightly generalized form to highlight similarities. This is, slightly generalized form to highlight similarities. This is, for
for example, achieved by renaming primitives of protocols or by example, achieved by renaming primitives of protocols or by avoiding
avoiding a strict 1:1-mapping between the primitives in the protocol a strict 1:1-mapping between the primitives in the protocol
specification and primitives in the list. Finally, the third pass specification and primitives in the list. Finally, the third pass
presents transport service features based on pass 2, identifying presents Transport Features based on pass 2, identifying which
which protocols implement them. protocols implement them.
In the list resulting from the second pass, some transport service In the list resulting from the second pass, some Transport Features
features are missing because they are implicit in some protocols, and are missing because they are implicit in some protocols, and they
they only become explicit when we consider the superset of all only become explicit when we consider the superset of all features
features offered by all protocols. For example, TCP's reliability offered by all protocols. For example, TCP always carries out
includes integrity via a checksum, but we have to include a protocol congestion control; we have to consider it together with a protocol
like UDP-Lite as specified in [RFC3828] (which has a configurable like UDP (which does not have congestion control) before we can
checksum) in the list before we can consider an always-on checksum as consider congestion control as a Transport Feature. The complete
a transport service feature. Similar arguments apply to other list of features across all protocols is therefore only available
protocol functions (e.g. congestion control). The complete list of after pass 3.
features across all protocols is therefore only available after pass
3.
This document discusses unicast transport protocols. [AUTHOR'S NOTE: This document discusses unicast transport protocols and a unicast
we skip "congestion control mechanisms" for now. This simplifies the congestion control mechanism. Transport protocols provide
discussion; the congestion control mechanisms part is about LEDBAT,
which should be easy to add later.] Transport protocols provide
communication between processes that operate on network endpoints, communication between processes that operate on network endpoints,
which means that they allow for multiplexing of communication between which means that they allow for multiplexing of communication between
the same IP addresses, and normally this multiplexing is achieved the same IP addresses, and normally this multiplexing is achieved
using port numbers. Port multiplexing is therefore assumed to be using port numbers. Port multiplexing is therefore assumed to be
always provided and not discussed in this document. always provided and not discussed in this document.
Some protocols are connection-oriented. Connection-oriented Some protocols are connection-oriented. Connection-oriented
protocols often use an initial call to a specific transport primitive protocols often use an initial call to a specific transport primitive
to open a connection before communication can progress, and require to open a connection before communication can progress, and require
communication to be explicitly terminated by issuing another call to communication to be explicitly terminated by issuing another call to
a transport primitive (usually called "close"). A "connection" is a transport primitive (usually called "close"). A "connection" is
the common state that some transport primitives refer to, e.g., to the common state that some transport primitives refer to, e.g., to
adjust general configuration settings. Connection establishment, adjust general configuration settings. Connection establishment,
maintenance and termination are therefore used to categorize maintenance and termination are therefore used to categorize
transport primitives of connection-oriented transport protocols in transport primitives of connection-oriented transport protocols in
pass 2 and pass 3. pass 2 and pass 3. For this purpose, UDP is assumed to be used with
"connected" sockets, i.e. sockets that are bound to a specific pair
of addresses and ports [FJ16].
3. Pass 1 3. Pass 1
This first iteration summarizes the relevant text parts of the RFCs This first iteration summarizes the relevant text parts of the RFCs
describing the protocols, focusing on what each transport protocol describing the protocols, focusing on what each transport protocol
provides to the application and how it is used (abstract API provides to the application and how it is used (abstract API
descriptions, where they are available). descriptions, where they are available).
3.1. Primitives Provided by TCP 3.1. Primitives Provided by TCP
skipping to change at page 7, line 46 skipping to change at page 8, line 11
the value of the UTO advertised to the remote TCP peer (default: the value of the UTO advertised to the remote TCP peer (default:
system-wide default user timeout); ENABLED (default false) is a system-wide default user timeout); ENABLED (default false) is a
boolean-type flag that controls whether the UTO option is enabled boolean-type flag that controls whether the UTO option is enabled
for a connection. This applies to both sending and receiving. for a connection. This applies to both sending and receiving.
CHANGEABLE is a boolean-type flag (default true) that controls CHANGEABLE is a boolean-type flag (default true) that controls
whether the user timeout may be changed based on a UTO option whether the user timeout may be changed based on a UTO option
received from the other end of the connection. CHANGEABLE becomes received from the other end of the connection. CHANGEABLE becomes
false when an application explicitly sets the user timeout (see false when an application explicitly sets the user timeout (see
'send'). 'send').
Fast Open: TCP Fast Open (TFO) [RFC7413] allows to immediately hand
over a message from the active open to the passive open side of a
TCP connection together with the first message establishment
packet (the SYN). This can be useful for applications that are
sensitive to TCP's connection setup delay. TCP implementations
MUST NOT use TFO by default, but only use TFO if requested
explicitly by the application on a per-service-port basis. To
benefit from TFO, the first application data unit (e.g., an HTTP
request) needs to be no more than TCP's maximum segment size
(minus options used in the SYN). For the active open side,
[RFC7413] recommends changing or replacing the connect() call in
order to support a user data buffer argument. For the passive
open side, the application needs to enable the reception of Fast
Open requests, e.g. via a new TCP_FASTOPEN setsockopt() socket
option before listen(). The receiving application must be
prepared to accept duplicates of the TFO message, as the first
data written to a socket can be delivered more than once to the
application on the remote host.
3.1.1. Excluded Primitives or Parameters 3.1.1. Excluded Primitives or Parameters
The 'open' primitive specified in [RFC0793] can be handed optional The 'open' primitive specified in [RFC0793] can be handed optional
Precedence or security/compartment information according to Precedence or security/compartment information according to
[RFC0793], but this was not included here because it is mostly [RFC0793], but this was not included here because it is mostly
irrelevant today, as explained in [RFC7414]. irrelevant today, as explained in [RFC7414].
The 'status' primitive was not included because [RFC0793] describes The 'status' primitive was not included because [RFC0793] describes
this primitive as "implementation dependent" and states that it this primitive as "implementation dependent" and states that it
"could be excluded without adverse effect". Moreover, while a data "could be excluded without adverse effect". Moreover, while a data
skipping to change at page 9, line 20 skipping to change at page 10, line 4
delivered reliably and in order to the recipient application." delivered reliably and in order to the recipient application."
The use of the Urgent-Pointer is special in MPTCP and [RFC6824] The use of the Urgent-Pointer is special in MPTCP and [RFC6824]
says "a TCP subflow MUST NOT use the Urgent Pointer to interrupt says "a TCP subflow MUST NOT use the Urgent Pointer to interrupt
an existing mapping." an existing mapping."
address and subflow management: MPTCP uses different addresses and address and subflow management: MPTCP uses different addresses and
allows a host to announce these addresses as part of the protocol. allows a host to announce these addresses as part of the protocol.
[RFC6897] says "An application should be able to restrict MPTCP to [RFC6897] says "An application should be able to restrict MPTCP to
binding to a given set of addresses." and thus allows applications binding to a given set of addresses." and thus allows applications
to limit the set of addresses that are being used by MPTCP. to limit the set of addresses that are being used by MPTCP.
Further, "An application should be able to obtain information on Further, "An application should be able to obtain information on
the pairs of addresses used by the MPTCP subflows.". the pairs of addresses used by the MPTCP subflows.".
3.3. Primitives Provided by SCTP 3.3. Primitives Provided by SCTP
Section 1.1 of [RFC4960] lists limitations of TCP that SCTP removes. Section 1.1 of [RFC4960] lists limitations of TCP that SCTP removes.
Three of the four mentioned limitations directly translate into a Three of the four mentioned limitations directly translate into
transport service features that are visible to an application using Transport Features that are visible to an application using SCTP: 1)
SCTP: 1) it allows for preservation of message delineations; 2) these it allows for preservation of message delineations; 2) these
messages, while reliably transferred, do not require to be in order messages, while reliably transferred, do not require to be in order
unless the application wants it; 3) multi-homing is supported. In unless the application wants it; 3) multi-homing is supported. In
SCTP, connections are called "association" and they can be between SCTP, connections are called "associations" and they can be between
not only two (as in TCP) but multiple addresses at each endpoint. not only two (as in TCP) but multiple addresses at each endpoint.
Section 10 of [RFC4960] further specifies the interaction with the Section 10 of [RFC4960] further specifies the interaction with the
application (which RFC [RFC4960] calls the "Upper Layer Protocol" application (which RFC [RFC4960] calls the "Upper Layer Protocol"
(ULP)). It is assumed that the Operating System provides a means for (ULP)). It is assumed that the Operating System provides a means for
SCTP to asynchronously signal the application; the primitives SCTP to asynchronously signal the application; the primitives
representing such signals are called 'events' in this section. Here, representing such signals are called 'events' in this section. Here,
we describe the relevant primitives. In addition to the abstract API we describe the relevant primitives. In addition to the abstract API
described in Section 10 of [RFC4960], an extension to the socket API described in Section 10 of [RFC4960], an extension to the socket API
is described in [RFC6458] covering the functionality of the base is described in [RFC6458], covering the functionality of the base
protocol specified in [RFC4960] and its extensions specified in protocol specified in [RFC4960] and its extensions specified in
[RFC3758], [RFC4895], and [RFC5061]. For the protocol extensions [RFC3758], [RFC4895], and [RFC5061]. For the protocol extensions
specified in [RFC6525], [RFC6951], [RFC7053], [RFC7496], and specified in [RFC6525], [RFC6951], [RFC7053], [RFC7496], [RFC7829]
[RFC7829] the corresponding extensions of the socket API are and [I-D.ietf-tsvwg-sctp-ndata], the corresponding extensions of the
specified in these protocol specifications. The functionality socket API are specified in these protocol specifications. The
exposed to the ULP through this socket API is considered here in functionality exposed to the ULP through this socket API is
addition to the abstract API specified in Section 10 of [RFC4960]. considered here in addition to the abstract API specified in Section
10 of [RFC4960].
Initialize: Initialize creates a local SCTP instance that it binds [RFC4960] contains a "SETPROTOCOLPARAMETERS" primitive that allows to
to a set of local addresses (and, if provided, port number). adjust elements of a parameter list; it is stated that SCTP
Initialize needs to be called only once per set of local implementations "may allow ULP to customize some of these protocol
addresses. parameters", indicating that none of the elements of this parameter
list are mandatory to make ULP-configurable. Thus, we only consider
the parameters in [RFC4960] that are also covered in one of the other
RFCs listed above, which leads us to exclude the parameters
RTO.Alpha, RTO.Beta and HB.Max.Burst. For clarity, we also replace
"SETPROTOCOLPARAMETERS" itself with primitives that adjust parameters
or groups of parameters which fit together.
Initialize: Initialize, described in [RFC4960], creates a local SCTP
instance that it binds to a set of local addresses (and, if
provided, port number). Initialize needs to be called only once
per set of local addresses. [RFC6458] also describes a number of
per-association initialization parameters that can be used when an
association is created, but before it is connected (via the
primitive 'Associate' below): the maximum number of inbound
streams the application is prepared to support, the maximum number
of attempts to be made when sending the INIT (the first message of
association establishment), and the maximum retransmission timeout
(RTO) value to use when attempting an INIT. At this point, before
connecting, an application can also enable UDP encapsulation by
configuring the remote UDP encapsulation port number [RFC6951].
Associate: This creates an association (the SCTP equivalent of a Associate: This creates an association (the SCTP equivalent of a
connection) between the local SCTP instance and a remote SCTP connection) that connects the local SCTP instance and a remote
instance. Most primitives are associated with a specific SCTP instance. To identify the remote endpoint, it can be given
association, which is assumed to first have been created. one or multiple (using connectx as described in section 9.9 of
[RFC6458]) sockets. Most primitives are associated with a
specific association, which is assumed to first have been created.
Associate can return a list of destination transport addresses so Associate can return a list of destination transport addresses so
that multiple paths can later be used. One of the returned that multiple paths can later be used. One of the returned
sockets will be selected by the local endpoint as default primary sockets will be selected by the local endpoint as default primary
path for sending SCTP packets to this peer, but this choice can be path for sending SCTP packets to this peer, but this choice can be
changed by the application using the list of destination changed by the application using the list of destination
addresses. Associate is also given the number of outgoing streams addresses. Associate is also given the number of outgoing streams
to request and optionally returns the number of outgoing streams to request and optionally returns the number of negotiated
negotiated. An optional parameter of 32-bits, the adaptation outgoing streams. An optional parameter of 32 bits, the
layer indication, can be provided, as specified in [RFC5061]. If adaptation layer indication, can be provided, as specified in
the extension specified in [RFC4895] is used, the chunk types [RFC5061]. If the extension specified in [RFC4895] is used, the
required to be sent authenticated by the peer can be provided. chunk types required to be sent authenticated by the peer can be
provided. [RFC6458] describes a 'SCTP_CANT_STR_ASSOC'
notification that is used to inform the application of a failure
to create an association. [RFC6458] describes how an application
could use sendto() or sendmsg() to implicitly setup an
association, thereby handing over a message that SCTP might send
during the association setup phase. Note that this mechanism is
different from TCP's TFO mechanism: the message would arrive only
once, after at least one RTT, as it is sent together with the
third message exchanged during association setup, the COOKIE-ECHO
chunk).
Send: This sends a message of a certain length in bytes over an Send: This sends a message of a certain length in bytes over an
association. A number can be provided to later refer to the association. A number can be provided to later refer to the
correct message when reporting an error, and a stream id is correct message when reporting an error, and a stream id is
provided to specify the stream to be used inside an association provided to specify the stream to be used inside an association
(we consider this as a mandatory parameter here for simplicity: if (we consider this as a mandatory parameter here for simplicity: if
not provided, the stream id defaults to 0). A condition to not provided, the stream id defaults to 0). A condition to
abandon the message can be specified (for example limiting the abandon the message can be specified (for example limiting the
number of retransmissions or the lifetime of the user message). number of retransmissions or the lifetime of the user message).
This allows to control the partial reliability extension specified This allows to control the partial reliability extension specified
skipping to change at page 11, line 17 skipping to change at page 12, line 29
application is notified of the availability of data via a DATA application is notified of the availability of data via a DATA
ARRIVE notification. If the sender has included a payload ARRIVE notification. If the sender has included a payload
protocol-id, this value is also returned. If the received message protocol-id, this value is also returned. If the received message
is only a partial delivery of a whole message, a partial flag will is only a partial delivery of a whole message, a partial flag will
indicate so, in which case the stream id and a stream sequence indicate so, in which case the stream id and a stream sequence
number are provided to the application. A delivery number lets number are provided to the application. A delivery number lets
the application detect reordering. the application detect reordering.
Shutdown: This primitive gracefully closes an association, reliably Shutdown: This primitive gracefully closes an association, reliably
delivering any data that has already been handed over to SCTP. A delivering any data that has already been handed over to SCTP. A
parameter lets the application control whether further receive or
send operations or both are disabled when the call is issued. A
return code informs about success or failure of this procedure. return code informs about success or failure of this procedure.
Abort: This ungracefully closes an association, by discarding any Abort: This ungracefully closes an association, by discarding any
locally queued data and informing the peer that the association locally queued data and informing the peer that the association
was aborted. Optionally, an abort reason to be passed to the peer was aborted. Optionally, an abort reason to be passed to the peer
may be provided by the application. A return code informs about may be provided by the application. A return code informs about
success or failure of this procedure. success or failure of this procedure.
Change Heartbeat / Request Heartbeat: This allows the application to Change Heartbeat / Request Heartbeat: This allows the application to
enable/disable heartbeats and optionally specify a heartbeat enable/disable heartbeats and optionally specify a heartbeat
frequency as well as requesting a single heartbeat to be carried frequency as well as requesting a single heartbeat to be carried
out upon a function call, with a notification about success or out upon a function call, with a notification about success or
failure of transmitting the HEARTBEAT chunk to the destination. failure of transmitting the HEARTBEAT chunk to the destination.
Set Protocol Parameters: This allows to set values for protocol Configure Max. Retransmissions of an Association: The parameter
parameters per association; for some parameters, a setting can be Association.Max.Retrans in [RFC4960], called sasoc_maxrxt in
made per socket. The set listed in [RFC4960] is: RTO.Initial; [RFC6458], allows to configure the number of unsuccessful
RTO.Min; RTO.Max; Max.Burst; RTO.Alpha; RTO.Beta; retransmissions after which an entire association is considered as
Valid.Cookie.Life; Association.Max.Retrans; Path.Max.Retrans; failed (which should invoke a COMMUNICATION LOST notification).
Max.Init.Retransmits; HB.interval; HB.Max.Burst. In addition to
these, the Quick Failover Algorithm specified in [RFC7829] can be
controlled by the PotentiallyFailed.Max.Retrans and
Primary.Switchover.Max.Retrans parameter. A remote UDP
encapsulation port can be set for using UDP encapsulation as
specified in [RFC6951].
Set Primary: This allows to set a new primary default path for an Set Primary: This allows to set a new primary default path for an
association by providing a socket. Optionally, a default source association by providing a socket. Optionally, a default source
address to be used in IP datagrams can be provided. address to be used in IP datagrams can be provided.
Set / Get Authentication Parameters: This allows an endpoint to add/
remove key material to/from an association. In addition, the
chunk types being authenticated can be queried. This is provided
by the protocol extension defined in [RFC4895].
Change Local Address / Set Peer Primary: This allows an endpoint to Change Local Address / Set Peer Primary: This allows an endpoint to
add/remove local addresses to/from an association. In addition, add/remove local addresses to/from an association. In addition,
the peer can be given a hint which address to use as the primary the peer can be given a hint which address to use as the primary
address. This is provided by the protocol extension defined in address. This is provided by the protocol extension defined in
[RFC5061]. [RFC5061].
Configure Path Switchover: [RFC4960] contains a primitive called SET
FAILURE THRESHOLD. This configures the parameter
"Path.Max.Retrans", which determines after how many
retransmissions a particular transport address is considered as
unreachable. If there are more transport addresses available in
an association, reaching this limit will invoke a path switchover.
[RFC7829] extends this method with a concept of "Potentially
Failed" (PF) paths. When a path is in PF state, SCTP will not
entirely give up sending on that path, but it will preferably send
data on other active paths if such paths are available. Entering
the PF state is done upon exceeding a configured maximum number of
retransmissions. Thus, for all paths where this mechanism is
used, there are two configurable error thresholds: one to decide
that a path is in PF state, and one to decide that the transport
address is unreachable.
Set / Get Authentication Parameters: This allows an endpoint to add/
remove key material to/from an association. In addition, the
chunk types being authenticated can be queried. This is provided
by the protocol extension defined in [RFC4895].
Add / Reset Streams, Reset Association: This allows an endpoint to Add / Reset Streams, Reset Association: This allows an endpoint to
add streams to an existing association or or to reset them add streams to an existing association or or to reset them
individually. Additionally, the association can be reset. This individually. Additionally, the association can be reset. This
is provided by the protocol extension defined in [RFC6525]. is provided by the protocol extension defined in [RFC6525].
Status: The 'Status' primitive returns a data block with information Status: The 'Status' primitive returns a data block with information
about a specified association, containing: association connection about a specified association, containing: association connection
state; socket list; destination transport address reachability state; destination transport address list; destination transport
states; current receiver window size; current congestion window address reachability states; current local and peer receiver
sizes; number of unacknowledged DATA chunks; number of DATA chunks window sizes; current local congestion window sizes; number of
pending receipt; primary path; most recent SRTT on primary path; unacknowledged DATA chunks; number of DATA chunks pending receipt;
RTO on primary path; SRTT and RTO on other destination addresses. primary path; most recent SRTT on primary path; RTO on primary
path; SRTT and RTO on other destination addresses [RFC4960] and
MTU per path [RFC6458].
Enable / Disable Interleaving: This allows to enable or disable the
negotiation of user message interleaving support for future
associations. For existing associations it is possible to query
whether user message interleaving support was negotiated or not on
a particular association [I-D.ietf-tsvwg-sctp-ndata].
Set Stream Scheduler: This allows to select a stream scheduler per
association, with a choice of: First Come First Serve, Round
Robin, Round Robin per Packet, Priority Based, Fair Bandwidth,
Weighted Fair Queuing. How these schedulers operate is described
in detail in [I-D.ietf-tsvwg-sctp-ndata].
Configure Stream Scheduler: This allows to change a parameter per
stream for the schedulers: a priority value for the Priority Based
scheduler and a weight for the Weighted Fair Queuing scheduler.
Enable/disable NODELAY: This turns on/off any Nagle-like algorithm
for an association [RFC6458].
Configure send buffer size: This controls the amount of data SCTP
may have waiting in internal buffers to be sent or retransmitted
[RFC6458].
Configure receive buffer size: This sets the receive buffer size in
octets, thereby controlling the receiver window for an association
[RFC6458].
Configure message fragmentation: If a user message causes an SCTP
packet to exceed the maximum fragmentation size (which can be
provided by the application, and is otherwise the PMTU size), then
the message will be fragmented by SCTP. Disabling message
fragmentation will produce an error instead of fragmenting the
message [RFC6458].
Configure Path MTU Discovery: Section 8.1.12 of [RFC6458] explains
how Path MTU Discovery can be enabled or disabled per peer address
of an association. When it is enabled, the current Path MTU value
can be obtained. When it is disabled, the Path MTU to be used can
be controlled by the application.
Configure delayed SACK timer: The time before sending a SACK can be
adjusted; delaying SACKs can be disabled; the number of packets
that must be received before a SACK is sent without waiting for
the delay timer to expire can be configured [RFC6458].
Set Cookie life value: The Cookie life value can be adjusted as
explained in Section 8.1.2 of [RFC6458]. "Valid.Cookie.Life" is
also one of the parameters listed as potentially adjustable with
SETPROTOCOLPARAMETERS in [RFC4960].
Set maximum burst: The maximum burst of packets that can be emitted
by a particular association (default 4, and values above 4 are
optional to implement) can be adjusted as explained in Section
8.1.2 of [RFC6458]. "Max.Burst" is also one of the parameters
listed as potentially adjustable with SETPROTOCOLPARAMETERS in
[RFC4960].
Configure RTO calculation: [RFC4960] lists the following adjustable
parameters: RTO.Initial; RTO.Min; RTO.Max; RTO.Alpha; RTO.Beta.
Only the initial, minimum and maximum RTO are also described as
configurable [RFC6458].
Set DSCP value: Section 8.1.12 of [RFC6458] explains how to set the
DSCP value per peer address of an association.
Set IPv6 flow label: Section 8.1.12 of [RFC6458] explains how to set
the flow label field per peer address of an association.
Set Partial Delivery Point: This allows to specify the size of a
message where partial delivery will be invoked. Setting this to a
lower value will cause partial deliveries to happen more often
[RFC6458].
COMMUNICATION UP notification: When a lost communication to an COMMUNICATION UP notification: When a lost communication to an
endpoint is restored or when SCTP becomes ready to send or receive endpoint is restored or when SCTP becomes ready to send or receive
user messages, this notification informs the application process user messages, this notification informs the application process
about the affected association, the type of event that has about the affected association, the type of event that has
occurred, the complete set of sockets of the peer, the maximum occurred, the complete set of sockets of the peer, the maximum
number of allowed streams and the inbound stream count (the number number of allowed streams and the inbound stream count (the number
of streams the peer endpoint has requested). of streams the peer endpoint has requested). If interleaving is
supported by both endpoints, this information is also included in
this notification.
RESTART notification: When SCTP has detected that the peer has
restarted, this notification is passed to the upper layer
[RFC6458].
DATA ARRIVE notification: When a message is ready to be retrieved DATA ARRIVE notification: When a message is ready to be retrieved
via the Receive primitive, the application is informed by this via the Receive primitive, the application is informed by this
notification. notification.
SEND FAILURE notification / Receive Unsent Message / Receive SEND FAILURE notification / Receive Unsent Message / Receive
Unacknowledged Message: When a message cannot be delivered via an Unacknowledged Message: When a message cannot be delivered via an
association, the sender can be informed about it and learn whether association, the sender can be informed about it and learn whether
the message has just not been acknowledged or (e.g. in case of the message has just not been acknowledged or (e.g. in case of
lifetime expiry) if it has not even been sent. lifetime expiry) if it has not even been sent. This can also
inform the sender that a part of the message has been successfully
delivered.
NETWORK STATUS CHANGE notification: The NETWORK STATUS CHANGE NETWORK STATUS CHANGE notification: The NETWORK STATUS CHANGE
notification informs the application about a socket becoming notification informs the application about a socket becoming
active/inactive. active/inactive [RFC4960] or "Potentially Failed" [RFC7829].
COMMUNICATION LOST notification: When SCTP loses communication to an COMMUNICATION LOST notification: When SCTP loses communication to an
endpoint (e.g. via Heartbeats or excessive retransmission) or endpoint (e.g. via Heartbeats or excessive retransmission) or
detects an abort, this notification informs the application detects an abort, this notification informs the application
process of the affected association and the type of event (failure process of the affected association and the type of event (failure
OR termination in response to a shutdown or abort request). OR termination in response to a shutdown or abort request).
SHUTDOWN COMPLETE notification: When SCTP completes the shutdown SHUTDOWN COMPLETE notification: When SCTP completes the shutdown
procedures, this notification is passed to the upper layer, procedures, this notification is passed to the upper layer,
informing it about the affected assocation. informing it about the affected assocation.
AUTHENICATION notification: When SCTP wants to notify the upper AUTHENTICATION notification: When SCTP wants to notify the upper
layer regarding the key management related to the extension layer regarding the key management related to the extension
defined in [RFC4895], this notification is passed to the upper defined in [RFC4895], this notification is passed to the upper
layer. layer.
ADAPTATION LAYER INDICATION notification: When SCTP completes the ADAPTATION LAYER INDICATION notification: When SCTP completes the
association setup and the peer provided an adaptation layer association setup and the peer provided an adaptation layer
indication, this is passed to the upper layer. This extension is indication, this is passed to the upper layer. This extension is
defined in [RFC5061] and [RFC6458]. defined in [RFC5061] and [RFC6458].
STREAM RESET notification: When SCTP completes the procedure for STREAM RESET notification: When SCTP completes the procedure for
skipping to change at page 13, line 32 skipping to change at page 17, line 5
ASSOCIATION RESET notification: When SCTP completes the association ASSOCIATION RESET notification: When SCTP completes the association
reset procedure as specified in [RFC6525], this notification is reset procedure as specified in [RFC6525], this notification is
passed to the upper layer, informing it about the result. passed to the upper layer, informing it about the result.
STREAM CHANGE notification: When SCTP completes the procedure used STREAM CHANGE notification: When SCTP completes the procedure used
to increase the number of streams as specified in [RFC6525], this to increase the number of streams as specified in [RFC6525], this
notification is passed to the upper layer, informing it about the notification is passed to the upper layer, informing it about the
result. result.
SENDER DRY notification: When SCTP has no more user data to send or
retransmit on a particular association, this notification is
passed to the upper layer [RFC6458].
PARTIAL DELIVERY ABORTED notification: When a receiver has begun to
receive parts of a user message but the delivery of this message
is then aborted, this notification is passed to the upper layer
(section 6.1.7 of [RFC6458]).
3.3.1. Excluded Primitives or Parameters 3.3.1. Excluded Primitives or Parameters
The 'Receive' primitive can return certain additional information, The 'Receive' primitive can return certain additional information,
but this is optional to implement and therefore not considered. With but this is optional to implement and therefore not considered. With
a COMMUNICATION LOST notification, some more information may a COMMUNICATION LOST notification, some more information may
optionally be passed to the application (e.g., identification to optionally be passed to the application (e.g., identification to
retrieve unsent and unacknowledged data). SCTP "can invoke" a retrieve unsent and unacknowledged data). SCTP "can invoke" a
COMMUNICATION ERROR notification and "may send" a RESTART COMMUNICATION ERROR notification and "may send" a RESTART
notification, making these two notifications optional to implement. notification, making these two notifications optional to implement.
The list provided under 'Status' includes "etc", indicating that more The list provided under 'Status' includes "etc", indicating that more
information could be provided. The primitive 'Get SRTT Report' information could be provided. The primitive 'Get SRTT Report'
returns information that is included in the information that 'Status' returns information that is included in the information that 'Status'
provides and is therefore not discussed. Similarly, 'Set Failure provides and is therefore not discussed. The 'Destroy SCTP Instance'
Threshold' sets only one out of various possible parameters included API function was excluded: it erases the SCTP instance that was
in 'Set Protocol Parameters'. The 'Destroy SCTP Instance' API created by 'Initialize', but is not a Primitive as defined in this
function was excluded: it erases the SCTP instance that was created document because it does not relate to a Transport Feature. The
by 'Initialize', but is not a Primitive as defined in this document SHUTDOWN EVENT described in Section 6.1 of [RFC6458] informs an
because it does not relate to a Transport Service Feature. application that the peer has sent a SHUTDOWN, and hence no further
data should be sent on this socket. However, if an application would
try to send data on the socket, it would get an error message anyway;
thus, this event is classified as "just affecting the application
programming style, not how the underlying protocol operates" and not
included here.
3.4. Primitives Provided by UDP and UDP-Lite 3.4. Primitives Provided by UDP and UDP-Lite
The primitives provided by UDP and UDP-Lite are described in [FJ16]. The primitives provided by UDP and UDP-Lite are described in [FJ16].
3.5. The service of LEDBAT
The service of the Low Extra Delay Background Transport (LEDBAT)
congestion control mechanism is described in the abstract of
[RFC6817] as follows: "LEDBAT is designed for use by background bulk-
transfer applications to be no more aggressive than standard TCP
congestion control (as specified in RFC 5681) and to yield in the
presence of competing flows, thus limiting interference with the
network performance of competing flows."
LEDBAT does not have any primitives, as LEDBAT is not a transport
protocol. [RFC6817] states: "LEDBAT can be used as part of a
transport protocol or as part of an application, as long as the data
transmission mechanisms are capable of carrying timestamps and
acknowledging data frequently. LEDBAT can be used with TCP, Stream
Control Transmission Protocol (SCTP), and Datagram Congestion Control
Protocol (DCCP), with appropriate extensions where necessary; and it
can be used with proprietary application protocols, such as those
built on top of UDP for peer-to- peer (P2P) applications." At the
time of writing, the appropriate extensions for TCP, SCTP or DCCP do
not exist.
A numer of configurable parameters exist in the LEDBAT specification:
TARGET, which is the queuing delay target at which LEDBAT tries to
operate, must be set to 100ms or less. ALLOWED_INCREASE (should be
1, must be greater than 0) limits the speed at which LEDBAT increases
its rate. GAIN, which MUST be set to 1 or less to avoid a faster
ramp-up than TCP Reno, determines how quickly the sender responds to
changes in queueing delay. Implementations may divide GAIN into two
parameters, one for increase and a possibly larger one for decrease.
We call these parameters GAIN_INC and GAIN_DEC here. BASE_HISTORY is
the size of the list of measured base delays, and SHOULD be 10. This
list can be filtered using a FILTER() function which is not
prescribed in [RFC6817], yielding a list of size CURRENT_FILTER. The
initial and minimum congestion windows, INIT_CWND and MIN_CWND,
should both be 2.
Regarding which of these parameters should be under control of an
application, the possible range goes from exposing nothing on the one
hand, to considering everything that is not fully prescribed with a
MUST in [RFC6817] as a parameter on the other hand. Function
implementations are not provided as a parameter to any of the
transport protocols discussed here, and hence we do not regard the
FILTER() function as a parameter. However, to avoid unnecessarily
limiting future implementations, we consider all other parameters
above as tunable parameters that a TAPS system should expose.
4. Pass 2 4. Pass 2
This pass categorizes the primitives from pass 1 based on whether This pass categorizes the primitives from pass 1 based on whether
they relate to a connection or to data transmission. Primitives are they relate to a connection or to data transmission. Primitives are
presented following the nomenclature presented following the nomenclature
"CATEGORY.[SUBCATEGORY].PRIMITIVENAME.PROTOCOL". The CATEGORY can be "CATEGORY.[SUBCATEGORY].PRIMITIVENAME.PROTOCOL". The CATEGORY can be
CONNECTION or DATA. Within the CONNECTION category, ESTABLISHMENT, CONNECTION or DATA. Within the CONNECTION category, ESTABLISHMENT,
AVAILABILITY, MAINTENANCE and TERMINATION subcategories can be AVAILABILITY, MAINTENANCE and TERMINATION subcategories can be
considered. The DATA category does not have any SUBCATEGORY (as of considered. The DATA category does not have any SUBCATEGORY. The
now). The PROTOCOL name "UDP(-Lite)" is used when primitives are PROTOCOL name "UDP(-Lite)" is used when primitives are equivalent for
equivalent for UDP and UDP-Lite; the PROTOCOL name "TCP" refers to UDP and UDP-Lite; the PROTOCOL name "TCP" refers to both TCP and
both TCP and MPTCP. We present "connection" as a general protocol- MPTCP. We present "connection" as a general protocol-independent
independent concept and use it to refer to, e.g., TCP connections concept and use it to refer to, e.g., TCP connections (identifiable
(identifiable by a unique pair of IP addresses and TCP port numbers), by a unique pair of IP addresses and TCP port numbers), SCTP
SCTP associations (identifiable by multiple IP address and port associations (identifiable by multiple IP address and port number
number pairs), as well UDP and UDP-Lite connections (identifiable by pairs), as well UDP and UDP-Lite connections (identifiable by a
a unique socket pair). unique socket pair).
Some minor details are omitted for the sake of generalization -- Some minor details are omitted for the sake of generalization --
e.g., SCTP's 'close' [RFC4960] returns success or failure, whereas e.g., SCTP's 'close' [RFC4960] returns success or failure, and lets
this is not described in the same way for TCP in [RFC0793], but this the application control whether further receive or send operations or
detail plays no significant role for the primitives provided by both are disabled [RFC6458]. This is not described in the same way
either TCP or SCTP. for TCP in [RFC0793], but these details play no significant role for
the primitives provided by either TCP or SCTP (for the sake of being
generic, it could be assumed that both receive and send operations
are disabled in both cases).
The TCP 'send' and 'receive' primitives include usage of an "URGENT" The TCP 'send' and 'receive' primitives include usage of an "URGENT"
mechanism. This mechanism is required to implement the "synch mechanism. This mechanism is required to implement the "synch
signal" used by telnet [RFC0854], but SHOULD NOT be used by new signal" used by telnet [RFC0854], but SHOULD NOT be used by new
applications [RFC6093]. Because pass 2 is meant as a basis for the applications [RFC6093]. Because pass 2 is meant as a basis for the
creation of TAPS systems, the "URGENT" mechanism is excluded. This creation of TAPS systems, the "URGENT" mechanism is excluded. This
also concerns the notification "Urgent pointer advance" in the also concerns the notification "Urgent pointer advance" in the
ERROR_REPORT described in Section 4.2.4.1 of [RFC1122]. ERROR_REPORT described in Section 4.2.4.1 of [RFC1122].
Since LEDBAT is a congestion control mechanism and not a protocol, it
is not currently defined when to enable / disable or configure the
mechanism. For instance, it could be a one-time choice upon
connection establishment or when listening for incoming connections,
in which case it should be categorized under CONNECTION.ESTABLISHMENT
or CONNECTION.AVAILABILITY, respectively. To avoid unnecessarily
limiting future implementations, it was decided to place it under
CONNECTION.MAINTENANCE, with all parameters that are described in
[RFC6817] made configurable.
4.1. CONNECTION Related Primitives 4.1. CONNECTION Related Primitives
ESTABLISHMENT: ESTABLISHMENT:
Active creation of a connection from one transport endpoint to one or Active creation of a connection from one transport endpoint to one or
more transport endpoints. more transport endpoints.
Interfaces to UDP and UDP-Lite allow both connection-oriented and Interfaces to UDP and UDP-Lite allow both connection-oriented and
connection-less usage of the API [I-D.ietf-tsvwg-rfc5405bis] connection-less usage of the API . [RFC8085]
o CONNECT.TCP: o CONNECT.TCP:
Pass 1 primitive / event: 'open' (active) or 'open' (passive) with Pass 1 primitive / event: 'open' (active) or 'open' (passive) with
socket, followed by 'send' socket, followed by 'send'
Parameters: 1 local IP address (optional); 1 destination transport Parameters: 1 local IP address (optional); 1 destination transport
address (for active open; else the socket and the local IP address address (for active open; else the socket and the local IP address
of the succeeding incoming connection request will be maintained); of the succeeding incoming connection request will be maintained);
timeout (optional); options (optional) timeout (optional); options (optional); user message (optional)
Comments: If the local IP address is not provided, a default Comments: If the local IP address is not provided, a default
choice will automatically be made. The timeout can also be a choice will automatically be made. The timeout can also be a
retransmission count. The options are IP options to be used on retransmission count. The options are IP options to be used on
all segments of the connection. At least the Source Route option all segments of the connection. At least the Source Route option
is mandatory for TCP to provide. is mandatory for TCP to provide. The user message may be
transmitted to the peer application immediately upon reception of
the TCP SYN packet. To benefit from the lower latency this
provides as part of the experimental TFO mechanism, its length
must be at most the TCP's maximum segment size (minus TCP options
used in the SYN). The message may also be delivered more than
once to the application on the remote host.
o CONNECT.SCTP: o CONNECT.SCTP:
Pass 1 primitive / event: 'initialize', followed by 'associate' Pass 1 primitive / event: 'initialize', followed by 'enable /
disable interleaving' (optional), followed by 'associate'
Parameters: list of local SCTP port number / IP address pairs Parameters: list of local SCTP port number / IP address pairs
(initialize); 1 socket; outbound stream count; adaptation layer (initialize); one or several sockets (identifying the peer);
indication; chunk types required to be authenticated outbound stream count; maximum allowed inbound stream count;
Returns: socket list adaptation layer indication (optional); chunk types required to be
authenticated (optional); request interleaving on/off; maximum
number of INIT attemps (optional); maximum init. RTO for INIT
(optional); user message (optional); remote UDP port number
(optional)
Returns: socket list or failure
Comments: 'initialize' needs to be called only once per list of Comments: 'initialize' needs to be called only once per list of
local SCTP port number / IP address pairs. One socket will local SCTP port number / IP address pairs. One socket will
automatically be chosen; it can later be changed in MAINTENANCE. automatically be chosen; it can later be changed in MAINTENANCE.
The user message may be transmitted to the peer application
immediately upon reception of the packet containing the COOKIE-
ECHO chunk. To benefit from the lower latency this provides, its
length must be limited such that it fits into the packet
containing the COOKIE-ECHO chunk. If a remote UDP port number is
provided, SCTP packets will be encapsulated in UDP.
o CONNECT.MPTCP: o CONNECT.MPTCP:
This is similar to CONNECT.TCP except for one additional boolean This is similar to CONNECT.TCP except for one additional boolean
parameter that allows to enable or disable MPTCP for a particular parameter that allows to enable or disable MPTCP for a particular
connection or socket (default: enabled). connection or socket (default: enabled).
o CONNECT.UDP(-Lite): o CONNECT.UDP(-Lite):
Pass 1 primitive / event: 'connect' followed by 'send'. Pass 1 primitive / event: 'connect' followed by 'send'.
Parameters: 1 local IP address (default (ANY), or specified); 1 Parameters: 1 local IP address (default (ANY), or specified); 1
destination transport address; 1 local port (default (OS chooses), destination transport address; 1 local port (default (OS chooses),
skipping to change at page 15, line 47 skipping to change at page 21, line 15
address to create a new connection. The CONNECT function allows address to create a new connection. The CONNECT function allows
an application to receive errors from messages sent to a transport an application to receive errors from messages sent to a transport
address. address.
AVAILABILITY: AVAILABILITY:
Preparing to receive incoming connection requests. Preparing to receive incoming connection requests.
o LISTEN.TCP: o LISTEN.TCP:
Pass 1 primitive / event: 'open' (passive) Pass 1 primitive / event: 'open' (passive)
Parameters: 1 local IP address (optional); 1 socket (optional); Parameters: 1 local IP address (optional); 1 socket (optional);
timeout (optional) timeout (optional); buffer to receive a user message (optional)
Comments: if the socket and/or local IP address is provided, this Comments: if the socket and/or local IP address is provided, this
waits for incoming connections from only and/or to only the waits for incoming connections from only and/or to only the
provided address. Else this waits for incoming connections provided address. Else this waits for incoming connections
without this / these constraint(s). ESTABLISHMENT can later be without this / these constraint(s). ESTABLISHMENT can later be
performed with 'send'. performed with 'send'. If a buffer is provided to receive a user
message, a user message can be received from a TFO-enabled sender
before TCP's connection handshake is completed. This message may
arrive multiple times.
o LISTEN.SCTP: o LISTEN.SCTP:
Pass 1 primitive / event: 'initialize', followed by 'COMMUNICATION Pass 1 primitive / event: 'initialize', followed by 'COMMUNICATION
UP' notification and possibly 'ADAPTATION LAYER' notification UP' or 'RESTART' notification and possibly 'ADAPTATION LAYER'
notification
Parameters: list of local SCTP port number / IP address pairs Parameters: list of local SCTP port number / IP address pairs
(initialize) (initialize)
Returns: socket list; outbound stream count; inbound stream count; Returns: socket list; outbound stream count; inbound stream count;
adaptation layer indication; chunks required to be authenticated adaptation layer indication; chunks required to be authenticated;
interleaving supported on both sides yes/no
Comments: initialize needs to be called only once per list of Comments: initialize needs to be called only once per list of
local SCTP port number / IP address pairs. COMMUNICATION UP can local SCTP port number / IP address pairs. COMMUNICATION UP can
also follow a COMMUNICATION LOST notification, indicating that the also follow a COMMUNICATION LOST notification, indicating that the
lost communication is restored. If the peer has provided an lost communication is restored. If the peer has provided an
adaptation layer indication, an 'ADAPTATION LAYER' notification is adaptation layer indication, an 'ADAPTATION LAYER' notification is
issued. issued.
o LISTEN.MPTCP: o LISTEN.MPTCP:
This is similar to LISTEN.TCP except for one additional boolean This is similar to LISTEN.TCP except for one additional boolean
parameter that allows to enable or disable MPTCP for a particular parameter that allows to enable or disable MPTCP for a particular
skipping to change at page 16, line 39 skipping to change at page 22, line 12
destination transport address; local port (default (OS chooses), destination transport address; local port (default (OS chooses),
or specified); destination port (default (OS chooses), or or specified); destination port (default (OS chooses), or
specified). specified).
Comments: The receive function registers the application to listen Comments: The receive function registers the application to listen
for incoming UDP(-Lite) datagrams at an endpoint. for incoming UDP(-Lite) datagrams at an endpoint.
MAINTENANCE: MAINTENANCE:
Adjustments made to an open connection, or notifications about it. Adjustments made to an open connection, or notifications about it.
These are out-of-band messages to the protocol that can be issued at These are out-of-band messages to the protocol that can be issued at
any time, at least after a connection has been established and before any time, at least after a connection has been established and before
it has been terminated (with one exception: CHANGE-TIMEOUT.TCP can it has been terminated (with one exception: CHANGE_TIMEOUT.TCP can
only be issued for an open connection when DATA.SEND.TCP is called). only be issued for an open connection when DATA.SEND.TCP is called).
In some cases, these primitives can also be immediately issued during In some cases, these primitives can also be immediately issued during
ESTABLISHMENT or AVAILABILITY, without waiting for the connection to ESTABLISHMENT or AVAILABILITY, without waiting for the connection to
be opened (e.g. CHANGE-TIMEOUT.TCP can be done using TCP's 'open' be opened (e.g. CHANGE_TIMEOUT.TCP can be done using TCP's 'open'
primitive). For UDP and UDP-Lite, these functions may establish a primitive). For UDP and UDP-Lite, these functions may establish a
setting per connection, but may also be changed per datagram message. setting per connection, but may also be changed per datagram message.
o CHANGE-TIMEOUT.TCP: o CHANGE_TIMEOUT.TCP:
Pass 1 primitive / event: 'open' or 'send' combined with Pass 1 primitive / event: 'open' or 'send' combined with
unspecified control of per-connection state variables unspecified control of per-connection state variables
Parameters: timeout value (optional); ADV_UTO (optional); boolean Parameters: timeout value (optional); ADV_UTO (optional); boolean
UTO_ENABLED (optional, default false); boolean CHANGEABLE UTO_ENABLED (optional, default false); boolean CHANGEABLE
(optional, default true) (optional, default true)
Comments: when sending data, an application can adjust the Comments: when sending data, an application can adjust the
connection's timeout value (time after which the connection will connection's timeout value (time after which the connection will
be aborted if data could not be delivered). If UTO_ENABLED is be aborted if data could not be delivered). If UTO_ENABLED is
true, the user timeout value (or, if provided, the value ADV_UTO) true, the user timeout value (or, if provided, the value ADV_UTO)
will be advertised for the TCP on the other side of the connection will be advertised for the TCP on the other side of the connection
to adapt its own user timeout accordingly. UTO_ENABLED controls to adapt its own user timeout accordingly. UTO_ENABLED controls
whether the UTO option is enabled for a connection. This applies whether the UTO option is enabled for a connection. This applies
to both sending and receiving. CHANGEABLE controls whether the to both sending and receiving. CHANGEABLE controls whether the
user timeout may be changed based on a UTO option received from user timeout may be changed based on a UTO option received from
the other end of the connection; it becomes false when 'timeout the other end of the connection; it becomes false when 'timeout
value' is used. value' is used.
o CHANGE-TIMEOUT.SCTP: o CHANGE_TIMEOUT.SCTP:
Pass 1 primitive / event: 'Change HeartBeat' combined with 'Set Pass 1 primitive / event: 'Change HeartBeat' combined with
Protocol Parameters' 'Configure Max. Retransmissions of an Association'
Parameters: 'Change HeartBeat': heartbeat frequency; 'Set Protocol Parameters: 'Change HeartBeat': heartbeat frequency; 'Configure
Parameters': Association.Max.Retrans (whole association) or Max. Retransmissions of an Association': Association.Max.Retrans
Path.Max.Retrans (per socket)
Comments: Change Heartbeat can enable / disable heartbeats in SCTP Comments: Change Heartbeat can enable / disable heartbeats in SCTP
as well as change their frequency. The parameter as well as change their frequency. The parameter
Association.Max.Retrans defines after how many unsuccessful Association.Max.Retrans defines after how many unsuccessful
heartbeats the connection will be terminated; thus these two transmissions of any packets (including heartbeats) the
primitives / parameters together can yield a similar behavior to association will be terminated; thus these two primitives /
CHANGE-TIMEOUT.TCP. parameters together can yield a similar behavior for SCTP
associations as CHANGE_TIMEOUT.TCP does for TCP connections.
o DISABLE-NAGLE.TCP: o DISABLE_NAGLE.TCP:
Pass 1 primitive / event: not specified Pass 1 primitive / event: not specified
Parameters: one boolean value Parameters: one boolean value
Comments: the Nagle algorithm delays data transmission to increase Comments: the Nagle algorithm delays data transmission to increase
the chance to send a full-sized segment. An application must be the chance to send a full-sized segment. An application must be
able to disable this algorithm for a connection. able to disable this algorithm for a connection.
o REQUESTHEARTBEAT.SCTP: o DISABLE_NAGLE.SCTP:
Pass 1 primitive / event: 'Enable/disable NODELAY'
Parameters: one boolean value
Comments: Nagle-like algorithms delay data transmission to
increase the chance to send a full-sized packet.
o REQUEST_HEARTBEAT.SCTP:
Pass 1 primitive / event: 'Request HeartBeat' Pass 1 primitive / event: 'Request HeartBeat'
Parameters: socket Parameters: socket
Returns: success or failure Returns: success or failure
Comments: requests an immediate heartbeat on a path, returning Comments: requests an immediate heartbeat on a path, returning
success or failure. success or failure.
o SETPROTOCOLPARAMETERS.SCTP: o ADD_PATH.MPTCP:
Pass 1 primitive / event: 'Set Protocol Parameters' Pass 1 primitive / event: not specified
Parameters: RTO.Initial; RTO.Min; RTO.Max; Max.Burst; RTO.Alpha; Parameters: local IP address and optionally the local port number
RTO.Beta; Valid.Cookie.Life; Association.Max.Retrans; Comments: the application specifies the local IP address and port
Path.Max.Retrans; Max.Init.Retransmits; HB.interval; HB.Max.Burst; number that must be used for a new subflow.
PotentiallyFailed.Max.Retrans; Primary.Switchover.Max.Retrans;
Remote.UDPEncapsPort.
o SETPRIMARY.SCTP: o ADD_PATH.SCTP:
Pass 1 primitive / event: Change Local Address / Set Peer Primary
Parameters: local IP address
o REM_PATH.MPTCP:
Pass 1 primitive / event: not specified
Parameters: local IP address, local port number, remote IP
address, remote port number
Comments: the application removes the subflow specified by the IP/
port-pair. The MPTCP implementation must trigger a removal of the
subflow that belongs to this IP/port-pair.
o REM_PATH.SCTP:
Pass 1 primitive / event: 'Change Local Address / Set Peer
Primary'
Parameters: local IP address
o SET_PRIMARY.SCTP:
Pass 1 primitive / event: 'Set Primary' Pass 1 primitive / event: 'Set Primary'
Parameters: socket Parameters: socket
Returns: result of attempting this operation Returns: result of attempting this operation
Comments: update the current primary address to be used, based on Comments: update the current primary address to be used, based on
the set of available sockets of the association. the set of available sockets of the association.
o SETPEERPRIMARY.SCTP: o SET_PEER_PRIMARY.SCTP:
Pass 1 primitive / event: Change Local Address / Set Peer Primary Pass 1 primitive / event: 'Change Local Address / Set Peer
Primary'
Parameters: local IP address Parameters: local IP address
Comments: this is only advisory for the peer. Comments: this is only advisory for the peer.
o SETAUTH.SCTP: o CONFIG_SWITCHOVER.SCTP:
Pass 1 primitive / event: Set / Get Authentication Parameters Pass 1 primitive / event: 'Configure Path Switchover'
Parameters: key_id, key, hmac_id Parameters: primary max retrans (no. of retransmissions after
which a path is considered inactive), PF max retrans (no. of
o GETAUTH.SCTP: retransmissions after which a path is considered to be
Pass 1 primitive / event: Set / Get Authentication Parameters "Potentially Failed", and others will be preferably used)
Parameters: key_id, chunk_list (optional)
o RESETSTREAM.SCTP:
Pass 1 primitive / event: Add / Reset Streams, Reset Association
Parameters: sid, direction
o RESETSTREAM-EVENT.SCTP:
Pass 1 primitive / event: STREAM RESET notification
Parameters: information about the result of RESETSTREAM.SCTP.
Comments: This is issued when the procedure for resetting streams
has completed.
o RESETASSOC.SCTP: o STATUS.SCTP:
Pass 1 primitive / event: Add / Reset Streams, Reset Association Pass 1 primitive / event: 'Status', 'Enable / Disable
Parameters: information related to the extension defined in Interleaving' and 'NETWORK STATUS CHANGE notification'.
[RFC3260]. Returns: data block with information about a specified
association, containing: association connection state; destination
transport address list; destination transport address reachability
states; current local and peer receiver window sizes; current
local congestion window sizes; number of unacknowledged DATA
chunks; number of DATA chunks pending receipt; primary path; most
recent SRTT on primary path; RTO on primary path; SRTT and RTO on
other destination addresses; MTU per path; interleaving supported
yes/no.
Comments: The NETWORK STATUS CHANGE notification informs the
application about a socket becoming active/inactive; this only
affects the programming style, as the same information is also
available via 'Status'.
o RESETASSOC-EVENT.SCTP: o STATUS.MPTCP:
Pass 1 primitive / event: ASSOCIATION RESET notification Pass 1 primitive / event: not specified
Parameters: information about the result of RESETASSOC.SCTP. Returns: list of pairs of tuples of IP address and TCP port number
Comments: This is issued when the procedure for resetting an of each subflow. The first of the pair is the local IP and port
association has completed. number, while the second is the remote IP and port number.
o ADDSTREAM.SCTP: o SET_DSCP.TCP:
Pass 1 primitive / event: Add / Reset Streams, Reset Association Pass 1 primitive / event: not specified
Parameters: number if outgoing and incoming streams to be added Parameters: DSCP value
Comments: this allows an application to change the DSCP value for
outgoing segments. For TCP this was originally specified for the
TOS field [RFC1122], which is here interpreted to refer to the
DSField [RFC3260].
o ADDSTREAM-EVENT.SCTP: o SET_DSCP.SCTP:
Pass 1 primitive / event: STREAM CHANGE notification Pass 1 primitive / event: 'Set DSCP value'
Parameters: information about the result of ADDSTREAM.SCTP. Parameters: DSCP value
Comments: this allows an application to change the DSCP value for
outgoing packets on a path.
Comments: This is issued when the procedure for adding a stream o SET_DSCP.UDP(-Lite):
has completed. Pass 1 primitive / event: 'SET_DSCP'
Parameter: DSCP value
Comments: This allows an application to change the DSCP value for
outgoing UDP(-Lite) datagrams. [RFC7657] and [RFC8085] provide
current guidance on using this value with UDP.
o ERROR.TCP: o ERROR.TCP:
Pass 1 primitive / event: 'ERROR_REPORT' Pass 1 primitive / event: 'ERROR_REPORT'
Returns: reason (encoding not specified); subreason (encoding not Returns: reason (encoding not specified); subreason (encoding not
specified) specified)
Comments: soft errors that can be ignored without harm by many Comments: soft errors that can be ignored without harm by many
applications; an application should be able to disable these applications; an application should be able to disable these
notifications. The reported conditions include at least: ICMP notifications. The reported conditions include at least: ICMP
error message arrived; Excessive Retransmissions. error message arrived; Excessive Retransmissions.
o ERROR.UDP(-Lite): o ERROR.UDP(-Lite):
Pass 1 primitive / event: 'ERROR_REPORT'. Pass 1 primitive / event: 'ERROR_REPORT'.
Returns: Error report Returns: Error report
Comments: This returns soft errors that may be ignored without Comments: This returns soft errors that may be ignored without
harm by many applications; An application must connect to be able harm by many applications; An application must connect to be able
receive these notifications. receive these notifications.
o STATUS.SCTP: o SET_AUTH.SCTP:
Pass 1 primitive / event: 'Status' and 'NETWORK STATUS CHANGE' Pass 1 primitive / event: 'Set / Get Authentication Parameters'
notification Parameters: key_id, key, hmac_id
Returns: data block with information about a specified
association, containing: association connection state; socket
list; destination transport address reachability states; current
receiver window size; current congestion window sizes; number of
unacknowledged DATA chunks; number of DATA chunks pending receipt;
primary path; most recent SRTT on primary path; RTO on primary
path; SRTT and RTO on other destination addresses. The NETWORK
STATUS CHANGE notification informs the application about a socket
becoming active/inactive.
o STATUS.MPTCP: o GET_AUTH.SCTP:
Pass 1 primitive / event: not specified Pass 1 primitive / event: 'Set / Get Authentication Parameters'
Returns: list of pairs of tuples of IP address and TCP port number Parameters: key_id, chunk_list
of each subflow. The first of the pair is the local IP and port
number, while the second is the remote IP and port number.
o SET_DSCP.TCP: o RESET_STREAM.SCTP:
Pass 1 primitive / event: not specified Pass 1 primitive / event: 'Add / Reset Streams, Reset Association'
Parameters: DSCP value Parameters: sid, direction
Comments: this allows an application to change the DSCP value for
outgoing segments. For TCP this was originally specified for the
TOS field [RFC1122], which is here interpreted to refer to the
DSField [RFC3260].
o SET_DSCP.UDP(-Lite): o RESET_STREAM-EVENT.SCTP:
Pass 1 primitive / event: 'SET_DSCP' Pass 1 primitive / event: 'STREAM RESET notification'
Parameter: DSCP value Parameters: information about the result of RESET_STREAM.SCTP.
Comments: This allows an application to change the DSCP value for Comments: This is issued when the procedure for resetting streams
outgoing UDP(-Lite) datagrams. [RFC7657] and has completed.
[I-D.ietf-tsvwg-rfc5405bis] provide current guidance on using this
value with UDP.
o ADD_SUBFLOW.MPTCP: o RESET_ASSOC.SCTP:
Pass 1 primitive / event: not specified Pass 1 primitive / event: 'Add / Reset Streams, Reset Association'
Parameters: local IP address and optionally the local port number Parameters: information related to the extension defined in
Comments: the application specifies the local IP address and port [RFC3260].
number that must be used for a new subflow.
o ADD_ADDR.SCTP: o RESET_ASSOC-EVENT.SCTP:
Pass 1 primitive / event: Change Local Address / Set Peer Primary Pass 1 primitive / event: 'ASSOCIATION RESET notification'
Parameters: local IP address Parameters: information about the result of RESET_ASSOC.SCTP.
Comments: This is issued when the procedure for resetting an
association has completed.
o REM_SUBFLOW.MPTCP: o ADD_STREAM.SCTP:
Pass 1 primitive / event: not specified Pass 1 primitive / event: 'Add / Reset Streams, Reset Association'
Parameters: local IP address, local port number, remote IP Parameters: number if outgoing and incoming streams to be added
address, remote port number
Comments: the application removes the subflow specified by the IP/
port-pair. The MPTCP implementation must trigger a removal of the
subflow that belongs to this IP/port-pair.
o REM_ADDR.SCTP: o ADD_STREAM-EVENT.SCTP:
Pass 1 primitive / event: Change Local Address / Set Peer Primary Pass 1 primitive / event: 'STREAM CHANGE notification'
Parameters: local IP address Parameters: information about the result of ADD_STREAM.SCTP.
Comments: This is issued when the procedure for adding a stream
has completed.
o SET_STREAM_SCHEDULER.SCTP:
Pass 1 primitive / event: 'Set Stream Scheduler'
Parameters: scheduler identifier
Comments: choice of First Come First Serve, Round Robin, Round
Robin per Packet, Priority Based, Fair Bandwidth, Weighted Fair
Queuing.
o CONFIGURE_STREAM_SCHEDULER.SCTP:
Pass 1 primitive / event: 'Configure Stream Scheduler'
Parameters: priority
Comments: the priority value only applies when Priority Based or
Weighted Fair Queuing scheduling is chosen with
SET_STREAM_SCHEDULER.SCTP. The meaning of the parameter differs
between these two schedulers but in both cases it realizes some
form of prioritization regarding how bandwidth is divided among
streams.
o SET_FLOWLABEL.SCTP:
Pass 1 primitive / event: 'Set IPv6 flow label'
Parameters: flow label
Comments: this allows an application to change the IPv6 header's
flow label field for outgoing packets on a path.
o AUTHENTICATION_NOTIFICATION-EVENT.SCTP:
Pass 1 primitive / event: 'AUTHENTICATION notification'
Returns: information regarding key management.
o CONFIG_SEND_BUFFER.SCTP:
Pass 1 primitive / event: 'Configure send buffer size'
Parameters: size value in octets
o CONFIG_RECEIVE_BUFFER.SCTP:
Pass 1 primitive / event: 'Configure receive buffer size'
Parameters: size value in octets
Comments: this controls the receiver window.
o CONFIG_FRAGMENTATION.SCTP:
Pass 1 primitive / event: 'Configure message fragmentation'
Parameters: one boolean value (enable/disable), maximum
fragmentation size (optional; default: PMTU)
Comments: if fragmentation is enabled, messages exceeding the
maximum fragmentation size will be fragmented. If fragmentation
is disabled, trying to send a message that exceeds the maximum
fragmentation size will produce an error.
o CONFIG_PMTUD.SCTP:
Pass 1 primitive / event: 'Configure Path MTU Discovery'
Parameters: one boolean value (PMTUD on/off), PMTU value
(optional)
Returns: PMTU value
Comments: This returns a meaningful PMTU value when PMTUD is
enabled (the boolean is true), and the PMTU value can be set if
PMTUD is disabled (the boolean is false)
o CONFIG_DELAYED_SACK.SCTP:
Pass 1 primitive / event: 'Configure delayed SACK timer'
Parameters: one boolean value (delayed SACK on/off), timer value
(optional), number of packets to wait for (default 2)
Comments: If delayed SACK is enabled, SCTP will send a SACK upon
either receiving the provided number of packets or when the timer
expires, whatever occurs first.
o CONFIG_RTO.SCTP:
Pass 1 primitive / event: 'Configure RTO calculation'
Parameters: init (optional), min (optional), max (optional)
Comments: This adjusts the initial, minimum and maximum RTO
values.
o SET_COOKIE_LIFE.SCTP:
Pass 1 primitive / event: 'Set Cookie life value'
Parameters: cookie life value
o SET_MAX_BURST.SCTP:
Pass 1 primitive / event: 'Set maximum burst'
Parameters: max burst value
Comments: not all implementations allow values above the default
of 4.
o SET_PARTIAL_DELIVERY_POINT.SCTP:
Pass 1 primitive / event: 'Set Partial Delivery Point'
Parameters: partial delivery point (integer)
Comments: this parameter must be smaller or equal to the socket
receive buffer size.
o CHECKSUM.UDP: o CHECKSUM.UDP:
Pass 1 primitive / event: 'DISABLE_CHECKSUM'. Pass 1 primitive / event: 'DISABLE_CHECKSUM'.
Parameters: 0 when no checksum is used at sender, 1 for checksum Parameters: 0 when no checksum is used at sender, 1 for checksum
at sender (default). at sender (default)
o CHECKSUM_REQUIRED.UDP: o CHECKSUM_REQUIRED.UDP:
Pass 1 primitive / event: 'REQUIRE_CHECKSUM'. Pass 1 primitive / event: 'REQUIRE_CHECKSUM'.
Parameter: 0 when checksum is required at receiver, 1 to allow Parameter: 0 when checksum is required at receiver, 1 to allow
zero checksum at receiver (default). zero checksum at receiver (default)
o SET_CHECKSUM_COVERAGE.UDP-Lite: o SET_CHECKSUM_COVERAGE.UDP-Lite:
Pass 1 primitive / event: 'SET_CHECKSUM_COVERAGE'. Pass 1 primitive / event: 'SET_CHECKSUM_COVERAGE'
Parameters: Coverage length at sender (default maximum coverage) Parameters: Coverage length at sender (default maximum coverage)
o SET_MIN_CHECKSUM_COVERAGE.UDP-Lite: o SET_MIN_CHECKSUM_COVERAGE.UDP-Lite:
Pass 1 primitive / event: 'SET_MIN_COVERAGE'. Pass 1 primitive / event: 'SET_MIN_COVERAGE'.
Parameter: Coverage length at receiver (default minimum coverage) Parameter: Coverage length at receiver (default minimum coverage)
o SET_DF.UDP(-Lite): o SET_DF.UDP(-Lite):
Pass 1 primitive event: 'SET_DF'. Pass 1 primitive event: 'SET_DF'.
Parameter: 0 when DF is not set (default), 1 when DF is set. Parameter: 0 when DF is not set (default), 1 when DF is set
o SET_TTL.UDP(-Lite) (IPV6_UNICAST_HOPS): o SET_TTL.UDP(-Lite) (IPV6_UNICAST_HOPS):
Pass 1 primitive / event: 'SET_TTL' and 'SET_IPV6_UNICAST_HOPS' Pass 1 primitive / event: 'SET_TTL' and 'SET_IPV6_UNICAST_HOPS'
Parameters: IPv4 TTL value or IPv6 Hop Count value Parameters: IPv4 TTL value or IPv6 Hop Count value
Comments: This allows an application to change the IPv4 TTL of Comments: This allows an application to change the IPv4 TTL of
IPv6 Hop count value for outgoing UDP(-Lite) datagrams. IPv6 Hop count value for outgoing UDP(-Lite) datagrams.
o GET_TTL.UDP(-Lite) (IPV6_UNICAST_HOPS): o GET_TTL.UDP(-Lite) (IPV6_UNICAST_HOPS):
Pass 1 primitive / event: 'GET_TTL' and 'GET_IPV6_UNICAST_HOPS' Pass 1 primitive / event: 'GET_TTL' and 'GET_IPV6_UNICAST_HOPS'
Returns: IPv4 TTL value or IPv6 Hop Count value Returns: IPv4 TTL value or IPv6 Hop Count value
skipping to change at page 21, line 46 skipping to change at page 29, line 24
Comments: This allows a UDP(-Lite) application to set IP Options Comments: This allows a UDP(-Lite) application to set IP Options
for outgoing UDP(-Lite) datagrams. These options can at least be for outgoing UDP(-Lite) datagrams. These options can at least be
the Source Route, Record Route, and Time Stamp option. the Source Route, Record Route, and Time Stamp option.
o GET_IP_OPTIONS.UDP(-Lite): o GET_IP_OPTIONS.UDP(-Lite):
Pass 1 primitive / event: 'GET_IP_OPTIONS' Pass 1 primitive / event: 'GET_IP_OPTIONS'
Returns: options Returns: options
Comments: This allows a UDP(-Lite) application to receive any IP Comments: This allows a UDP(-Lite) application to receive any IP
options that are contained in a received UDP(-Lite) datagram. options that are contained in a received UDP(-Lite) datagram.
o AUTHENTICATION_NOTIFICATION-EVENT.SCTP: o CONFIGURE.LEDBAT:
Pass 1 primitive / event: 'AUTHENTICATION notification' Pass 1 primitive / event: N/A
Returns: information regarding key management. Parameters: enable (boolean), TARGET, ALLOWED_INCREASE, GAIN_INC,
GAIN_DEC, BASE_HISTORY, CURRENT_FILTER, INIT_CWND, MIN_CWND
Comments: enable is a newly invented parameter that enables or
disables the whole LEDBAT service.
TERMINATION: TERMINATION:
Gracefully or forcefully closing a connection, or being informed Gracefully or forcefully closing a connection, or being informed
about this event happening. about this event happening.
o CLOSE.TCP: o CLOSE.TCP:
Pass 1 primitive / event: 'close' Pass 1 primitive / event: 'close'
Comments: this terminates the sending side of a connection after Comments: this terminates the sending side of a connection after
reliably delivering all remaining data. reliably delivering all remaining data.
skipping to change at page 22, line 37 skipping to change at page 30, line 21
Pass 1 primitive / event: 'abort' Pass 1 primitive / event: 'abort'
Parameters: abort reason to be given to the peer (optional) Parameters: abort reason to be given to the peer (optional)
Comments: this terminates a connection without delivering Comments: this terminates a connection without delivering
remaining data and sends an error message to the other side. remaining data and sends an error message to the other side.
o TIMEOUT.TCP: o TIMEOUT.TCP:
Pass 1 primitive / event: 'USER TIMEOUT' event Pass 1 primitive / event: 'USER TIMEOUT' event
Comments: the application is informed that the connection is Comments: the application is informed that the connection is
aborted. This event is executed on expiration of the timeout set aborted. This event is executed on expiration of the timeout set
in CONNECTION.ESTABLISHMENT.CONNECT.TCP (possibly adjusted in in CONNECTION.ESTABLISHMENT.CONNECT.TCP (possibly adjusted in
CONNECTION.MAINTENANCE.CHANGE-TIMEOUT.TCP). CONNECTION.MAINTENANCE.CHANGE_TIMEOUT.TCP).
o TIMEOUT.SCTP: o TIMEOUT.SCTP:
Pass 1 primitive / event: 'COMMUNICATION LOST' event Pass 1 primitive / event: 'COMMUNICATION LOST' event
Comments: the application is informed that the connection is Comments: the application is informed that the connection is
aborted. this event is executed on expiration of the timeout that aborted. this event is executed on expiration of the timeout that
should be enabled by default (see beginning of section 8.3 in should be enabled by default (see beginning of section 8.3 in
[RFC4960]) and was possibly adjusted in [RFC4960]) and was possibly adjusted in
CONNECTION.MAINTENANCE.CHANGE-TIMEOOUT.SCTP. CONNECTION.MAINTENANCE.CHANGE_TIMEOOUT.SCTP.
o ABORT-EVENT.TCP: o ABORT-EVENT.TCP:
Pass 1 primitive / event: not specified. Pass 1 primitive / event: not specified.
o ABORT-EVENT.SCTP: o ABORT-EVENT.SCTP:
Pass 1 primitive / event: 'COMMUNICATION LOST' event Pass 1 primitive / event: 'COMMUNICATION LOST' event
Returns: abort reason from the peer (if available) Returns: abort reason from the peer (if available)
Comments: the application is informed that the other side has Comments: the application is informed that the other side has
aborted the connection using CONNECTION.TERMINATION.ABORT.SCTP. aborted the connection using CONNECTION.TERMINATION.ABORT.SCTP.
skipping to change at page 23, line 26 skipping to change at page 31, line 7
Comments: the application is informed that Comments: the application is informed that
CONNECTION.TERMINATION.CLOSE.SCTP was successfully completed. CONNECTION.TERMINATION.CLOSE.SCTP was successfully completed.
4.2. DATA Transfer Related Primitives 4.2. DATA Transfer Related Primitives
All primitives in this section refer to an existing connection, i.e. All primitives in this section refer to an existing connection, i.e.
a connection that was either established or made available for a connection that was either established or made available for
receiving data (although this is optional for the primitives of UDP(- receiving data (although this is optional for the primitives of UDP(-
Lite)). In addition to the listed parameters, all sending primitives Lite)). In addition to the listed parameters, all sending primitives
contain a reference to a data block and all receiving primitives contain a reference to a data block and all receiving primitives
contain a reference to available buffer space for the data. contain a reference to available buffer space for the data. Note
that CONNECT.TCP and LISTEN.TCP in the ESTABLISHMENT and AVAILABILITY
category also allow to transfer data (an optional user message)
before the connection is fully established.
o SEND.TCP: o SEND.TCP:
Pass 1 primitive / event: 'send' Pass 1 primitive / event: 'send'
Parameters: timeout (optional) Parameters: timeout (optional)
Comments: this gives TCP a data block for reliable transmission to Comments: this gives TCP a data block for reliable transmission to
the TCP on the other side of the connection. The timeout can be the TCP on the other side of the connection. The timeout can be
configured with this call whenever data are sent (see also configured with this call whenever data are sent (see also
CONNECTION.MAINTENANCE.CHANGE-TIMEOUT.TCP). CONNECTION.MAINTENANCE.CHANGE-TIMEOUT.TCP).
o SEND.SCTP: o SEND.SCTP:
skipping to change at page 24, line 6 skipping to change at page 31, line 38
'stream number' denotes the stream to be used. The 'context' 'stream number' denotes the stream to be used. The 'context'
number can later be used to refer to the correct message when an number can later be used to refer to the correct message when an
error is reported. The 'socket' can be used to state which path error is reported. The 'socket' can be used to state which path
should be preferred, if there are multiple paths available (see should be preferred, if there are multiple paths available (see
also CONNECTION.MAINTENANCE.SETPRIMARY.SCTP). The data block can also CONNECTION.MAINTENANCE.SETPRIMARY.SCTP). The data block can
be delivered out-of-order if the 'unordered flag' is set. The be delivered out-of-order if the 'unordered flag' is set. The
'no-bundle flag' can be set to indicate a preference to avoid 'no-bundle flag' can be set to indicate a preference to avoid
bundling. The 'payload protocol-id' is a number that will, if bundling. The 'payload protocol-id' is a number that will, if
provided, be handed over to the receiving application. Using pr- provided, be handed over to the receiving application. Using pr-
policy and pr-value the level of reliability can be controlled. policy and pr-value the level of reliability can be controlled.
The sack-immediately flag can be used to indicate that the peer The 'sack-immediately' flag can be used to indicate that the peer
should not delay the sending of a SACK corresponding to the should not delay the sending of a SACK corresponding to the
provided user message. If specified, the provided key-id is used provided user message. If specified, the provided key-id is used
for authenticating the user message. for authenticating the user message.
o SEND.UDP(-Lite): o SEND.UDP(-Lite):
Pass 1 primitive / event: 'SEND' Pass 1 primitive / event: 'SEND'
Parameters: IP Address and Port Number of the destination endpoint Parameters: IP Address and Port Number of the destination endpoint
(optional if connected). (optional if connected).
Comments: This provides a message for unreliable transmission Comments: This provides a message for unreliable transmission
using UDP(-Lite) to the specified transport address. IP address using UDP(-Lite) to the specified transport address. IP address
skipping to change at page 25, line 6 skipping to change at page 32, line 38
o SENDFAILURE-EVENT.SCTP: o SENDFAILURE-EVENT.SCTP:
Pass 1 primitive / event: 'SEND FAILURE' notification, optionally Pass 1 primitive / event: 'SEND FAILURE' notification, optionally
followed by 'Receive Unsent Message' or 'Receive Unacknowledged followed by 'Receive Unsent Message' or 'Receive Unacknowledged
Message' Message'
Returns: cause code; context; unsent or unacknowledged message Returns: cause code; context; unsent or unacknowledged message
(optional) (optional)
Comments: 'cause code' indicates the reason of the failure, and Comments: 'cause code' indicates the reason of the failure, and
'context' is the context number if such a number has been provided 'context' is the context number if such a number has been provided
in DATA.SEND.SCTP, for later use with 'Receive Unsent Message' or in DATA.SEND.SCTP, for later use with 'Receive Unsent Message' or
'Receive Unacknowledged Message', respectively. These primitives 'Receive Unacknowledged Message', respectively. These primitives
can be used to retrieve the complete unsent or unacknowledged can be used to retrieve the unsent or unacknowledged message (or
message if desired. part of the message, in case a part was delivered) if desired.
o SEND_FAILURE.UDP(-Lite): o SEND_FAILURE.UDP(-Lite):
Pass 1 primitive / event: 'SEND' Pass 1 primitive / event: 'SEND'
Comment: This may be used to probe for the effective PMTU when Comments: This may be used to probe for the effective PMTU when
using in combination with the 'MAINTENANCE.SET_DF' primitive. using in combination with the 'MAINTENANCE.SET_DF' primitive.
o SENDER_DRY-EVENT.SCTP:
Pass 1 primitive / event: 'SENDER DRY' notification
Comments: This informs the application that the stack has no more
user data to send.
o PARTIAL_DELIVERY_ABORTED-EVENT.SCTP:
Pass 1 primitive / event: 'PARTIAL DELIVERY ABORTED' notification
Comments: This informs the receiver of a partial message that the
further delivery of the message has been aborted.
5. Pass 3 5. Pass 3
This section presents the superset of all transport service features This section presents the superset of all Transport Features in all
in all protocols that were discussed in the preceding sections, based protocols that were discussed in the preceding sections, based on the
on the list of primitives in pass 2 but also on text in pass 1 to list of primitives in pass 2 but also on text in pass 1 to include
include features that can be configured in one protocol and are features that can be configured in one protocol and are static
static properties in another (congestion control, for example). properties in another (congestion control, for example). Again, some
Again, some minor details are omitted for the sake of generalization minor details are omitted for the sake of generalization -- e.g., TCP
-- e.g., TCP may provide various different IP options, but only may provide various different IP options, but only source route is
source route is mandatory to implement, and this detail is not mandatory to implement, and this detail is not visible in the Pass 3
visible in the Pass 3 feature "Specify IP Options". feature "Specify IP Options".
5.1. CONNECTION Related Transport Service Features 5.1. CONNECTION Related Transport Features
ESTABLISHMENT: ESTABLISHMENT:
Active creation of a connection from one transport endpoint to one or Active creation of a connection from one transport endpoint to one or
more transport endpoints. more transport endpoints.
o Connect o Connect
Protocols: TCP, SCTP, UDP(-Lite) Protocols: TCP, SCTP, UDP(-Lite)
o Specify which IP Options must always be used o Specify which IP Options must always be used
Protocols: TCP Protocols: TCP
o Request multiple streams o Request multiple streams
Protocols: SCTP Protocols: SCTP
o Limit the number of inbound streams
Protocols: SCTP
o Specify number of attempts and/or timeout for the first
establishment message
Protocols: TCP, SCTP
o Obtain multiple sockets o Obtain multiple sockets
Protocols: SCTP Protocols: SCTP
o Disable MPTCP o Disable MPTCP
Protocols: MPTCP Protocols: MPTCP
o Specify which chunk types must always be authenticated o Specify which chunk types must always be authenticated
Protocols: SCTP Protocols: SCTP
Comments: DATA, ACK etc. are different 'chunks' in SCTP; one or Comments: DATA, ACK etc. are different 'chunks' in SCTP; one or
more chunks may be included in a single packet. more chunks may be included in a single packet.
o Indicate an Adaptation Layer (via an adaptation code point) o Indicate an Adaptation Layer (via an adaptation code point)
Protocols: SCTP Protocols: SCTP
o Request to negotiate interleaving of user messages
Protocols: SCTP
o Hand over a message to transfer (possibly multiple times) before
connection establishment
Protocols: TCP
o Hand over a message to transfer during connection establishment
Protocols: SCTP
o Enable UDP encapsulation with a specified remote UDP port number
Protocols: SCTP
AVAILABILITY: AVAILABILITY:
Preparing to receive incoming connection requests. Preparing to receive incoming connection requests.
o Listen, 1 specified local interface o Listen, 1 specified local interface
Protocols: TCP, SCTP, UDP(-Lite) Protocols: TCP, SCTP, UDP(-Lite)
o Listen, N specified local interfaces o Listen, N specified local interfaces
Protocols: SCTP, UDP(-Lite) Protocols: SCTP, UDP(-Lite)
o Listen, all local interfaces o Listen, all local interfaces
Protocols: TCP, SCTP, UDP(-Lite) Protocols: TCP, SCTP, UDP(-Lite)
o Obtain requested number of streams o Obtain requested number of streams
Protocols: SCTP Protocols: SCTP
o Limit the number of inbound streams
Protocols: SCTP
o Specify which IP Options must always be used o Specify which IP Options must always be used
Protocols: TCP Protocols: TCP
o Disable MPTCP o Disable MPTCP
Protocols: MPTCP Protocols: MPTCP
o Specify which chunk types must always be authenticated o Specify which chunk types must always be authenticated
Protocols: SCTP Protocols: SCTP
Comments: DATA, ACK etc. are different 'chunks' in SCTP; one or Comments: DATA, ACK etc. are different 'chunks' in SCTP; one or
more chunks may be included in a single packet. more chunks may be included in a single packet.
o Indicate an Adaptation Layer (via an adaptation code point) o Indicate an Adaptation Layer (via an adaptation code point)
Protocols: SCTP Protocols: SCTP
MAINTENANCE: MAINTENANCE:
Adjustments made to an open connection, or notifications about it. Adjustments made to an open connection, or notifications about it.
NOTE: all features except "set primary path" in this category apply
to one out of multiple possible paths (identified via sockets) in
SCTP, whereas TCP uses only one path (one socket).
o Change timeout for aborting connection (using retransmit limit or o Change timeout for aborting connection (using retransmit limit or
time value) time value)
Protocols: TCP, SCTP Protocols: TCP, SCTP
o Control advertising timeout for aborting connection to remote o Suggest timeout to the peer
endpoint
Protocols: TCP Protocols: TCP
o Disable Nagle algorithm o Disable Nagle algorithm
Protocols: TCP, SCTP Protocols: TCP, SCTP
Comments: This is not specified in [RFC4960] but in [RFC6458].
o Request an immediate heartbeat, returning success/failure o Request an immediate heartbeat, returning success/failure
Protocols: SCTP Protocols: SCTP
o Set protocol parameters
Protocols: SCTP
SCTP parameters: RTO.Initial; RTO.Min; RTO.Max; Max.Burst;
RTO.Alpha; RTO.Beta; Valid.Cookie.Life; Association.Max.Retrans;
Path.Max.Retrans; Max.Init.Retransmits; HB.interval; HB.Max.Burst;
PotentiallyFailed.Max.Retrans; Primary.Switchover.Max.Retrans;
Remote.UDPEncapsPort
Comments: as transport layer features from other protocols are
added, it might make sense to separate out some of these
parameters -- e.g., if a different protocol provides means to
adjust the RTO calculation there could be a common feature for
them called "adjust RTO calculation".
o Notification of Excessive Retransmissions (early warning below o Notification of Excessive Retransmissions (early warning below
abortion threshold) abortion threshold)
Protocols: TCP Protocols: TCP
o Notification of ICMP error message arrival o Add path
Protocols: TCP, UDP(-Lite) Protocols: MPTCP, SCTP
MPTCP Parameters: source-IP; source-Port; destination-IP;
destination-Port
SCTP Parameters: local IP address
o Remove path
Protocols: MPTCP, SCTP
MPTCP Parameters: source-IP; source-Port; destination-IP;
destination-Port
SCTP Parameters: local IP address
o Set primary path
Protocols: SCTP
o Suggest primary path to the peer
Protocols: SCTP
o Configure Path Switchover
Protocols: SCTP
o Obtain status (query or notification) o Obtain status (query or notification)
Protocols: SCTP, MPTCP Protocols: SCTP, MPTCP
SCTP parameters: association connection state; socket list; socket SCTP parameters: association connection state; destination
reachability states; current receiver window size; current transport address list; destination transport address reachability
congestion window sizes; number of unacknowledged DATA chunks; states; current local and peer receiver window sizes; current
number of DATA chunks pending receipt; primary path; most recent local congestion window sizes; number of unacknowledged DATA
SRTT on primary path; RTO on primary path; SRTT and RTO on other chunks; number of DATA chunks pending receipt; primary path; most
destination addresses; socket becoming active / inactive recent SRTT on primary path; RTO on primary path; SRTT and RTO on
other destination addresses; MTU per path; interleaving supported
yes/no
MPTCP parameters: subflow-list (identified by source-IP; source- MPTCP parameters: subflow-list (identified by source-IP; source-
Port; destination-IP; destination-Port) Port; destination-IP; destination-Port)
o Specify DSCP field
Protocols: TCP, SCTP, UDP(-Lite)
o Notification of ICMP error message arrival
Protocols: TCP, UDP(-Lite)
o Change authentication parameters o Change authentication parameters
Protocols: SCTP Protocols: SCTP
o Obtain authentication information o Obtain authentication information
Protocols: SCTP Protocols: SCTP
o Set primary path
Protocols: SCTP
o Reset Stream o Reset Stream
Protocols: SCTP Protocols: SCTP
o Notification of Stream Reset o Notification of Stream Reset
Protocols: STCP Protocols: STCP
o Reset Association o Reset Association
Protocols: SCTP Protocols: SCTP
o Notification of Association Reset o Notification of Association Reset
Protocols: STCP Protocols: STCP
o Add Streams o Add Streams
Protocols: SCTP Protocols: SCTP
o Notification of Added Stream o Notification of Added Stream
Protocols: STCP Protocols: STCP
o Set peer primary path o Choose a scheduler to operate between streams of an association
Protocols: SCTP Protocols: SCTP
o Specify DSCP field o Configure priority or weight for a scheduler
Protocols: TCP, SCTP, UDP(-Lite) Protocols: SCTP
o Add subflow o Specify IPv6 flow label field
Protocols: MPTCP Protocols: SCTP
MPTCP Parameters: source-IP; source-Port; destination-IP;
destination-Port
o Remove subflow o Configure send buffer size
Protocols: MPTCP Protocols: SCTP
MPTCP Parameters: source-IP; source-Port; destination-IP;
destination-Port
o Add local address o Configure receive buffer (and rwnd) size
Protocols: SCTP Protocols: SCTP
o Remove local address o Configure message fragmentation
Protocols: SCTP
o Configure PMTUD
Protocols: SCTP
o Configure delayed SACK timer
Protocols: SCTP
o Set Cookie life value
Protocols: SCTP
o Set maximum burst
Protocols: SCTP
o Configure size where messages are broken up for partial delivery
Protocols: SCTP Protocols: SCTP
o Disable checksum when sending o Disable checksum when sending
Protocols: UDP Protocols: UDP
o Disable checksum requirement when receiving o Disable checksum requirement when receiving
Protocols: UDP Protocols: UDP
o Specify checksum coverage used by the sender o Specify checksum coverage used by the sender
Protocols: UDP-Lite Protocols: UDP-Lite
skipping to change at page 29, line 35 skipping to change at page 38, line 23
o Obtain ECN field o Obtain ECN field
Protocols: UDP(-Lite) Protocols: UDP(-Lite)
o Specify IP Options o Specify IP Options
Protocols: UDP(-Lite) Protocols: UDP(-Lite)
o Obtain IP Options o Obtain IP Options
Protocols: UDP(-Lite) Protocols: UDP(-Lite)
o Enable and configure "Low Extra Delay Background Transfer"
Protocols: A protocol implementing the LEDBAT congestion control
mechanism
TERMINATION: TERMINATION:
Gracefully or forcefully closing a connection, or being informed Gracefully or forcefully closing a connection, or being informed
about this event happening. about this event happening.
o Close after reliably delivering all remaining data, causing an o Close after reliably delivering all remaining data, causing an
event informing the application on the other side event informing the application on the other side
Protocols: TCP, SCTP Protocols: TCP, SCTP
Comments: A TCP endpoint locally only closes the connection for Comments: A TCP endpoint locally only closes the connection for
sending; it may still receive data afterwards. sending; it may still receive data afterwards.
skipping to change at page 30, line 11 skipping to change at page 39, line 5
Comments: In SCTP a reason can optionally be given by the Comments: In SCTP a reason can optionally be given by the
application on the aborting side, which can then be received by application on the aborting side, which can then be received by
the application on the other side. the application on the other side.
o Timeout event when data could not be delivered for too long o Timeout event when data could not be delivered for too long
Protocols: TCP, SCTP Protocols: TCP, SCTP
Comments: the timeout is configured with CONNECTION.MAINTENANCE Comments: the timeout is configured with CONNECTION.MAINTENANCE
"Change timeout for aborting connection (using retransmit limit or "Change timeout for aborting connection (using retransmit limit or
time value)". time value)".
5.2. DATA Transfer Related Transport Service Features 5.2. DATA Transfer Related Transport Features
All features in this section refer to an existing connection, i.e. a All features in this section refer to an existing connection, i.e. a
connection that was either established or made available for connection that was either established or made available for
receiving data. Reliable data transfer entails delay -- e.g. for the receiving data. Note that TCP allows to transfer data (a single
sender to wait until it can transmit data, or due to retransmission optional user message, possibly arriving multiple times) before the
in case of packet loss. connection is fully established. Reliable data transfer entails
delay -- e.g. for the sender to wait until it can transmit data, or
due to retransmission in case of packet loss.
5.2.1. Sending Data 5.2.1. Sending Data
All features in this section are provided by DATA.SEND from pass 2. All features in this section are provided by DATA.SEND from pass 2.
DATA.SEND is given a data block from the application, which we here DATA.SEND is given a data block from the application, which we here
call a "message" if the beginning and end of the data block can be call a "message" if the beginning and end of the data block can be
identified at the receiver, and "data" otherwise. identified at the receiver, and "data" otherwise.
o Reliably transfer data, with congestion control o Reliably transfer data, with congestion control
Protocols: TCP Protocols: TCP
skipping to change at page 31, line 25 skipping to change at page 40, line 18
o Request not to delay the acknowledgement (SACK) of a message o Request not to delay the acknowledgement (SACK) of a message
Protocols: SCTP Protocols: SCTP
5.2.2. Receiving Data 5.2.2. Receiving Data
All features in this section are provided by DATA.RECEIVE from pass All features in this section are provided by DATA.RECEIVE from pass
2. DATA.RECEIVE fills a buffer provided by the application, with 2. DATA.RECEIVE fills a buffer provided by the application, with
what we here call a "message" if the beginning and end of the data what we here call a "message" if the beginning and end of the data
block can be identified at the receiver, and "data" otherwise. block can be identified at the receiver, and "data" otherwise.
o Receive data o Receive data (with no message delineation)
Protocols: TCP Protocols: TCP
o Receive a message o Receive a message
Protocols: SCTP, UDP(-Lite) Protocols: SCTP, UDP(-Lite)
o Choice of stream to receive from o Choice of stream to receive from
Protocols: SCTP Protocols: SCTP
o Information about partial message arrival o Information about partial message arrival
Protocols: SCTP Protocols: SCTP
skipping to change at page 32, line 5 skipping to change at page 40, line 43
o Obtain a message delivery number o Obtain a message delivery number
Protocols: SCTP Protocols: SCTP
Comments: This number can let applications detect and, if desired, Comments: This number can let applications detect and, if desired,
correct reordering. correct reordering.
5.2.3. Errors 5.2.3. Errors
This section describes sending failures that are associated with a This section describes sending failures that are associated with a
specific call to DATA.SEND from pass 2. specific call to DATA.SEND from pass 2.
o Notification of unsent messages o Notification of an unsent (part of a) message
Protocols: SCTP, UDP(-Lite) Protocols: SCTP, UDP(-Lite)
o Notification of unacknowledged messages o Notification of an unacknowledged (part of a) message
Protocols: SCTP
o Notification that the stack has no more user data to send
Protocols: SCTP
o Notification to a receiver that a partial message delivery has
been aborted
Protocols: SCTP Protocols: SCTP
6. Acknowledgements 6. Acknowledgements
The authors would like to thank (in alphabetical order) Bob Briscoe, The authors would like to thank (in alphabetical order) Bob Briscoe,
Gorry Fairhurst, David Hayes, Tom Jones, Karen Nielsen and Joe Touch Gorry Fairhurst, David Hayes, Tom Jones, Karen Nielsen, Joe Touch and
for providing valuable feedback on this document. We especially Brian Trammell for providing valuable feedback on this document. We
thank to Christoph Paasch for providing input related to Multipath especially thank Christoph Paasch for providing input related to
TCP. This work has received funding from the European Union's Multipath TCP. This work has received funding from the European
Horizon 2020 research and innovation programme under grant agreement Union's Horizon 2020 research and innovation programme under grant
No. 644334 (NEAT). The views expressed are solely those of the agreement No. 644334 (NEAT). The views expressed are solely those of
author(s). the author(s).
7. IANA Considerations 7. IANA Considerations
XX RFC ED - PLEASE REMOVE THIS SECTION XXX XX RFC ED - PLEASE REMOVE THIS SECTION XXX
This memo includes no request to IANA. This memo includes no request to IANA.
8. Security Considerations 8. Security Considerations
Security will be considered in future versions of this document. Authentication, confidentiality protection, and integrity protection
are identified as Transport Features by [RFC8095]. As currently
deployed in the Internet, these features are generally provided by a
protocol or layer on top of the transport protocol; no current full-
featured standards-track transport protocol provides these features
on its own. Therefore, these features are not considered in this
document, with the exception of native authentication capabilities of
SCTP for which the security considerations in [RFC4895] apply.
9. References 9. References
9.1. Normative References 9.1. Normative References
[I-D.ietf-tsvwg-rfc5405bis] [FJ16] Fairhurst, G. and T. Jones, "Features of the User Datagram
Eggert, L., Fairhurst, G., and G. Shepherd, "UDP Usage Protocol (UDP) and Lightweight UDP (UDP-Lite) Transport
Guidelines", draft-ietf-tsvwg-rfc5405bis-07 (work in Protocols", draft-ietf-taps-transports-usage-udp-00 (work
progress), November 2015. in progress), November 2016.
[I-D.ietf-tsvwg-sctp-ndata]
Stewart, R., Tuexen, M., Loreto, S., and R. Seggelmann,
"Stream Schedulers and User Message Interleaving for the
Stream Control Transmission Protocol",
draft-ietf-tsvwg-sctp-ndata-08 (work in progress),
October 2016.
[RFC0793] Postel, J., "Transmission Control Protocol", STD 7, [RFC0793] Postel, J., "Transmission Control Protocol", STD 7,
RFC 793, DOI 10.17487/RFC0793, September 1981, RFC 793, DOI 10.17487/RFC0793, September 1981,
<http://www.rfc-editor.org/info/rfc793>. <http://www.rfc-editor.org/info/rfc793>.
[RFC1122] Braden, R., Ed., "Requirements for Internet Hosts - [RFC1122] Braden, R., Ed., "Requirements for Internet Hosts -
Communication Layers", STD 3, RFC 1122, DOI 10.17487/ Communication Layers", STD 3, RFC 1122, DOI 10.17487/
RFC1122, October 1989, RFC1122, October 1989,
<http://www.rfc-editor.org/info/rfc1122>. <http://www.rfc-editor.org/info/rfc1122>.
[RFC4960] Stewart, R., Ed., "Stream Control Transmission Protocol",
RFC 4960, DOI 10.17487/RFC4960, September 2007,
<http://www.rfc-editor.org/info/rfc4960>.
[RFC5482] Eggert, L. and F. Gont, "TCP User Timeout Option",
RFC 5482, DOI 10.17487/RFC5482, March 2009,
<http://www.rfc-editor.org/info/rfc5482>.
9.2. Informative References
[FA16] Fairhurst, Ed., G., Trammell, Ed., B., and M. Kuehlewind,
Ed., "Services provided by IETF transport protocols and
congestion control mechanisms",
draft-ietf-taps-transports-12.txt (work in progress),
October 2016.
[FJ16] Fairhurst, G. and T. Jones, "Features of the User Datagram
Protocol (UDP) and Lightweight UDP (UDP-Lite) Transport
Protocols", draft-fairhurst-taps-transports-usage-udp-03
(work in progress), October 2016.
[RFC0854] Postel, J. and J. Reynolds, "Telnet Protocol
Specification", STD 8, RFC 854, DOI 10.17487/RFC0854,
May 1983, <http://www.rfc-editor.org/info/rfc854>.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/
RFC2119, March 1997,
<http://www.rfc-editor.org/info/rfc2119>.
[RFC3168] Ramakrishnan, K., Floyd, S., and D. Black, "The Addition
of Explicit Congestion Notification (ECN) to IP",
RFC 3168, DOI 10.17487/RFC3168, September 2001,
<http://www.rfc-editor.org/info/rfc3168>.
[RFC3260] Grossman, D., "New Terminology and Clarifications for
Diffserv", RFC 3260, DOI 10.17487/RFC3260, April 2002,
<http://www.rfc-editor.org/info/rfc3260>.
[RFC3758] Stewart, R., Ramalho, M., Xie, Q., Tuexen, M., and P. [RFC3758] Stewart, R., Ramalho, M., Xie, Q., Tuexen, M., and P.
Conrad, "Stream Control Transmission Protocol (SCTP) Conrad, "Stream Control Transmission Protocol (SCTP)
Partial Reliability Extension", RFC 3758, DOI 10.17487/ Partial Reliability Extension", RFC 3758, DOI 10.17487/
RFC3758, May 2004, RFC3758, May 2004,
<http://www.rfc-editor.org/info/rfc3758>. <http://www.rfc-editor.org/info/rfc3758>.
[RFC3828] Larzon, L-A., Degermark, M., Pink, S., Jonsson, L-E., Ed.,
and G. Fairhurst, Ed., "The Lightweight User Datagram
Protocol (UDP-Lite)", RFC 3828, DOI 10.17487/RFC3828,
July 2004, <http://www.rfc-editor.org/info/rfc3828>.
[RFC4895] Tuexen, M., Stewart, R., Lei, P., and E. Rescorla, [RFC4895] Tuexen, M., Stewart, R., Lei, P., and E. Rescorla,
"Authenticated Chunks for the Stream Control Transmission "Authenticated Chunks for the Stream Control Transmission
Protocol (SCTP)", RFC 4895, DOI 10.17487/RFC4895, Protocol (SCTP)", RFC 4895, DOI 10.17487/RFC4895,
August 2007, <http://www.rfc-editor.org/info/rfc4895>. August 2007, <http://www.rfc-editor.org/info/rfc4895>.
[RFC4960] Stewart, R., Ed., "Stream Control Transmission Protocol",
RFC 4960, DOI 10.17487/RFC4960, September 2007,
<http://www.rfc-editor.org/info/rfc4960>.
[RFC5061] Stewart, R., Xie, Q., Tuexen, M., Maruyama, S., and M. [RFC5061] Stewart, R., Xie, Q., Tuexen, M., Maruyama, S., and M.
Kozuka, "Stream Control Transmission Protocol (SCTP) Kozuka, "Stream Control Transmission Protocol (SCTP)
Dynamic Address Reconfiguration", RFC 5061, DOI 10.17487/ Dynamic Address Reconfiguration", RFC 5061, DOI 10.17487/
RFC5061, September 2007, RFC5061, September 2007,
<http://www.rfc-editor.org/info/rfc5061>. <http://www.rfc-editor.org/info/rfc5061>.
[RFC5461] Gont, F., "TCP's Reaction to Soft Errors", RFC 5461, [RFC5482] Eggert, L. and F. Gont, "TCP User Timeout Option",
DOI 10.17487/RFC5461, February 2009, RFC 5482, DOI 10.17487/RFC5482, March 2009,
<http://www.rfc-editor.org/info/rfc5461>. <http://www.rfc-editor.org/info/rfc5482>.
[RFC6093] Gont, F. and A. Yourtchenko, "On the Implementation of the
TCP Urgent Mechanism", RFC 6093, DOI 10.17487/RFC6093,
January 2011, <http://www.rfc-editor.org/info/rfc6093>.
[RFC6182] Ford, A., Raiciu, C., Handley, M., Barre, S., and J. [RFC6182] Ford, A., Raiciu, C., Handley, M., Barre, S., and J.
Iyengar, "Architectural Guidelines for Multipath TCP Iyengar, "Architectural Guidelines for Multipath TCP
Development", RFC 6182, DOI 10.17487/RFC6182, March 2011, Development", RFC 6182, DOI 10.17487/RFC6182, March 2011,
<http://www.rfc-editor.org/info/rfc6182>. <http://www.rfc-editor.org/info/rfc6182>.
[RFC6458] Stewart, R., Tuexen, M., Poon, K., Lei, P., and V. [RFC6458] Stewart, R., Tuexen, M., Poon, K., Lei, P., and V.
Yasevich, "Sockets API Extensions for the Stream Control Yasevich, "Sockets API Extensions for the Stream Control
Transmission Protocol (SCTP)", RFC 6458, DOI 10.17487/ Transmission Protocol (SCTP)", RFC 6458, DOI 10.17487/
RFC6458, December 2011, RFC6458, December 2011,
<http://www.rfc-editor.org/info/rfc6458>. <http://www.rfc-editor.org/info/rfc6458>.
[RFC6525] Stewart, R., Tuexen, M., and P. Lei, "Stream Control [RFC6525] Stewart, R., Tuexen, M., and P. Lei, "Stream Control
Transmission Protocol (SCTP) Stream Reconfiguration", Transmission Protocol (SCTP) Stream Reconfiguration",
RFC 6525, DOI 10.17487/RFC6525, February 2012, RFC 6525, DOI 10.17487/RFC6525, February 2012,
<http://www.rfc-editor.org/info/rfc6525>. <http://www.rfc-editor.org/info/rfc6525>.
[RFC6817] Shalunov, S., Hazel, G., Iyengar, J., and M. Kuehlewind,
"Low Extra Delay Background Transport (LEDBAT)", RFC 6817,
DOI 10.17487/RFC6817, December 2012,
<http://www.rfc-editor.org/info/rfc6817>.
[RFC6824] Ford, A., Raiciu, C., Handley, M., and O. Bonaventure, [RFC6824] Ford, A., Raiciu, C., Handley, M., and O. Bonaventure,
"TCP Extensions for Multipath Operation with Multiple "TCP Extensions for Multipath Operation with Multiple
Addresses", RFC 6824, DOI 10.17487/RFC6824, January 2013, Addresses", RFC 6824, DOI 10.17487/RFC6824, January 2013,
<http://www.rfc-editor.org/info/rfc6824>. <http://www.rfc-editor.org/info/rfc6824>.
[RFC6897] Scharf, M. and A. Ford, "Multipath TCP (MPTCP) Application [RFC6897] Scharf, M. and A. Ford, "Multipath TCP (MPTCP) Application
Interface Considerations", RFC 6897, DOI 10.17487/RFC6897, Interface Considerations", RFC 6897, DOI 10.17487/RFC6897,
March 2013, <http://www.rfc-editor.org/info/rfc6897>. March 2013, <http://www.rfc-editor.org/info/rfc6897>.
[RFC6951] Tuexen, M. and R. Stewart, "UDP Encapsulation of Stream [RFC6951] Tuexen, M. and R. Stewart, "UDP Encapsulation of Stream
Control Transmission Protocol (SCTP) Packets for End-Host Control Transmission Protocol (SCTP) Packets for End-Host
to End-Host Communication", RFC 6951, DOI 10.17487/ to End-Host Communication", RFC 6951, DOI 10.17487/
RFC6951, May 2013, RFC6951, May 2013,
<http://www.rfc-editor.org/info/rfc6951>. <http://www.rfc-editor.org/info/rfc6951>.
[RFC7053] Tuexen, M., Ruengeler, I., and R. Stewart, "SACK- [RFC7053] Tuexen, M., Ruengeler, I., and R. Stewart, "SACK-
IMMEDIATELY Extension for the Stream Control Transmission IMMEDIATELY Extension for the Stream Control Transmission
Protocol", RFC 7053, DOI 10.17487/RFC7053, November 2013, Protocol", RFC 7053, DOI 10.17487/RFC7053, November 2013,
<http://www.rfc-editor.org/info/rfc7053>. <http://www.rfc-editor.org/info/rfc7053>.
[RFC7414] Duke, M., Braden, R., Eddy, W., Blanton, E., and A. [RFC7413] Cheng, Y., Chu, J., Radhakrishnan, S., and A. Jain, "TCP
Zimmermann, "A Roadmap for Transmission Control Protocol Fast Open", RFC 7413, DOI 10.17487/RFC7413, December 2014,
(TCP) Specification Documents", RFC 7414, DOI 10.17487/ <http://www.rfc-editor.org/info/rfc7413>.
RFC7414, February 2015,
<http://www.rfc-editor.org/info/rfc7414>.
[RFC7496] Tuexen, M., Seggelmann, R., Stewart, R., and S. Loreto, [RFC7496] Tuexen, M., Seggelmann, R., Stewart, R., and S. Loreto,
"Additional Policies for the Partially Reliable Stream "Additional Policies for the Partially Reliable Stream
Control Transmission Protocol Extension", RFC 7496, Control Transmission Protocol Extension", RFC 7496,
DOI 10.17487/RFC7496, April 2015, DOI 10.17487/RFC7496, April 2015,
<http://www.rfc-editor.org/info/rfc7496>. <http://www.rfc-editor.org/info/rfc7496>.
[RFC7657] Black, D., Ed. and P. Jones, "Differentiated Services
(Diffserv) and Real-Time Communication", RFC 7657,
DOI 10.17487/RFC7657, November 2015,
<http://www.rfc-editor.org/info/rfc7657>.
[RFC7829] Nishida, Y., Natarajan, P., Caro, A., Amer, P., and K. [RFC7829] Nishida, Y., Natarajan, P., Caro, A., Amer, P., and K.
Nielsen, "SCTP-PF: A Quick Failover Algorithm for the Nielsen, "SCTP-PF: A Quick Failover Algorithm for the
Stream Control Transmission Protocol", RFC 7829, Stream Control Transmission Protocol", RFC 7829,
DOI 10.17487/RFC7829, April 2016, DOI 10.17487/RFC7829, April 2016,
<http://www.rfc-editor.org/info/rfc7829>. <http://www.rfc-editor.org/info/rfc7829>.
[RFC8085] Eggert, L., Fairhurst, G., and G. Shepherd, "UDP Usage
Guidelines", BCP 145, RFC 8085, DOI 10.17487/RFC8085,
March 2017, <http://www.rfc-editor.org/info/rfc8085>.
9.2. Informative References
[RFC0854] Postel, J. and J. Reynolds, "Telnet Protocol
Specification", STD 8, RFC 854, DOI 10.17487/RFC0854,
May 1983, <http://www.rfc-editor.org/info/rfc854>.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/
RFC2119, March 1997,
<http://www.rfc-editor.org/info/rfc2119>.
[RFC3168] Ramakrishnan, K., Floyd, S., and D. Black, "The Addition
of Explicit Congestion Notification (ECN) to IP",
RFC 3168, DOI 10.17487/RFC3168, September 2001,
<http://www.rfc-editor.org/info/rfc3168>.
[RFC3260] Grossman, D., "New Terminology and Clarifications for
Diffserv", RFC 3260, DOI 10.17487/RFC3260, April 2002,
<http://www.rfc-editor.org/info/rfc3260>.
[RFC5461] Gont, F., "TCP's Reaction to Soft Errors", RFC 5461,
DOI 10.17487/RFC5461, February 2009,
<http://www.rfc-editor.org/info/rfc5461>.
[RFC6093] Gont, F. and A. Yourtchenko, "On the Implementation of the
TCP Urgent Mechanism", RFC 6093, DOI 10.17487/RFC6093,
January 2011, <http://www.rfc-editor.org/info/rfc6093>.
[RFC7414] Duke, M., Braden, R., Eddy, W., Blanton, E., and A.
Zimmermann, "A Roadmap for Transmission Control Protocol
(TCP) Specification Documents", RFC 7414, DOI 10.17487/
RFC7414, February 2015,
<http://www.rfc-editor.org/info/rfc7414>.
[RFC7657] Black, D., Ed. and P. Jones, "Differentiated Services
(Diffserv) and Real-Time Communication", RFC 7657,
DOI 10.17487/RFC7657, November 2015,
<http://www.rfc-editor.org/info/rfc7657>.
[RFC8095] Fairhurst, G., Ed., Trammell, B., Ed., and M. Kuehlewind,
Ed., "Services Provided by IETF Transport Protocols and
Congestion Control Mechanisms", RFC 8095, DOI 10.17487/
RFC8095, March 2017,
<http://www.rfc-editor.org/info/rfc8095>.
Appendix A. Overview of RFCs used as input for pass 1 Appendix A. Overview of RFCs used as input for pass 1
TCP: [RFC0793], [RFC1122], [RFC5482] TCP: [RFC0793], [RFC1122], [RFC5482], [RFC7413]
MPTCP: [RFC6182], [RFC6824], [RFC6897] MPTCP: [RFC6182], [RFC6824], [RFC6897]
SCTP: RFCs without a socket API specification: [RFC3758], [RFC4895], SCTP: RFCs without a socket API specification: [RFC3758], [RFC4895],
[RFC4960], [RFC5061]. RFCs that include a socket API [RFC4960], [RFC5061]. RFCs that include a socket API
specification: [RFC6458], [RFC6525], [RFC6951], [RFC7053], specification: [RFC6458], [RFC6525], [RFC6951], [RFC7053],
[RFC7496] [RFC7829]. [RFC7496] [RFC7829].
UDP(-Lite): See [FJ16] UDP(-Lite): See [FJ16]
LEDBAT: [RFC6817].
Appendix B. How to contribute Appendix B. How this document was developed
This document is only concerned with transport service features that This section gives an overview of the method that was used to develop
are explicitly exposed to applications via primitives. It also this document. It was given to contributors for guidance, and it can
strictly follows RFC text: if a feature is truly relevant for an be helpful for future updates or extensions.
application, the RFCs better say so and in some way describe how to
use and configure it. Thus, the approach to follow for contributing
to this document is to identify the right RFCs, then analyze and
process their text.
Experimental RFCs are excluded, and so are primitives that MAY be This document is only concerned with Transport Features that are
implemented (by the transport protocol). To be included, the minimum explicitly exposed to applications via primitives. It also strictly
requirement level for a primitive to be implemented by a protocol is follows RFC text: if a feature is truly relevant for an application,
SHOULD. If [RFC2119]-style requirements levels are not used, the RFCs should say so, and they should describe how to use and
primitives should be excluded when they are described in conjunction configure it. Thus, the approach followed for developing this
with statements like, e.g.: "some implementations also provide" or document was to identify the right RFCs, then analyze and process
"an implementation may also". Briefly describe excluded primitives their text.
in a subsection called "excluded primitives".
Pass 1: Identify text that talks about primitives. An API Primitives that MAY be implemented by a transport protocol were
specification, abstract or not, obviously describes primitives -- but excluded. To be included, the minimum requirement level for a
note that we are not *only* interested in API specifications. The primitive to be implemented by a protocol was SHOULD. Where
text describing the 'send' primitive in the API specified in [RFC2119]-style requirements levels are not used, primitives were
[RFC0793], for instance, does not say that data transfer is reliable. excluded when they are described in conjunction with statements like,
TCP's reliability is clear, however, from this text in Section 1 of e.g.: "some implementations also provide" or "an implementation may
also". Excluded primitives or parameters were briefly described in a
dedicated subsection.
Pass 1: This began by identifying text that talks about primitives.
An API specification, abstract or not, obviously describes primitives
-- but we are not *only* interested in API specifications. The text
describing the 'send' primitive in the API specified in [RFC0793],
for instance, does not say that data transfer is reliable. TCP's
reliability is clear, however, from this text in Section 1 of
[RFC0793]: "The Transmission Control Protocol (TCP) is intended for [RFC0793]: "The Transmission Control Protocol (TCP) is intended for
use as a highly reliable host-to-host protocol between hosts in use as a highly reliable host-to-host protocol between hosts in
packet-switched computer communication networks, and in packet-switched computer communication networks, and in
interconnected systems of such networks." interconnected systems of such networks."
For the new pass 1 subsection about the protocol you're describing, Some text for pass 1 subsections was developed copy+pasting all the
it is recommendable to begin by copy+pasting all the relevant text relevant text parts from the relevant RFCs, then adjusting
parts from the relevant RFCs, then adjust terminology to match the terminology to match the terminology in Section 1 and adjusting
terminology in Section 1 and adjust (shorten!) phrasing to match the (shortening!) phrasing to match the general style of the document.
general style of the document. Try to formulate everything as a An effort was made to formulate everything as a primitive description
primitive description to make the primitive description as complete such that the primitive descriptions became as complete as possible
as possible (e.g., the "SEND.TCP" primitive in pass 2 is explicitly (e.g., the "SEND.TCP" primitive in pass 2 is explicitly described as
described as reliably transferring data); if there is text that is reliably transferring data); text that is relevant for the primitives
relevant for the primitives presented in this pass but still does not presented in this pass but still does not fit directly under any
fit directly under any primitive, use it as an introduction for your primitive was used in a subsection's introduction.
subsection. However, do note that document length is a concern and
all the protocols and their services / features are already described
in [FA16].
Pass 2: The main goal of this pass is unification of primitives. As Pass 2: The main goal of this pass is unification of primitives. As
input, use your own text from Pass 1, no exterior sources. If you input, only text from pass 1 was used (no exterior sources). The
find that something is missing there, fix the text in Pass 1. The list in pass 2 is not arranged by protocol ("first protocol X, here
list in pass 2 is not done by protocol ("first protocol X, here are are all the primitives; then protocol Y, here are all the primitives,
all the primitives; then protocol Y, here are all the primitives,
..") but by primitive ("primitive A, implemented this way in protocol ..") but by primitive ("primitive A, implemented this way in protocol
X, this way in protocol Y, ..."). We want as many similar pass 2 X, this way in protocol Y, ..."). It was a goal to obtain as many
primitives as possible. This can be achieved, for instance, by not similar pass 2 primitives as possible. For instance, this was
always maintaining a 1:1 mapping between pass 1 and pass 2 sometimes achieved by not always maintaining a 1:1 mapping between
primitives, renaming primitives etc. Please consider the primitives pass 1 and pass 2 primitives, renaming primitives etc. For every new
that are already there and try to make the ones of the protocol you primitive, the already existing primitives were considered to try to
are describing as much in line with the already existing ones as make them as coherent as possible.
possible. In other words, we would rather have a primitive with new
parameters than a new primitive that allows to send in a particular
way.
Please make primitives fit within the already existing categories and For each primitive, the following style was used:
subcategories. For each primitive, please follow the style:
o PRIMITIVENAME.PROTOCOL: o PRIMITIVENAME.PROTOCOL:
Pass 1 primitive / event: Pass 1 primitive / event:
Parameters: Parameters:
Returns: Returns:
Comments: Comments:
The entries "Parameters", "Returns" and "Comments" may be skipped if The entries "Parameters", "Returns" and "Comments" were skipped when
a primitive has no parameters, no described return value or no a primitive had no parameters, no described return value or no
comments seem necessary, respectively. Optional parameters must be comments seemed necessary, respectively. Optional parameters are
followed by "(optional)". If a default value is known, provide it followed by "(optional)". When a default value is known, this was
too. also provided.
Pass 3: the main point of this pass is to identify features that are Pass 3: the main point of this pass is to identify transport protocol
the result of static properties of protocols, for which all protocols features that are the result of static properties of protocols, for
have to be listed together; this is then the final list of all which all protocols have to be listed together; this is then the
available features. For this, we need a list of features per final list of all available Transport Features. This list was
category (similar categories as in pass 2) along with the protocol primarily based on text from pass 2, with additional input from pass
supporting it. This should be primarily based on text from pass 2 as 1 (but no external sources).
input, but text from pass 1 can also be used. Do not use external
sources.
Appendix C. Revision information Appendix C. Revision information
XXX RFC-Ed please remove this section prior to publication. XXX RFC-Ed please remove this section prior to publication.
-00 (from draft-welzl-taps-transports): this now covers TCP based on -00 (from draft-welzl-taps-transports): this now covers TCP based on
all TCP RFCs (this means: if you know of something in any TCP RFC all TCP RFCs (this means: if you know of something in any TCP RFC
that you think should be addressed, please speak up!) as well as that you think should be addressed, please speak up!) as well as
SCTP, exclusively based on [RFC4960]. We decided to also incorporate SCTP, exclusively based on [RFC4960]. We decided to also incorporate
[RFC6458] for SCTP, but this hasn't happened yet. Terminology made [RFC6458] for SCTP, but this hasn't happened yet. Terminology made
in line with [FA16]. Addressed comments by Karen Nielsen and Gorry in line with [RFC8095]. Addressed comments by Karen Nielsen and
Fairhurst; various other fixes. Appendices (TCP overview and how-to- Gorry Fairhurst; various other fixes. Appendices (TCP overview and
contribute) added. how-to-contribute) added.
-01: this now also covers MPTCP based on [RFC6182], [RFC6824] and -01: this now also covers MPTCP based on [RFC6182], [RFC6824] and
[RFC6897]. [RFC6897].
-02: included UDP, UDP-Lite, and all extensions of SCTPs. This -02: included UDP, UDP-Lite, and all extensions of SCTPs. This
includes fixing the [RFC6458] omission from -00. includes fixing the [RFC6458] omission from -00.
TODO: security considerations (see review in ML); the "how to -03: wrote security considerations. The "how to contribute" section
contribute" section (which, at some point, should be updated to was updated to reflect how the document WAS created, not how it
reflect how the document WAS created, not how it SHOULD BE created) SHOULD BE created; it also no longer wrongly says that Experimental
still says "Experimental RFCs are excluded". This is wrong, and RFCs are excluded. Included LEDBAT. Changed abstract and intro to
accordingly, Experimental RFCs must also be considered - thus, TFO reflect which protocols/mechanisms are covered (TCP, MPTCP, SCTP,
(are there more Experimental ones for TCP?). Also, include LEDBAT. UDP, UDP-Lite, LEDBAT) instead of talking about "transport
SCTP: DSCP and SCTP_NODELAY (equivalent to Nagle) are missing in pass protocols". Interleaving and stream scheduling added
1 and 2. Are we missing more (DF, TTL, ..)? What about e.g. (draft-ietf-tsvwg-sctp-ndata). TFO added. "Set protocol parameters"
"notification of ICMP error message arrival"? Also consider in SCTP replaced with per-parameter (or parameter group) primitives.
draft-ietf-tsvwg-sctp-ndata. More primitives added, mostly previously overlooked ones from
[RFC6458]. Updated terminology (s/transport service feature/
transport feature) in line with an update of [RFC8095]. Made
sequence of transport features / primitives more logical. Combined
MPTCP's add/rem subflow with SCTP's add/remove local address.
Authors' Addresses Authors' Addresses
Michael Welzl Michael Welzl
University of Oslo University of Oslo
PO Box 1080 Blindern PO Box 1080 Blindern
Oslo, N-0316 Oslo, N-0316
Norway Norway
Phone: +47 22 85 24 20 Phone: +47 22 85 24 20
 End of changes. 137 change blocks. 
483 lines changed or deleted 926 lines changed or added

This html diff was produced by rfcdiff 1.45. The latest version is available from http://tools.ietf.org/tools/rfcdiff/