Categorygithub.com/pion/sctp
modulepackage
1.8.36
Repository: https://github.com/pion/sctp.git
Documentation: pkg.go.dev

# README


Pion SCTP

A Go implementation of SCTP

Pion SCTP Slack Widget
GitHub Workflow Status Go Reference Coverage Status Go Report Card License: MIT


Roadmap

The library is used as a part of our WebRTC implementation. Please refer to that roadmap to track our major milestones.

Community

Pion has an active community on the Slack.

Follow the Pion Twitter for project updates and important WebRTC news.

We are always looking to support your projects. Please reach out if you have something to build! If you need commercial support or don't want to use public methods you can contact us at [email protected]

Contributing

Check out the contributing wiki to join the group of amazing people making this project possible

License

MIT License - see LICENSE for full text

# Packages

No description provided by the author

# Functions

Client opens a SCTP stream over a conn.
Server accepts a SCTP stream over a conn.
TryMarshalUnmarshal attempts to marshal and unmarshal a message.

# Constants

PayloadProtocolIdentifier enums https://www.iana.org/assignments/sctp-parameters/sctp-parameters.xhtml#sctp-parameters-25.
PayloadProtocolIdentifier enums https://www.iana.org/assignments/sctp-parameters/sctp-parameters.xhtml#sctp-parameters-25.
PayloadProtocolIdentifier enums https://www.iana.org/assignments/sctp-parameters/sctp-parameters.xhtml#sctp-parameters-25.
PayloadProtocolIdentifier enums https://www.iana.org/assignments/sctp-parameters/sctp-parameters.xhtml#sctp-parameters-25.
PayloadProtocolIdentifier enums https://www.iana.org/assignments/sctp-parameters/sctp-parameters.xhtml#sctp-parameters-25.
PayloadProtocolIdentifier enums https://www.iana.org/assignments/sctp-parameters/sctp-parameters.xhtml#sctp-parameters-25.
ReliabilityTypeReliable is used for reliable transmission.
ReliabilityTypeRexmit is used for partial reliability by retransmission count.
ReliabilityTypeTimed is used for partial reliability by retransmission duration.
Stream has been closed.
Outgoing stream is being reset.
Stream object starts with StreamStateOpen.

# Variables

Association errors.
Association errors.
Abort chunk errors.
Error and abort chunk errors.
Error chunk errors.
SCTP packet errors.
Association errors.
SCTP chunk header errors.
SCTP chunk header errors.
SCTP chunk header errors.
Reconfigure chunk errors.
Reconfigure chunk errors.
Init ack chunk errors.
Reconfigure chunk errors.
Data chunk errors.
Forward TSN chunk errors.
Init ack chunk errors.
Init ack chunk errors.
Init chunk errors.
Init chunk errors.
Init chunk errors.
Init chunk errors.
Abort chunk errors.
Cookie ack chunk errors.
Cookie echo chunk errors.
Error chunk errors.
Heartbeat chunk errors.
Init ack chunk errors.
Selective ack chunk errors.
Shutdown chunk errors.
Shutdown ack chunk errors.
Shutdown complete chunk errors.
Init chunk errors.
Association errors.
Init chunk errors.
Association errors.
Association errors.
Association errors.
Association errors.
Heartbeat ack chunk errors.
Heartbeat ack chunk errors.
Heartbeat ack chunk errors.
Heartbeat chunk errors.
Heartbeat chunk errors.
Heartbeat chunk errors.
Association errors.
Init ack chunk errors.
Init ack chunk errors.
Init chunk errors.
Association errors.
Init ack chunk errors.
Init ack chunk errors.
Init chunk errors.
Association errors.
Init chunk errors.
Association errors.
Init ack chunk errors.
Init chunk errors.
Association errors.
Init chunk errors.
Init chunk errors.
ErrInvalidAlgorithmType is returned if unknown auth algorithm is specified.
ErrInvalidChunkLength is returned if the chunk length is invalid.
Shutdown chunk errors.
ErrInvalidSCTPChunk is returned when an SCTP chunk is invalid.
Forward TSN chunk errors.
SCTP stream errors.
SCTP packet errors.
Parameter header parse errors.
Parameter header parse errors.
Parameter header parse errors.
Parameter header parse errors.
Parameter packet errors.
Association errors.
ErrParamTypeUnhandled is returned if unknown parameter type is specified.
Heartbeat chunk errors.
SCTP packet errors.
Association errors.
Abort chunk errors.
SCTP stream errors.
Reconfiguration response errors.
Association errors.
Selective ack chunk errors.
Selective ack chunk errors.
Association errors.
Association errors.
Association errors.
Association errors.
Outgoing reset request parameter errors.
SCTP stream errors.
Association errors.
Association errors.
Pending queue errors.
Pending queue errors.
Pending queue errors.
Heartbeat ack chunk errors.
SCTP packet errors.
Zero Checksum parameter error.

# Structs

Association represents an SCTP association 13.2.
Config collects the arguments to createAssociation construction into a single structure.
Stream represents an SCTP stream.

# Type aliases

PayloadProtocolIdentifier is an enum for DataChannel payload types.
StreamState is an enum for SCTP Stream state field This field identifies the state of stream.