uquic/interface.go

package quic

import (
	"crypto/tls"
	"io"
	"net"

	"github.com/lucas-clemente/quic-go/protocol"
)

// Stream is the interface for QUIC streams
type Stream interface {
	io.Reader
	io.Writer
	io.Closer
	StreamID() protocol.StreamID
	CloseRemote(offset protocol.ByteCount)
	Reset(error)
}

// A Session is a QUIC Session
type Session interface {
	// get the next stream opened by the client
	// first stream returned has StreamID 3
	AcceptStream() (Stream, error)
	// guaranteed to return the smallest unopened stream
	// special error for "too many streams, retry later"
	OpenStream() (Stream, error)
	// blocks until a new stream can be opened, if the maximum number of stream is opened
	OpenStreamSync() (Stream, error)
	RemoteAddr() net.Addr
	Close(error) error
}

// ConnState is the status of the connection
type ConnState int

const (
	// ConnStateInitial is the initial state
	ConnStateInitial ConnState = iota
	// ConnStateVersionNegotiated means that version negotiation is complete
	ConnStateVersionNegotiated
	// ConnStateSecure means that the connection is encrypted
	ConnStateSecure
	// ConnStateForwardSecure means that the connection is forward secure
	ConnStateForwardSecure
)

// ConnStateCallback is called every time the connection moves to another connection state
// the callback is called in a new go routine
type ConnStateCallback func(Session, ConnState)

// Config is the configuration for QUIC
type Config struct {
	TLSConfig *tls.Config
	// will be called in a separate goroutine
	ConnState ConnStateCallback
}

// A Listener listens for incoming QUIC connections
type Listener interface {
	Close() error
	Addr() net.Addr
	Serve() error
}