quic

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(addr string) (Client, error)
• type QuicConn
  • func NewQuicConn(name string, connType string) *QuicConn
  • func (c *QuicConn) Close() error
  • func (c *QuicConn) Healthcheck()
  • func (c *QuicConn) SendSignal(b []byte) error
• type Server
  • func NewServer(handler ServerHandler) Server
• type ServerHandler
• type Session
• type Stream

Constants

const (
	ConnTypeSource       string = "source"
	ConnTypeFlow         string = "flow"
	ConnTypeSink         string = "sink"
	ConnTypeServerless   string = "serverless"
	ConnTypeZipperSender string = "zipper-sender"
)

Variables

var (
	// SignalHeartbeat represents the signal of Heartbeat.
	SignalHeartbeat = []byte{0}

	// SignalAccepted represents the signal of Accpeted.
	SignalAccepted = []byte{1}

	// SignalFlowSink represents the signal for flow/sink.
	SignalFlowSink = []byte{0, 0}
)

Types

type Client

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

Client is the QUIC client.

func NewClient

func NewClient(addr string) (Client, error)

NewClient inits the default implementation of QUIC client.

type QuicConn

type QuicConn struct {
	Signal              io.ReadWriter
	Stream              io.ReadWriter
	Type                string
	Name                string
	Heartbeat           chan byte
	IsClosed            bool
	Ready               bool
	OnClosed            func() error // OnClosed is the callback when the connection is closed.
	OnHeartbeatReceived func()       // OnHeartbeatReceived is the callback when the heartbeat is received.
	OnHeartbeatExpired  func()       // OnHeartbeatExpired is the callback when the heartbeat is expired.
}

QuicConn represents the QUIC connection.

func NewQuicConn

func NewQuicConn(name string, connType string) *QuicConn

NewQuicConn inits a new QUIC connection.

func (*QuicConn) Close

func (c *QuicConn) Close() error

Close the QUIC connections.

func (*QuicConn) Healthcheck

func (c *QuicConn) Healthcheck()

Healthcheck checks if receiving the heartbeat from peer.

func (*QuicConn) SendSignal

func (c *QuicConn) SendSignal(b []byte) error

SendSignal sends the signal to client.

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(handler ServerHandler) Server

NewServer inits the default implementation of QUIC server.

type ServerHandler

type ServerHandler interface {
	Listen() error
	Read(id int64, sess Session, st Stream) error
}

ServerHandler defines interface to handle the QUIC stream callbacks.

type Session

type Session interface {
	quic.Session
}

type Stream

type Stream interface {
	quic.Stream
}

Stream is the QUIC stream