quic

Documentation

Index

• type Client
  • func NewClient(addr string) (Client, error)
• type ReceiveStream
• type SendStream
• type Server
  • func NewServer(handle ServerHandler) Server
• type ServerHandler
• type Stream

Types

type Client

type Client interface {
	// CreateStream creates a bidirectional stream.
	CreateStream(ctx context.Context) (Stream, error)
}

Client is the QUIC client.

func NewClient

func NewClient(addr string) (Client, error)

NewClient inits the default implementation of QUIC client.

type ReceiveStream

type ReceiveStream interface {
	io.Reader
}

ReceiveStream is an unidirectional Receive Stream.

type SendStream

type SendStream interface {
	io.Writer
	io.Closer
}

A SendStream is an unidirectional Send Stream.

type Server

type Server interface {
	// SetHandler sets QUIC callbacks.
	SetHandler(handler ServerHandler)

	// ListenAndServe starts listening on UDP network address addr and
	// serves incoming packets.
	ListenAndServe(ctx context.Context, addr string) error
}

Server is the QUIC server.

func NewServer

func NewServer(handle ServerHandler) Server

NewServer inits the default implementation of QUIC server.

type ServerHandler

type ServerHandler interface {
	Listen() error
	Read(st Stream) error
}

ServerHandler defines interface to handle the QUIC stream callbacks.

type Stream

type Stream interface {
	ReceiveStream
	SendStream
}

Stream is the QUIC stream