quick

README

a net.Conn compatible lib via QUIC

The initial code is cloned from quic-conn, but I refactored and updated codes to keepcompatible with latest https://github.com/AllenCXS/quick.

Run the example

Start listening for an incoming QUIC connection

go run example/main.go -s

The server will echo every message received on the connection in uppercase.

Send a message on the QUIC connection:

go run example/main.go -c

Documentation

Index

• func Dial(addr string, tlsConfig *tls.Config, quicConfig *quic.Config) (net.Conn, error)
• func Listen(network, laddr string, tlsConfig *tls.Config, quicConfig *quic.Config) (net.Listener, error)
• type Conn
  • func (c *Conn) Close() error
  • func (c *Conn) LocalAddr() net.Addr
  • func (c *Conn) Read(b []byte) (int, error)
  • func (c *Conn) RemoteAddr() net.Addr
  • func (c *Conn) SetDeadline(t time.Time) error
  • func (c *Conn) SetReadBuffer(bytes int) error
  • func (c *Conn) SetReadDeadline(t time.Time) error
  • func (c *Conn) SetWriteBuffer(bytes int) error
  • func (c *Conn) SetWriteDeadline(t time.Time) error
  • func (c *Conn) SyscallConn() (syscall.RawConn, error)
  • func (c *Conn) Write(b []byte) (int, error)

Functions

func Dial

func Dial(addr string, tlsConfig *tls.Config, quicConfig *quic.Config) (net.Conn, error)

Dial creates a new QUIC connection it returns once the connection is established and secured with forward-secure keys

func Listen

func Listen(network, laddr string, tlsConfig *tls.Config, quicConfig *quic.Config) (net.Listener, error)

Listen creates a QUIC listener on the given network interface

Types

type Conn

type Conn struct {
	// contains filtered or unexported fields
}

Conn is a generic quic connection implements net.Conn.

func (*Conn) Close

func (c *Conn) Close() error

Close closes the connection.

func (*Conn) LocalAddr

func (c *Conn) LocalAddr() net.Addr

LocalAddr returns the local network address.

func (*Conn) Read

func (c *Conn) Read(b []byte) (int, error)

Read implements the Conn Read method.

func (*Conn) RemoteAddr

func (c *Conn) RemoteAddr() net.Addr

RemoteAddr returns the remote network address.

func (*Conn) SetDeadline

func (c *Conn) SetDeadline(t time.Time) error

SetDeadline sets the deadline associated with the listener. A zero time value disables the deadline.

func (*Conn) SetReadBuffer

func (c *Conn) SetReadBuffer(bytes int) error

SetReadBuffer sets the size of the operating system's receive buffer associated with the connection.

func (*Conn) SetReadDeadline

func (c *Conn) SetReadDeadline(t time.Time) error

SetReadDeadline implements the Conn SetReadDeadline method.

func (*Conn) SetWriteBuffer

func (c *Conn) SetWriteBuffer(bytes int) error

SetWriteBuffer sets the size of the operating system's transmit buffer associated with the connection.

func (*Conn) SetWriteDeadline

func (c *Conn) SetWriteDeadline(t time.Time) error

SetWriteDeadline implements the Conn SetWriteDeadline method.

func (*Conn) SyscallConn

func (c *Conn) SyscallConn() (syscall.RawConn, error)

SyscallConn returns a raw network connection. This implements the syscall.Conn interface.

func (*Conn) Write

func (c *Conn) Write(b []byte) (int, error)

Write implements the Conn Write method.