package protocol

Import Path
	github.com/pion/dtls/v3/pkg/protocol (on go.dev)

Dependency Relation
	imports 3 packages, and imported by 8 packages

Involved Source Files

	    application_data.go
	    change_cipher_spec.go
	    compression_method.go
	    content.go
	    errors.go
	  d version.go
		Package protocol provides the DTLS wire format
Package-Level Type Names (total 12)

	/* sort by: alphabet | popularity */
	 type ApplicationData (struct)
		ApplicationData messages are carried by the record layer and are
		fragmented, compressed, and encrypted based on the current connection
		state.  The messages are treated as transparent data to the record
		layer.
		https://tools.ietf.org/html/rfc5246#section-10

		Fields (only one)
			Data []byte
		Methods (total 3)
			( ApplicationData) ContentType() ContentType
				ContentType returns the ContentType of this content.

			(*ApplicationData) Marshal() ([]byte, error)
				Marshal encodes the ApplicationData to binary.

			(*ApplicationData) Unmarshal(data []byte) error
				Unmarshal populates the ApplicationData from binary.

		Implements (at least 6)
			*ApplicationData : Content
			*ApplicationData : github.com/pion/rtcp.PacketStatusChunk
			*ApplicationData : github.com/gogo/protobuf/proto.Marshaler
			*ApplicationData : github.com/gogo/protobuf/proto.Unmarshaler
			*ApplicationData : github.com/golang/protobuf/proto.Marshaler
			*ApplicationData : github.com/golang/protobuf/proto.Unmarshaler

	 type ChangeCipherSpec (struct)
		ChangeCipherSpec protocol exists to signal transitions in
		ciphering strategies.  The protocol consists of a single message,
		which is encrypted and compressed under the current (not the pending)
		connection state.  The message consists of a single byte of value 1.
		https://tools.ietf.org/html/rfc5246#section-7.1

		Methods (total 3)
			( ChangeCipherSpec) ContentType() ContentType
				ContentType returns the ContentType of this content.

			(*ChangeCipherSpec) Marshal() ([]byte, error)
				Marshal encodes the ChangeCipherSpec to binary.

			(*ChangeCipherSpec) Unmarshal(data []byte) error
				Unmarshal populates the ChangeCipherSpec from binary.

		Implements (at least 6)
			*ChangeCipherSpec : Content
			*ChangeCipherSpec : github.com/pion/rtcp.PacketStatusChunk
			*ChangeCipherSpec : github.com/gogo/protobuf/proto.Marshaler
			*ChangeCipherSpec : github.com/gogo/protobuf/proto.Unmarshaler
			*ChangeCipherSpec : github.com/golang/protobuf/proto.Marshaler
			*ChangeCipherSpec : github.com/golang/protobuf/proto.Unmarshaler

	 type CompressionMethod (struct)
		CompressionMethod represents a TLS Compression Method.

		Fields (only one)
			ID CompressionMethodID
		As Outputs Of (at least 2)
			func CompressionMethods() map[CompressionMethodID]*CompressionMethod
			func DecodeCompressionMethods(buf []byte) ([]*CompressionMethod, error)
		As Inputs Of (at least one exported)
			func EncodeCompressionMethods(c []*CompressionMethod) []byte

	 type CompressionMethodID byte (basic type)
		CompressionMethodID is the ID for a CompressionMethod.

		As Outputs Of (at least one exported)
			func CompressionMethods() map[CompressionMethodID]*CompressionMethod

	 type Content (interface)
		Content is the top level distinguisher for a DTLS Datagram.

		Methods (total 3)
			( Content) ContentType() ContentType
			( Content) Marshal() ([]byte, error)
			( Content) Unmarshal(data []byte) error
		Implemented By (at least 4)
			*ApplicationData
			*ChangeCipherSpec
			*github.com/pion/dtls/v3/pkg/protocol/alert.Alert
			*github.com/pion/dtls/v3/pkg/protocol/handshake.Handshake
		Implements (at least 5)
			 Content : github.com/pion/rtcp.PacketStatusChunk
			 Content : github.com/gogo/protobuf/proto.Marshaler
			 Content : github.com/gogo/protobuf/proto.Unmarshaler
			 Content : github.com/golang/protobuf/proto.Marshaler
			 Content : github.com/golang/protobuf/proto.Unmarshaler

	 type ContentType uint8 (basic type)
		ContentType represents the IANA Registered ContentTypes
		
		https://tools.ietf.org/html/rfc4346#section-6.2.1

		As Outputs Of (at least 5)
			func ApplicationData.ContentType() ContentType
			func ChangeCipherSpec.ContentType() ContentType
			func Content.ContentType() ContentType
			func github.com/pion/dtls/v3/pkg/protocol/alert.Alert.ContentType() ContentType
			func github.com/pion/dtls/v3/pkg/protocol/handshake.Handshake.ContentType() ContentType
		As Types Of (total 5)
			const ContentTypeAlert
			const ContentTypeApplicationData
			const ContentTypeChangeCipherSpec
			const ContentTypeConnectionID
			const ContentTypeHandshake

	 type FatalError (struct)
		FatalError indicates that the DTLS connection is no longer available.
		It is mainly caused by wrong configuration of server or client.

		Fields (only one)
			Err error
		Methods (total 4)
			(*FatalError) Error() string
			(*FatalError) Temporary() bool
				Temporary implements net.Error.Temporary().

			(*FatalError) Timeout() bool
				Timeout implements net.Error.Timeout().

			(*FatalError) Unwrap() error
				Unwrap implements Go1.13 error unwrapper.

		Implements (at least 4)
			*FatalError : github.com/jbenet/go-temp-err-catcher.Temporary
			*FatalError : error
			*FatalError : golang.org/x/xerrors.Wrapper
			*FatalError : net.Error
		As Types Of (total 2)
			  var github.com/pion/dtls/v3/pkg/protocol/extension.ErrALPNInvalidFormat *FatalError
			  var github.com/pion/dtls/v3.ErrConnClosed *FatalError

	 type HandshakeError (struct)
		HandshakeError indicates that the handshake failed.

		Fields (only one)
			Err error
		Methods (total 4)
			(*HandshakeError) Error() string
			(*HandshakeError) Temporary() bool
				Temporary implements net.Error.Temporary().

			(*HandshakeError) Timeout() bool
				Timeout implements net.Error.Timeout().

			(*HandshakeError) Unwrap() error
				Unwrap implements Go1.13 error unwrapper.

		Implements (at least 4)
			*HandshakeError : github.com/jbenet/go-temp-err-catcher.Temporary
			*HandshakeError : error
			*HandshakeError : golang.org/x/xerrors.Wrapper
			*HandshakeError : net.Error

	 type InternalError (struct)
		InternalError indicates and internal error caused by the implementation,
		and the DTLS connection is no longer available.
		It is mainly caused by bugs or tried to use unimplemented features.

		Fields (only one)
			Err error
		Methods (total 4)
			(*InternalError) Error() string
			(*InternalError) Temporary() bool
				Temporary implements net.Error.Temporary().

			(*InternalError) Timeout() bool
				Timeout implements net.Error.Timeout().

			(*InternalError) Unwrap() error
				Unwrap implements Go1.13 error unwrapper.

		Implements (at least 4)
			*InternalError : github.com/jbenet/go-temp-err-catcher.Temporary
			*InternalError : error
			*InternalError : golang.org/x/xerrors.Wrapper
			*InternalError : net.Error

	 type TemporaryError (struct)
		TemporaryError indicates that the DTLS connection is still available, but the request was failed temporary.

		Fields (only one)
			Err error
		Methods (total 4)
			(*TemporaryError) Error() string
			(*TemporaryError) Temporary() bool
				Temporary implements net.Error.Temporary().

			(*TemporaryError) Timeout() bool
				Timeout implements net.Error.Timeout().

			(*TemporaryError) Unwrap() error
				Unwrap implements Go1.13 error unwrapper.

		Implements (at least 4)
			*TemporaryError : github.com/jbenet/go-temp-err-catcher.Temporary
			*TemporaryError : error
			*TemporaryError : golang.org/x/xerrors.Wrapper
			*TemporaryError : net.Error
		As Types Of (only one)
			  var github.com/pion/dtls/v3/pkg/protocol/recordlayer.ErrInvalidPacketLength *TemporaryError

	 type TimeoutError (struct)
		TimeoutError indicates that the request was timed out.

		Fields (only one)
			Err error
		Methods (total 4)
			(*TimeoutError) Error() string
			(*TimeoutError) Temporary() bool
				Temporary implements net.Error.Temporary().

			(*TimeoutError) Timeout() bool
				Timeout implements net.Error.Timeout().

			(*TimeoutError) Unwrap() error
				Unwrap implements Go1.13 error unwrapper.

		Implements (at least 4)
			*TimeoutError : github.com/jbenet/go-temp-err-catcher.Temporary
			*TimeoutError : error
			*TimeoutError : golang.org/x/xerrors.Wrapper
			*TimeoutError : net.Error

	 type Version (struct)
		Version is the minor/major value in the RecordLayer
		and ClientHello/ServerHello
		
		https://tools.ietf.org/html/rfc4346#section-6.2.1

		Fields (total 2)
			Major uint8
			Minor uint8
		Methods (only one)
			( Version) Equal(x Version) bool
				Equal determines if two protocol versions are equal.

		As Inputs Of (at least one exported)
			func Version.Equal(x Version) bool
		As Types Of (total 2)
			  var Version1_0
			  var Version1_2


Package-Level Functions (total 3)

	 func CompressionMethods() map[CompressionMethodID]*CompressionMethod
		CompressionMethods returns all supported CompressionMethods.

	 func DecodeCompressionMethods(buf []byte) ([]*CompressionMethod, error)
		DecodeCompressionMethods the given compression methods.

	 func EncodeCompressionMethods(c []*CompressionMethod) []byte
		EncodeCompressionMethods the given compression methods.


Package-Level Variables (total 2)

	  var Version1_0 Version
		Version enums.

	  var Version1_2 Version
		Version enums.


Package-Level Constants (total 5)

	const ContentTypeAlert ContentType = 21
		ContentType enums.

	const ContentTypeApplicationData ContentType = 23
		ContentType enums.

	const ContentTypeChangeCipherSpec ContentType = 20
		ContentType enums.

	const ContentTypeConnectionID ContentType = 25
		ContentType enums.

	const ContentTypeHandshake ContentType = 22
		ContentType 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.