src/jdk.sctp/share/classes/com/sun/nio/sctp/package-info.java
author rkennke
Wed, 25 Sep 2019 12:33:05 +0200
changeset 58334 f642ad5c655f
parent 47216 71c04702a3d5
permissions -rw-r--r--
8231447: Shenandoah: Compilation-time regression after JDK-8231086 Reviewed-by: shade
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2542
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
     1
/*
23010
6dadb192ad81 8029235: Update copyright year to match last edit in jdk8 jdk repository for 2013
lana
parents: 20742
diff changeset
     2
 * Copyright (c) 2009, 2013, Oracle and/or its affiliates. All rights reserved.
2542
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
     4
 *
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2542
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2542
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2542
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2542
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    10
 *
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    15
 * accompanied this code).
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    16
 *
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2542
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2542
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2542
diff changeset
    23
 * questions.
2542
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    24
 */
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    25
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    26
/**
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    27
 * A Java API for Stream Control Transport Protocol.
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    28
 *
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    29
 * <P> The Stream Control Transport Protocol (SCTP) is a reliable,
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    30
 * message-oriented, transport protocol existing at an equivalent level with UDP
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    31
 * (User Datagram Protocol) and TCP (Transmission Control Protocol). SCTP is
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    32
 * session oriented and an association between the endpoints must be established
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    33
 * before any data can be transmitted.
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    34
 *
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    35
 * <P> SCTP has direct support for multi-homing, meaning than an endpoint may be
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    36
 * represented by more than one address and each address may be used for sending
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    37
 * and receiving data, thus providing network redundancy. The connection between
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    38
 * two endpoints is referred to as an association between those endpoints.
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    39
 * Endpoints can exchange a list of addresses during association setup. One
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    40
 * address is designated as the primary address, this is the default address that
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    41
 * the peer will use for sending data. A single port number is used across the
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    42
 * entire address list at an endpoint for a specific session.
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    43
 *
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    44
 * <P> SCTP is message based. I/O operations operate upon messages and message
47020
2c55106dc37b 8186851: fix misspellings of "dependent" and "independent" in the JDK repo
smarks
parents: 34894
diff changeset
    45
 * boundaries are preserved. Each association may support multiple independent
2542
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    46
 * logical streams. Each stream represents a sequence of messages within a single
47020
2c55106dc37b 8186851: fix misspellings of "dependent" and "independent" in the JDK repo
smarks
parents: 34894
diff changeset
    47
 * association and streams are independent of one another, meaning that stream
2542
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    48
 * identifiers and sequence numbers are included in the data packet to allow
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    49
 * sequencing of messages on a per-stream basis.
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    50
 *
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    51
 * <P> This package provides two programming model styles. The one-to-one style
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    52
 * supported by {@link com.sun.nio.sctp.SctpChannel} and {@link
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    53
 * com.sun.nio.sctp.SctpServerChannel}, and the one-to-many
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    54
 * style supported by {@link com.sun.nio.sctp.SctpMultiChannel}.
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    55
 * The semantics of the one-to-one style interface are very similar to TCP.
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    56
 * An {@code SctpChannel} can only control one SCTP association. The
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    57
 * semantics of the one-to-many style interface are very similar to UDP. An
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    58
 * {@code SctpMutliChannel} can control multiple SCTP associations.
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    59
 *
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    60
 * <P> Applications can send and receive per-message ancillary information through
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    61
 * {@link com.sun.nio.sctp.MessageInfo}. For example, the stream number that
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    62
 * the message it is to be sent or received from. The SCTP stack is event driven
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    63
 * and applications can receive notifications of certain SCTP events by invoking
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    64
 * the {@code receive} method of the SCTP channel with an appropriate {@link
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    65
 * com.sun.nio.sctp.NotificationHandler notification handler}.
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    66
 *
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    67
 * <P> The SCTP protocol is defined by
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    68
 * <A HREF="http://tools.ietf.org/html/rfc4960">RFC4960</A>, and the optional
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    69
 * extension for <I>Dynamic Address Reconfiguration</I> is defined by
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    70
 * <A HREF="http://tools.ietf.org/html/rfc5061">RFC5061</A>.
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    71
 *
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    72
 * @since 1.7
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    73
 */
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    74
d859108aea12 4927640: Implementation of the sctp protocol
chegar
parents:
diff changeset
    75
package com.sun.nio.sctp;