package webtransport

Import Path
	github.com/quic-go/webtransport-go (on go.dev)

Dependency Relation
	imports 20 packages, and imported by one package

Involved Source Files

	    client.go
	    errors.go
	    protocol.go
	    server.go
	    session.go
	    session_manager.go
	    stream.go
	    streams_map.go
Package-Level Type Names (total 11)

	/* sort by: alphabet | popularity */
	 type Dialer (struct)

		Fields (total 5)
			ApplicationProtocols []string
				ApplicationProtocols is a list of application protocols that can be negotiated,
				see section 3.3 of https://www.ietf.org/archive/id/draft-ietf-webtrans-http3-14 for details.

			DialAddr func(ctx context.Context, addr string, tlsCfg *tls.Config, cfg *quic.Config) (*quic.Conn, error)
				DialAddr is the function used to dial the underlying QUIC connection.
				If unset, quic.DialAddrEarly will be used.

			QUICConfig *quic.Config
				QUICConfig is the QUIC config used when dialing the QUIC connection.

			StreamReorderingTimeout time.Duration
				StreamReorderingTime is the time an incoming WebTransport stream that cannot be associated
				with a session is buffered.
				This can happen if the response to a CONNECT request (that creates a new session) is reordered,
				and arrives after the first WebTransport stream(s) for that session.
				Defaults to 5 seconds.

			TLSClientConfig *tls.Config
				TLSClientConfig is the TLS client config used when dialing the QUIC connection.
				It must set the h3 ALPN.

		Methods (total 2)
			(*Dialer) Close() error
			(*Dialer) Dial(ctx context.Context, urlStr string, reqHdr http.Header) (*http.Response, *Session, error)
		Implements (at least 2)
			*Dialer : github.com/prometheus/common/expfmt.Closer
			*Dialer : io.Closer

	 type ReceiveStream (struct)
		A ReceiveStream is a unidirectional WebTransport receive stream.

		Methods (total 3)
			(*ReceiveStream) CancelRead(e StreamErrorCode)
				CancelRead aborts receiving on this stream.
				It instructs the peer to stop transmitting stream data.
				Read will unblock immediately, and future Read calls will fail.
				When called multiple times it is a no-op.

			(*ReceiveStream) Read(b []byte) (int, error)
				Read reads data from the stream.
				Read can be made to time out using [ReceiveStream.SetReadDeadline].
				If the stream was canceled, the error is a [StreamError].

			(*ReceiveStream) SetReadDeadline(t time.Time) error
				SetReadDeadline sets the deadline for future Read calls and
				any currently-blocked Read call.
				A zero value for t means Read will not time out.

		Implements (at least 2)
			*ReceiveStream : github.com/pion/datachannel.ReadDeadliner
			*ReceiveStream : io.Reader
		As Outputs Of (at least one exported)
			func (*Session).AcceptUniStream(ctx context.Context) (*ReceiveStream, error)

	 type SendStream (struct)
		A SendStream is a unidirectional WebTransport send stream.

		Methods (total 5)
			(*SendStream) CancelWrite(e StreamErrorCode)
				CancelWrite aborts sending on this stream.
				Data already written, but not yet delivered to the peer is not guaranteed to be delivered reliably.
				Write will unblock immediately, and future calls to Write will fail.
				When called multiple times it is a no-op.

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

			(*SendStream) Context() context.Context
				The Context is canceled as soon as the write-side of the stream is closed.
				This happens when Close() or CancelWrite() is called, or when the peer
				cancels the read-side of their stream.
				The cancellation cause is set to the error that caused the stream to
				close, or `context.Canceled` in case the stream is closed without error.

			(*SendStream) SetWriteDeadline(t time.Time) error
				SetWriteDeadline sets the deadline for future Write calls
				and any currently-blocked Write call.
				Even if write times out, it may return n > 0, indicating that
				some data was successfully written.
				A zero value for t means Write will not time out.

			(*SendStream) Write(b []byte) (int, error)
				Write writes data to the stream.
				Write can be made to time out using [SendStream.SetWriteDeadline].
				If the stream was canceled, the error is a [StreamError].

		Implements (at least 7)
			*SendStream : github.com/miekg/dns.Writer
			*SendStream : github.com/pion/datachannel.WriteDeadliner
			*SendStream : github.com/prometheus/common/expfmt.Closer
			*SendStream : internal/bisect.Writer
			*SendStream : io.Closer
			*SendStream : io.WriteCloser
			*SendStream : io.Writer
		As Outputs Of (at least 2)
			func (*Session).OpenUniStream() (*SendStream, error)
			func (*Session).OpenUniStreamSync(ctx context.Context) (str *SendStream, err error)

	 type Server (struct)

		Fields (total 4)
			ApplicationProtocols []string
				ApplicationProtocols is a list of application protocols that can be negotiated,
				see section 3.3 of https://www.ietf.org/archive/id/draft-ietf-webtrans-http3-14 for details.

			CheckOrigin func(r *http.Request) bool
				CheckOrigin is used to validate the request origin, thereby preventing cross-site request forgery.
				CheckOrigin returns true if the request Origin header is acceptable.
				If unset, a safe default is used: If the Origin header is set, it is checked that it
				matches the request's Host header.

			H3 *http3.Server
			ReorderingTimeout time.Duration
				ReorderingTimeout is the maximum time an incoming WebTransport stream that cannot be associated
				with a session is buffered. It is also the maximum time a WebTransport connection request is
				blocked waiting for the client's SETTINGS are received.
				This can happen if the CONNECT request (that creates a new session) is reordered, and arrives
				after the first WebTransport stream(s) for that session.
				Defaults to 5 seconds.

		Methods (total 6)
			(*Server) Close() error
			(*Server) ListenAndServe() error
			(*Server) ListenAndServeTLS(certFile, keyFile string) error
			(*Server) Serve(conn net.PacketConn) error
			(*Server) ServeQUICConn(conn *quic.Conn) error
				ServeQUICConn serves a single QUIC connection.

			(*Server) Upgrade(w http.ResponseWriter, r *http.Request) (*Session, error)
		Implements (at least 2)
			*Server : github.com/prometheus/common/expfmt.Closer
			*Server : io.Closer

	 type Session (struct)

		Methods (total 13)
			(*Session) AcceptStream(ctx context.Context) (*Stream, error)
			(*Session) AcceptUniStream(ctx context.Context) (*ReceiveStream, error)
			(*Session) CloseWithError(code SessionErrorCode, msg string) error
			(*Session) Context() context.Context
				Context returns a context that is closed when the session is closed.

			(*Session) LocalAddr() net.Addr
			(*Session) OpenStream() (*Stream, error)
			(*Session) OpenStreamSync(ctx context.Context) (*Stream, error)
			(*Session) OpenUniStream() (*SendStream, error)
			(*Session) OpenUniStreamSync(ctx context.Context) (str *SendStream, err error)
			(*Session) ReceiveDatagram(ctx context.Context) ([]byte, error)
			(*Session) RemoteAddr() net.Addr
			(*Session) SendDatagram(b []byte) error
			(*Session) SessionState() SessionState
				SessionState returns the current state of the session

		As Outputs Of (at least 2)
			func (*Dialer).Dial(ctx context.Context, urlStr string, reqHdr http.Header) (*http.Response, *Session, error)
			func (*Server).Upgrade(w http.ResponseWriter, r *http.Request) (*Session, error)

	 type SessionError (struct)
		SessionError is a WebTransport connection error.

		Fields (total 3)
			ErrorCode SessionErrorCode
			Message string
			Remote bool
		Methods (total 2)
			(*SessionError) Error() string
			(*SessionError) Is(target error) bool
		Implements (at least one exported)
			*SessionError : error

	 type SessionErrorCode uint32 (basic type)
		SessionErrorCode is an error code for session termination.

		As Inputs Of (at least one exported)
			func (*Session).CloseWithError(code SessionErrorCode, msg string) error

	 type SessionState (struct)
		SessionState contains the state of a WebTransport session

		Fields (total 2)
			ApplicationProtocol string
				ApplicationProtocol contains the application protocol negotiated for the session

			ConnectionState quic.ConnectionState
				ConnectionState contains the QUIC connection state, including TLS handshake information

		As Outputs Of (at least one exported)
			func (*Session).SessionState() SessionState

	 type Stream (struct)
		Stream is a bidirectional WebTransport stream.

		Methods (total 9)
			(*Stream) CancelRead(e StreamErrorCode)
				CancelRead aborts receiving on this stream.
				See [ReceiveStream.CancelRead] for more details.

			(*Stream) CancelWrite(e StreamErrorCode)
				CancelWrite aborts sending on this stream.
				See [SendStream.CancelWrite] for more details.

			(*Stream) Close() error
				Close closes the send-direction of the stream.
				It does not close the receive-direction of the stream.

			(*Stream) Context() context.Context
				The Context is canceled as soon as the write-side of the stream is closed.
				See [SendStream.Context] for more details.

			(*Stream) Read(b []byte) (int, error)
				Read reads data from the stream.
				Read can be made to time out using [Stream.SetReadDeadline] and [Stream.SetDeadline].
				If the stream was canceled, the error is a [StreamError].

			(*Stream) SetDeadline(t time.Time) error
				SetDeadline sets the read and write deadlines associated with the stream.
				It is equivalent to calling both SetReadDeadline and SetWriteDeadline.

			(*Stream) SetReadDeadline(t time.Time) error
				SetReadDeadline sets the deadline for future Read calls.
				See [ReceiveStream.SetReadDeadline] for more details.

			(*Stream) SetWriteDeadline(t time.Time) error
				SetWriteDeadline sets the deadline for future Write calls.
				See [SendStream.SetWriteDeadline] for more details.

			(*Stream) Write(b []byte) (int, error)
				Write writes data to the stream.
				Write can be made to time out using [Stream.SetWriteDeadline] or [Stream.SetDeadline].
				If the stream was canceled, the error is a [StreamError].

		Implements (at least 14)
			*Stream : github.com/miekg/dns.Writer
			*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/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 3)
			func (*Session).AcceptStream(ctx context.Context) (*Stream, error)
			func (*Session).OpenStream() (*Stream, error)
			func (*Session).OpenStreamSync(ctx context.Context) (*Stream, error)

	 type StreamError (struct)
		StreamError is the error that is returned from stream operations (Read, Write) when the stream is canceled.

		Fields (total 2)
			ErrorCode StreamErrorCode
			Remote bool
		Methods (total 2)
			(*StreamError) Error() string
			(*StreamError) Is(target error) bool
		Implements (at least one exported)
			*StreamError : error

	 type StreamErrorCode uint32 (basic type)
		StreamErrorCode is an error code used for stream termination.

		As Inputs Of (at least 4)
			func (*ReceiveStream).CancelRead(e StreamErrorCode)
			func (*SendStream).CancelWrite(e StreamErrorCode)
			func (*Stream).CancelRead(e StreamErrorCode)
			func (*Stream).CancelWrite(e StreamErrorCode)


Package-Level Functions (only one)

	 func ConfigureHTTP3Server(s *http3.Server)
Package-Level Constants (total 2)

	const WTBufferedStreamRejectedErrorCode quic.StreamErrorCode = 966049156
		WTBufferedStreamRejectedErrorCode is the error code of the
		WT_BUFFERED_STREAM_REJECTED error.

	const WTSessionGoneErrorCode quic.StreamErrorCode = 386759528
		WTSessionGoneErrorCode is the error code of the WT_SESSION_GONE error.

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.