package sctp

Import Path
	github.com/pion/sctp (on go.dev)

Dependency Relation
	imports 20 packages, and imported by 3 packages

Involved Source Files

	    ack_timer.go
	    association.go
	    association_stats.go
	    chunk.go
	    chunk_abort.go
	    chunk_cookie_ack.go
	    chunk_cookie_echo.go
	    chunk_error.go
	    chunk_forward_tsn.go
	    chunk_heartbeat.go
	    chunk_heartbeat_ack.go
	    chunk_init.go
	    chunk_init_ack.go
	    chunk_init_common.go
	    chunk_payload_data.go
	    chunk_reconfig.go
	    chunk_selective_ack.go
	    chunk_shutdown.go
	    chunk_shutdown_ack.go
	    chunk_shutdown_complete.go
	    chunkheader.go
	    chunktype.go
	    control_queue.go
	    error_cause.go
	    error_cause_header.go
	    error_cause_invalid_mandatory_parameter.go
	    error_cause_protocol_violation.go
	    error_cause_unrecognized_chunk_type.go
	    error_cause_user_initiated_abort.go
	    packet.go
	    param.go
	    param_chunk_list.go
	    param_ecn_capable.go
	    param_forward_tsn_supported.go
	    param_heartbeat_info.go
	    param_outgoing_reset_request.go
	    param_random.go
	    param_reconfig_response.go
	    param_requested_hmac_algorithm.go
	    param_state_cookie.go
	    param_supported_extensions.go
	    param_zero_checksum.go
	    paramheader.go
	    paramtype.go
	    payload_queue.go
	    pending_queue.go
	    queue.go
	    reassembly_queue.go
	    receive_payload_queue.go
	    rtx_timer.go
	  d sctp.go
		Package sctp implements the SCTP spec

	    stream.go
	    util.go
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type Association (struct)
		Association represents an SCTP association
		13.2.  Parameters Necessary per Association (i.e., the TCB)
		
			Peer        : Tag value to be sent in every packet and is received
			Verification: in the INIT or INIT ACK chunk.
			Tag         :
			State       : A state variable indicating what state the association
			            : is in, i.e., COOKIE-WAIT, COOKIE-ECHOED, ESTABLISHED,
			            : SHUTDOWN-PENDING, SHUTDOWN-SENT, SHUTDOWN-RECEIVED,
			            : SHUTDOWN-ACK-SENT.
		
		Note: No "CLOSED" state is illustrated since if a
		association is "CLOSED" its TCB SHOULD be removed.
		Note: By nature of an Association being constructed with one net.Conn,
		it is not a multi-home supporting implementation of SCTP.

		Methods (total 14)
			(*Association) Abort(reason string)
				Abort sends the abort packet with user initiated abort and immediately
				closes the connection.

			(*Association) AcceptStream() (*Stream, error)
				AcceptStream accepts a stream.

			(*Association) BufferedAmount() int
				BufferedAmount returns total amount (in bytes) of currently buffered user data.

			(*Association) BytesReceived() uint64
				BytesReceived returns the number of bytes received.

			(*Association) BytesSent() uint64
				BytesSent returns the number of bytes sent.

			(*Association) CWND() uint32
				CWND returns the association's current congestion window (cwnd).

			(*Association) Close() error
				Close ends the SCTP Association and cleans up any state.

			(*Association) MTU() uint32
				MTU returns the association's current MTU.

			(*Association) MaxMessageSize() uint32
				MaxMessageSize returns the maximum message size you can send.

			(*Association) OpenStream(streamIdentifier uint16, defaultPayloadType PayloadProtocolIdentifier) (*Stream, error)
				OpenStream opens a stream.

			(*Association) RWND() uint32
				RWND returns the association's current receiver window (rwnd).

			(*Association) SRTT() float64
				SRTT returns the latest smoothed round-trip time (srrt).

			(*Association) SetMaxMessageSize(maxMsgSize uint32)
				SetMaxMessageSize sets the maximum message size you can send.

			(*Association) Shutdown(ctx context.Context) error
				Shutdown initiates the shutdown sequence. The method blocks until the
				shutdown sequence is completed and the connection is closed, or until the
				passed context is done, in which case the context's error is returned.

		Implements (at least 2)
			*Association : github.com/prometheus/common/expfmt.Closer
			*Association : io.Closer
		As Outputs Of (at least 2)
			func Client(config Config) (*Association, error)
			func Server(config Config) (*Association, error)
		As Inputs Of (at least 2)
			func github.com/pion/datachannel.Accept(a *Association, config *datachannel.Config, existingChannels ...*datachannel.DataChannel) (*datachannel.DataChannel, error)
			func github.com/pion/datachannel.Dial(a *Association, id uint16, config *datachannel.Config) (*datachannel.DataChannel, error)

	 type Config (struct)
		Config collects the arguments to createAssociation construction into
		a single structure.

		Fields (total 12)
			BlockWrite bool
			CwndCAStep uint32
				Step of congestion window increase at Congestion Avoidance

			EnableZeroChecksum bool
			FastRtxWnd uint32
				Send window for fast retransmit

			LoggerFactory logging.LoggerFactory
			MTU uint32
			MaxMessageSize uint32
			MaxReceiveBufferSize uint32
			MinCwnd uint32
				Minimum congestion window

			Name string
			NetConn net.Conn
			RTOMax float64
				congestion control configuration
				RTOMax is the maximum retransmission timeout in milliseconds

		As Inputs Of (at least 2)
			func Client(config Config) (*Association, error)
			func Server(config Config) (*Association, error)

	 type PayloadProtocolIdentifier uint32 (basic type)
		PayloadProtocolIdentifier is an enum for DataChannel payload types.

		Methods (only one)
			( PayloadProtocolIdentifier) String() string
		Implements (at least 2)
			 PayloadProtocolIdentifier : expvar.Var
			 PayloadProtocolIdentifier : fmt.Stringer
		As Outputs Of (at least one exported)
			func (*Stream).ReadSCTP(payload []byte) (int, PayloadProtocolIdentifier, error)
		As Inputs Of (at least 3)
			func (*Association).OpenStream(streamIdentifier uint16, defaultPayloadType PayloadProtocolIdentifier) (*Stream, error)
			func (*Stream).SetDefaultPayloadType(defaultPayloadType PayloadProtocolIdentifier)
			func (*Stream).WriteSCTP(payload []byte, ppi PayloadProtocolIdentifier) (int, error)
		As Types Of (total 6)
			const PayloadTypeUnknown
			const PayloadTypeWebRTCBinary
			const PayloadTypeWebRTCBinaryEmpty
			const PayloadTypeWebRTCDCEP
			const PayloadTypeWebRTCString
			const PayloadTypeWebRTCStringEmpty

	 type Stream (struct)
		Stream represents an SCTP stream.

		Methods (total 16)
			(*Stream) BufferedAmount() uint64
				BufferedAmount returns the number of bytes of data currently queued to be sent over this stream.

			(*Stream) BufferedAmountLowThreshold() uint64
				BufferedAmountLowThreshold returns the number of bytes of buffered outgoing data that is
				considered "low." Defaults to 0.

			(*Stream) Close() error
				Close closes the write-direction of the stream.
				Future calls to Write are not permitted after calling Close.

			(*Stream) OnBufferedAmountLow(f func())
				OnBufferedAmountLow sets the callback handler which would be called when the number of
				bytes of outgoing data buffered is lower than the threshold.

			(*Stream) Read(p []byte) (int, error)
				Read reads a packet of len(p) bytes, dropping the Payload Protocol Identifier.
				Returns EOF when the stream is reset or an error if the stream is closed
				otherwise.

			(*Stream) ReadSCTP(payload []byte) (int, PayloadProtocolIdentifier, error)
				ReadSCTP reads a packet of len(payload) bytes and returns the associated Payload
				Protocol Identifier.
				Returns EOF when the stream is reset or an error if the stream is closed
				otherwise.

			(*Stream) SetBufferedAmountLowThreshold(th uint64)
				SetBufferedAmountLowThreshold is used to update the threshold.
				See BufferedAmountLowThreshold().

			(*Stream) SetDeadline(t time.Time) error
				SetDeadline sets the read and write deadlines in an identical way to net.Conn.

			(*Stream) SetDefaultPayloadType(defaultPayloadType PayloadProtocolIdentifier)
				SetDefaultPayloadType sets the default payload type used by Write.

			(*Stream) SetReadDeadline(deadline time.Time) error
				SetReadDeadline sets the read deadline in an identical way to net.Conn.

			(*Stream) SetReliabilityParams(unordered bool, relType byte, relVal uint32)
				SetReliabilityParams sets reliability parameters for this stream.

			(*Stream) SetWriteDeadline(deadline time.Time) error
				SetWriteDeadline sets the write deadline in an identical way to net.Conn,
				it will only work for blocking writes.

			(*Stream) State() StreamState
				State return the stream state.

			(*Stream) StreamIdentifier() uint16
				StreamIdentifier returns the Stream identifier associated to the stream.

			(*Stream) Write(payload []byte) (n int, err error)
				Write writes len(payload) bytes from payload with the default Payload Protocol Identifier.

			(*Stream) WriteSCTP(payload []byte, ppi PayloadProtocolIdentifier) (int, error)
				WriteSCTP writes len(payload) bytes from payload to the DTLS connection.

		Implements (at least 14)
			*Stream : github.com/pion/datachannel.ReadDeadliner
			*Stream : github.com/pion/datachannel.WriteDeadliner
			*Stream : github.com/pion/stun.Connection
			*Stream : github.com/pion/stun/v3.Connection
			*Stream : github.com/miekg/dns.Writer
			*Stream : github.com/prometheus/common/expfmt.Closer
			*Stream : internal/bisect.Writer
			*Stream : io.Closer
			*Stream : io.ReadCloser
			*Stream : io.Reader
			*Stream : io.ReadWriteCloser
			*Stream : io.ReadWriter
			*Stream : io.WriteCloser
			*Stream : io.Writer
		As Outputs Of (at least 2)
			func (*Association).AcceptStream() (*Stream, error)
			func (*Association).OpenStream(streamIdentifier uint16, defaultPayloadType PayloadProtocolIdentifier) (*Stream, error)
		As Inputs Of (at least 2)
			func github.com/pion/datachannel.Client(stream *Stream, config *datachannel.Config) (*datachannel.DataChannel, error)
			func github.com/pion/datachannel.Server(stream *Stream, config *datachannel.Config) (*datachannel.DataChannel, error)

	 type StreamState int (basic type)
		StreamState is an enum for SCTP Stream state field
		This field identifies the state of stream.

		Methods (only one)
			( StreamState) String() string
		Implements (at least 2)
			 StreamState : expvar.Var
			 StreamState : fmt.Stringer
		As Outputs Of (at least one exported)
			func (*Stream).State() StreamState
		As Types Of (total 3)
			const StreamStateClosed
			const StreamStateClosing
			const StreamStateOpen


Package-Level Functions (total 3)

	 func Client(config Config) (*Association, error)
		Client opens a SCTP stream over a conn.

	 func Server(config Config) (*Association, error)
		Server accepts a SCTP stream over a conn.

	 func TryMarshalUnmarshal(msg []byte) int
		TryMarshalUnmarshal attempts to marshal and unmarshal a message. Added for fuzzing.


Package-Level Variables (total 98)

	  var ErrAssociationClosed error
		Association errors.

	  var ErrAssociationClosedBeforeConn error
		Association errors.

	  var ErrBuildAbortChunkFailed error
		Abort chunk errors.

	  var ErrBuildErrorCaseHandle error
		Error and abort chunk errors.

	  var ErrBuildErrorChunkFailed error
		Error chunk errors.

	  var ErrChecksumMismatch error
		SCTP packet errors.

	  var ErrChunk error
		Association errors.

	  var ErrChunkHeaderNotEnoughSpace error
		SCTP chunk header errors.

	  var ErrChunkHeaderPaddingNonZero error
		SCTP chunk header errors.

	  var ErrChunkHeaderTooSmall error
		SCTP chunk header errors.

	  var ErrChunkMarshalParamAReconfigFailed error
		Reconfigure chunk errors.

	  var ErrChunkMarshalParamBReconfigFailed error
		Reconfigure chunk errors.

	  var ErrChunkNotLongEnoughForParams error
		Init ack chunk errors.

	  var ErrChunkParseParamTypeFailed error
		Reconfigure chunk errors.

	  var ErrChunkPayloadSmall error
		Data chunk errors.

	  var ErrChunkTooShort error
		Forward TSN chunk errors.

	  var ErrChunkTypeInitAckFlagZero error
		Init ack chunk errors.

	  var ErrChunkTypeInitAckInitateTagZero error
		Init ack chunk errors.

	  var ErrChunkTypeInitFlagZero error
		Init chunk errors.

	  var ErrChunkTypeInitInitateTagZero error
		Init chunk errors.

	  var ErrChunkTypeInitMarshalFailed error
		Init chunk errors.

	  var ErrChunkTypeInitUnmarshalFailed error
		Init chunk errors.

	  var ErrChunkTypeNotAbort error
		Abort chunk errors.

	  var ErrChunkTypeNotCookieAck error
		Cookie ack chunk errors.

	  var ErrChunkTypeNotCookieEcho error
		Cookie echo chunk errors.

	  var ErrChunkTypeNotCtError error
		Error chunk errors.

	  var ErrChunkTypeNotHeartbeat error
		Heartbeat chunk errors.

	  var ErrChunkTypeNotInitAck error
		Init ack chunk errors.

	  var ErrChunkTypeNotSack error
		Selective ack chunk errors.

	  var ErrChunkTypeNotShutdown error
		Shutdown chunk errors.

	  var ErrChunkTypeNotShutdownAck error
		Shutdown ack chunk errors.

	  var ErrChunkTypeNotShutdownComplete error
		Shutdown complete chunk errors.

	  var ErrChunkTypeNotTypeInit error
		Init chunk errors.

	  var ErrChunkTypeUnhandled error
		Association errors.

	  var ErrChunkValueNotLongEnough error
		Init chunk errors.

	  var ErrCookieEchoNotStoredToSend error
		Association errors.

	  var ErrHandleInitState error
		Association errors.

	  var ErrHandshakeCookieEcho error
		Association errors.

	  var ErrHandshakeInitAck error
		Association errors.

	  var ErrHeartbeatAckMarshalParam error
		Heartbeat ack chunk errors.

	  var ErrHeartbeatAckNotHeartbeatInfo error
		Heartbeat ack chunk errors.

	  var ErrHeartbeatAckParams error
		Heartbeat ack chunk errors.

	  var ErrHeartbeatChunkUnmarshal error
		Heartbeat chunk errors.

	  var ErrHeartbeatNotLongEnoughInfo error
		Heartbeat chunk errors.

	  var ErrHeartbeatParam error
		Heartbeat chunk errors.

	  var ErrInflightQueueTSNPop error
		Association errors.

	  var ErrInitAckAdvertisedReceiver1500 error
		Init ack chunk errors.

	  var ErrInitAckInboundStreamRequestZero error
		Init ack chunk errors.

	  var ErrInitAckMarshalParam error
		Init chunk errors.

	  var ErrInitAckNoCookie error
		Association errors.

	  var ErrInitAckOutboundStreamRequestZero error
		Init ack chunk errors.

	  var ErrInitAckUnmarshalFailed error
		Init ack chunk errors.

	  var ErrInitAdvertisedReceiver1500 error
		Init chunk errors.

	  var ErrInitChunkBundled error
		Association errors.

	  var ErrInitChunkParseParamTypeFailed error
		Init chunk errors.

	  var ErrInitChunkVerifyTagNotZero error
		Association errors.

	  var ErrInitCommonDataMarshalFailed error
		Init ack chunk errors.

	  var ErrInitInboundStreamRequestZero error
		Init chunk errors.

	  var ErrInitNotStoredToSend error
		Association errors.

	  var ErrInitOutboundStreamRequestZero error
		Init chunk errors.

	  var ErrInitUnknownParam error
		Init chunk errors.

	  var ErrInvalidAlgorithmType error
		ErrInvalidAlgorithmType is returned if unknown auth algorithm is specified.

	  var ErrInvalidChunkLength error
		ErrInvalidChunkLength is returned if the chunk length is invalid.

	  var ErrInvalidChunkSize error
		Shutdown chunk errors.

	  var ErrInvalidSCTPChunk error
		ErrInvalidSCTPChunk is returned when an SCTP chunk is invalid.

	  var ErrMarshalStreamFailed error
		Forward TSN chunk errors.

	  var ErrOutboundPacketTooLarge error
		SCTP stream errors.

	  var ErrPacketRawTooSmall error
		SCTP packet errors.

	  var ErrParamHeaderParseFailed error
		Parameter header parse errors.

	  var ErrParamHeaderSelfReportedLengthLonger error
		Parameter header parse errors.

	  var ErrParamHeaderSelfReportedLengthShorter error
		Parameter header parse errors.

	  var ErrParamHeaderTooShort error
		Parameter header parse errors.

	  var ErrParamPacketTooShort error
		Parameter packet errors.

	  var ErrParamterType error
		Association errors.

	  var ErrParamTypeUnhandled error
		ErrParamTypeUnhandled is returned if unknown parameter type is specified.

	  var ErrParseParamTypeFailed error
		Heartbeat chunk errors.

	  var ErrParseSCTPChunkNotEnoughData error
		SCTP packet errors.

	  var ErrPayloadDataStateNotExist error
		Association errors.

	  var ErrProtocolViolationUnmarshal error
		Abort chunk errors.

	  var ErrReadDeadlineExceeded error
		SCTP stream errors.

	  var ErrReconfigRespParamTooShort error
		Reconfiguration response errors.

	  var ErrResetPacketInStateNotExist error
		Association errors.

	  var ErrSackSizeNotLargeEnoughInfo error
		Selective ack chunk errors.

	  var ErrSackSizeNotMatchPredicted error
		Selective ack chunk errors.

	  var ErrSCTPPacketDestinationPortZero error
		Association errors.

	  var ErrSCTPPacketSourcePortZero error
		Association errors.

	  var ErrShutdownNonEstablished error
		Association errors.

	  var ErrSilentlyDiscard error
		Association errors.

	  var ErrSSNResetRequestParamTooShort error
		Outgoing reset request parameter errors.

	  var ErrStreamClosed error
		SCTP stream errors.

	  var ErrTooManyReconfigRequests error
		Association errors.

	  var ErrTSNRequestNotExist error
		Association errors.

	  var ErrUnexpectedChuckPoppedOrdered error
		Pending queue errors.

	  var ErrUnexpectedChuckPoppedUnordered error
		Pending queue errors.

	  var ErrUnexpectedQState error
		Pending queue errors.

	  var ErrUnimplemented error
		Heartbeat ack chunk errors.

	  var ErrUnmarshalUnknownChunkType error
		SCTP packet errors.

	  var ErrZeroChecksumParamTooShort error
		Zero Checksum parameter error.


Package-Level Constants (total 12)

	const PayloadTypeUnknown PayloadProtocolIdentifier = 0
		PayloadProtocolIdentifier enums
		https://www.iana.org/assignments/sctp-parameters/sctp-parameters.xhtml#sctp-parameters-25

	const PayloadTypeWebRTCBinary PayloadProtocolIdentifier = 53
		PayloadProtocolIdentifier enums
		https://www.iana.org/assignments/sctp-parameters/sctp-parameters.xhtml#sctp-parameters-25

	const PayloadTypeWebRTCBinaryEmpty PayloadProtocolIdentifier = 57
		PayloadProtocolIdentifier enums
		https://www.iana.org/assignments/sctp-parameters/sctp-parameters.xhtml#sctp-parameters-25

	const PayloadTypeWebRTCDCEP PayloadProtocolIdentifier = 50
		PayloadProtocolIdentifier enums
		https://www.iana.org/assignments/sctp-parameters/sctp-parameters.xhtml#sctp-parameters-25

	const PayloadTypeWebRTCString PayloadProtocolIdentifier = 51
		PayloadProtocolIdentifier enums
		https://www.iana.org/assignments/sctp-parameters/sctp-parameters.xhtml#sctp-parameters-25

	const PayloadTypeWebRTCStringEmpty PayloadProtocolIdentifier = 56
		PayloadProtocolIdentifier enums
		https://www.iana.org/assignments/sctp-parameters/sctp-parameters.xhtml#sctp-parameters-25

	const ReliabilityTypeReliable byte = 0
		ReliabilityTypeReliable is used for reliable transmission.

	const ReliabilityTypeRexmit byte = 1
		ReliabilityTypeRexmit is used for partial reliability by retransmission count.

	const ReliabilityTypeTimed byte = 2
		ReliabilityTypeTimed is used for partial reliability by retransmission duration.

	const StreamStateClosed StreamState = 2 // Stream has been closed
		StreamState enums.

	const StreamStateClosing StreamState = 1 // Outgoing stream is being reset
		StreamState enums.

	const StreamStateOpen StreamState = 0 // Stream object starts with StreamStateOpen
		StreamState enums.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.