Back to godoc.org

Package utils

v0.17.3
Latest Go to latest
Published: Jul 11, 2020 | License: MIT | Module: github.com/lucas-clemente/quic-go

Index

Package Files

Constants

const InfDuration = time.Duration(math.MaxInt64)

InfDuration is a duration of infinite length

func AbsDuration

func AbsDuration(d time.Duration) time.Duration

AbsDuration returns the absolute value of a time duration

func Max

func Max(a, b int) int

Max returns the maximum of two Ints

func MaxByteCount

func MaxByteCount(a, b protocol.ByteCount) protocol.ByteCount

MaxByteCount returns the maximum of two ByteCounts

func MaxDuration

func MaxDuration(a, b time.Duration) time.Duration

MaxDuration returns the max duration

func MaxInt64

func MaxInt64(a, b int64) int64

MaxInt64 returns the minimum of two int64

func MaxPacketNumber

func MaxPacketNumber(a, b protocol.PacketNumber) protocol.PacketNumber

MaxPacketNumber returns the max packet number

func MaxTime

func MaxTime(a, b time.Time) time.Time

MaxTime returns the later time

func MaxUint32

func MaxUint32(a, b uint32) uint32

MaxUint32 returns the maximum of two uint32

func MaxUint64

func MaxUint64(a, b uint64) uint64

MaxUint64 returns the maximum of two uint64

func Min

func Min(a, b int) int

Min returns the minimum of two Ints

func MinByteCount

func MinByteCount(a, b protocol.ByteCount) protocol.ByteCount

MinByteCount returns the minimum of two ByteCounts

func MinDuration

func MinDuration(a, b time.Duration) time.Duration

MinDuration returns the minimum duration

func MinInt64

func MinInt64(a, b int64) int64

MinInt64 returns the minimum of two int64

func MinNonZeroDuration

func MinNonZeroDuration(a, b time.Duration) time.Duration

MinNonZeroDuration return the minimum duration that's not zero.

func MinNonZeroTime

func MinNonZeroTime(a, b time.Time) time.Time

MinNonZeroTime returns the earlist time that is not time.Time{} If both a and b are time.Time{}, it returns time.Time{}

func MinPacketNumber

func MinPacketNumber(a, b protocol.PacketNumber) protocol.PacketNumber

MinPacketNumber returns the min packet number

func MinTime

func MinTime(a, b time.Time) time.Time

MinTime returns the earlier time

func MinUint32

func MinUint32(a, b uint32) uint32

MinUint32 returns the maximum of two uint32

func MinUint64

func MinUint64(a, b uint64) uint64

MinUint64 returns the maximum of two uint64

func NewBufferedWriteCloser

func NewBufferedWriteCloser(writer *bufio.Writer, closer io.Closer) io.WriteCloser

NewBufferedWriteCloser creates an io.WriteCloser from a bufio.Writer and an io.Closer

func ReadVarInt

func ReadVarInt(b io.ByteReader) (uint64, error)

ReadVarInt reads a number in the QUIC varint format

func VarIntLen

func VarIntLen(i uint64) protocol.ByteCount

VarIntLen determines the number of bytes that will be needed to write a number

func WriteVarInt

func WriteVarInt(b *bytes.Buffer, i uint64)

WriteVarInt writes a number in the QUIC varint format

type AtomicBool

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

An AtomicBool is an atomic bool

func (*AtomicBool) Get

func (a *AtomicBool) Get() bool

Get gets the value

func (*AtomicBool) Set

func (a *AtomicBool) Set(value bool)

Set sets the value

type ByteInterval

type ByteInterval struct {
	Start protocol.ByteCount
	End   protocol.ByteCount
}

ByteInterval is an interval from one ByteCount to the other

type ByteIntervalElement

type ByteIntervalElement struct {

	// The value stored with this element.
	Value ByteInterval
	// contains filtered or unexported fields
}

ByteIntervalElement is an element of a linked list.

func (*ByteIntervalElement) Next

func (e *ByteIntervalElement) Next() *ByteIntervalElement

Next returns the next list element or nil.

func (*ByteIntervalElement) Prev

func (e *ByteIntervalElement) Prev() *ByteIntervalElement

Prev returns the previous list element or nil.

type ByteIntervalList

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

ByteIntervalList is a linked list of ByteIntervals.

func NewByteIntervalList

func NewByteIntervalList() *ByteIntervalList

NewByteIntervalList returns an initialized list.

func (*ByteIntervalList) Back

func (l *ByteIntervalList) Back() *ByteIntervalElement

Back returns the last element of list l or nil if the list is empty.

func (*ByteIntervalList) Front

func (l *ByteIntervalList) Front() *ByteIntervalElement

Front returns the first element of list l or nil if the list is empty.

func (*ByteIntervalList) Init

func (l *ByteIntervalList) Init() *ByteIntervalList

Init initializes or clears list l.

func (*ByteIntervalList) InsertAfter

func (l *ByteIntervalList) InsertAfter(v ByteInterval, mark *ByteIntervalElement) *ByteIntervalElement

InsertAfter inserts a new element e with value v immediately after mark and returns e. If mark is not an element of l, the list is not modified. The mark must not be nil.

func (*ByteIntervalList) InsertBefore

func (l *ByteIntervalList) InsertBefore(v ByteInterval, mark *ByteIntervalElement) *ByteIntervalElement

InsertBefore inserts a new element e with value v immediately before mark and returns e. If mark is not an element of l, the list is not modified. The mark must not be nil.

func (*ByteIntervalList) Len

func (l *ByteIntervalList) Len() int

Len returns the number of elements of list l. The complexity is O(1).

func (*ByteIntervalList) MoveAfter

func (l *ByteIntervalList) MoveAfter(e, mark *ByteIntervalElement)

MoveAfter moves element e to its new position after mark. If e or mark is not an element of l, or e == mark, the list is not modified. The element and mark must not be nil.

func (*ByteIntervalList) MoveBefore

func (l *ByteIntervalList) MoveBefore(e, mark *ByteIntervalElement)

MoveBefore moves element e to its new position before mark. If e or mark is not an element of l, or e == mark, the list is not modified. The element and mark must not be nil.

func (*ByteIntervalList) MoveToBack

func (l *ByteIntervalList) MoveToBack(e *ByteIntervalElement)

MoveToBack moves element e to the back of list l. If e is not an element of l, the list is not modified. The element must not be nil.

func (*ByteIntervalList) MoveToFront

func (l *ByteIntervalList) MoveToFront(e *ByteIntervalElement)

MoveToFront moves element e to the front of list l. If e is not an element of l, the list is not modified. The element must not be nil.

func (*ByteIntervalList) PushBack

func (l *ByteIntervalList) PushBack(v ByteInterval) *ByteIntervalElement

PushBack inserts a new element e with value v at the back of list l and returns e.

func (*ByteIntervalList) PushBackList

func (l *ByteIntervalList) PushBackList(other *ByteIntervalList)

PushBackList inserts a copy of an other list at the back of list l. The lists l and other may be the same. They must not be nil.

func (*ByteIntervalList) PushFront

func (l *ByteIntervalList) PushFront(v ByteInterval) *ByteIntervalElement

PushFront inserts a new element e with value v at the front of list l and returns e.

func (*ByteIntervalList) PushFrontList

func (l *ByteIntervalList) PushFrontList(other *ByteIntervalList)

PushFrontList inserts a copy of an other list at the front of list l. The lists l and other may be the same. They must not be nil.

func (*ByteIntervalList) Remove

func (l *ByteIntervalList) Remove(e *ByteIntervalElement) ByteInterval

Remove removes e from l if e is an element of list l. It returns the element value e.Value. The element must not be nil.

type ByteOrder

type ByteOrder interface {
	ReadUint32(io.ByteReader) (uint32, error)
	ReadUint24(io.ByteReader) (uint32, error)
	ReadUint16(io.ByteReader) (uint16, error)

	WriteUint32(*bytes.Buffer, uint32)
	WriteUint24(*bytes.Buffer, uint32)
	WriteUint16(*bytes.Buffer, uint16)
}

A ByteOrder specifies how to convert byte sequences into 16-, 32-, or 64-bit unsigned integers.

var BigEndian ByteOrder = bigEndian{}

BigEndian is the big-endian implementation of ByteOrder.

type LogLevel

type LogLevel uint8

LogLevel of quic-go

const (
	// LogLevelNothing disables
	LogLevelNothing LogLevel = iota
	// LogLevelError enables err logs
	LogLevelError
	// LogLevelInfo enables info logs (e.g. packets)
	LogLevelInfo
	// LogLevelDebug enables debug logs (e.g. packet contents)
	LogLevelDebug
)

type Logger

type Logger interface {
	SetLogLevel(LogLevel)
	SetLogTimeFormat(format string)
	WithPrefix(prefix string) Logger
	Debug() bool

	Errorf(format string, args ...interface{})
	Infof(format string, args ...interface{})
	Debugf(format string, args ...interface{})
}

A Logger logs.

var DefaultLogger Logger

DefaultLogger is used by quic-go for logging.

type NewConnectionID

type NewConnectionID struct {
	SequenceNumber      uint64
	ConnectionID        protocol.ConnectionID
	StatelessResetToken *[16]byte
}

NewConnectionID is a new connection ID

type NewConnectionIDElement

type NewConnectionIDElement struct {

	// The value stored with this element.
	Value NewConnectionID
	// contains filtered or unexported fields
}

NewConnectionIDElement is an element of a linked list.

func (*NewConnectionIDElement) Next

func (e *NewConnectionIDElement) Next() *NewConnectionIDElement

Next returns the next list element or nil.

func (*NewConnectionIDElement) Prev

func (e *NewConnectionIDElement) Prev() *NewConnectionIDElement

Prev returns the previous list element or nil.

type NewConnectionIDList

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

NewConnectionIDList is a linked list of NewConnectionIDs.

func NewNewConnectionIDList

func NewNewConnectionIDList() *NewConnectionIDList

NewNewConnectionIDList returns an initialized list.

func (*NewConnectionIDList) Back

func (l *NewConnectionIDList) Back() *NewConnectionIDElement

Back returns the last element of list l or nil if the list is empty.

func (*NewConnectionIDList) Front

func (l *NewConnectionIDList) Front() *NewConnectionIDElement

Front returns the first element of list l or nil if the list is empty.

func (*NewConnectionIDList) Init

func (l *NewConnectionIDList) Init() *NewConnectionIDList

Init initializes or clears list l.

func (*NewConnectionIDList) InsertAfter

func (l *NewConnectionIDList) InsertAfter(v NewConnectionID, mark *NewConnectionIDElement) *NewConnectionIDElement

InsertAfter inserts a new element e with value v immediately after mark and returns e. If mark is not an element of l, the list is not modified. The mark must not be nil.

func (*NewConnectionIDList) InsertBefore

func (l *NewConnectionIDList) InsertBefore(v NewConnectionID, mark *NewConnectionIDElement) *NewConnectionIDElement

InsertBefore inserts a new element e with value v immediately before mark and returns e. If mark is not an element of l, the list is not modified. The mark must not be nil.

func (*NewConnectionIDList) Len

func (l *NewConnectionIDList) Len() int

Len returns the number of elements of list l. The complexity is O(1).

func (*NewConnectionIDList) MoveAfter

func (l *NewConnectionIDList) MoveAfter(e, mark *NewConnectionIDElement)

MoveAfter moves element e to its new position after mark. If e or mark is not an element of l, or e == mark, the list is not modified. The element and mark must not be nil.

func (*NewConnectionIDList) MoveBefore

func (l *NewConnectionIDList) MoveBefore(e, mark *NewConnectionIDElement)

MoveBefore moves element e to its new position before mark. If e or mark is not an element of l, or e == mark, the list is not modified. The element and mark must not be nil.

func (*NewConnectionIDList) MoveToBack

func (l *NewConnectionIDList) MoveToBack(e *NewConnectionIDElement)

MoveToBack moves element e to the back of list l. If e is not an element of l, the list is not modified. The element must not be nil.

func (*NewConnectionIDList) MoveToFront

func (l *NewConnectionIDList) MoveToFront(e *NewConnectionIDElement)

MoveToFront moves element e to the front of list l. If e is not an element of l, the list is not modified. The element must not be nil.

func (*NewConnectionIDList) PushBack

func (l *NewConnectionIDList) PushBack(v NewConnectionID) *NewConnectionIDElement

PushBack inserts a new element e with value v at the back of list l and returns e.

func (*NewConnectionIDList) PushBackList

func (l *NewConnectionIDList) PushBackList(other *NewConnectionIDList)

PushBackList inserts a copy of an other list at the back of list l. The lists l and other may be the same. They must not be nil.

func (*NewConnectionIDList) PushFront

func (l *NewConnectionIDList) PushFront(v NewConnectionID) *NewConnectionIDElement

PushFront inserts a new element e with value v at the front of list l and returns e.

func (*NewConnectionIDList) PushFrontList

func (l *NewConnectionIDList) PushFrontList(other *NewConnectionIDList)

PushFrontList inserts a copy of an other list at the front of list l. The lists l and other may be the same. They must not be nil.

func (*NewConnectionIDList) Remove

func (l *NewConnectionIDList) Remove(e *NewConnectionIDElement) NewConnectionID

Remove removes e from l if e is an element of list l. It returns the element value e.Value. The element must not be nil.

type PacketInterval

type PacketInterval struct {
	Start protocol.PacketNumber
	End   protocol.PacketNumber
}

PacketInterval is an interval from one PacketNumber to the other

type PacketIntervalElement

type PacketIntervalElement struct {

	// The value stored with this element.
	Value PacketInterval
	// contains filtered or unexported fields
}

PacketIntervalElement is an element of a linked list.

func (*PacketIntervalElement) Next

func (e *PacketIntervalElement) Next() *PacketIntervalElement

Next returns the next list element or nil.

func (*PacketIntervalElement) Prev

func (e *PacketIntervalElement) Prev() *PacketIntervalElement

Prev returns the previous list element or nil.

type PacketIntervalList

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

PacketIntervalList is a linked list of PacketIntervals.

func NewPacketIntervalList

func NewPacketIntervalList() *PacketIntervalList

NewPacketIntervalList returns an initialized list.

func (*PacketIntervalList) Back

func (l *PacketIntervalList) Back() *PacketIntervalElement

Back returns the last element of list l or nil if the list is empty.

func (*PacketIntervalList) Front

func (l *PacketIntervalList) Front() *PacketIntervalElement

Front returns the first element of list l or nil if the list is empty.

func (*PacketIntervalList) Init

func (l *PacketIntervalList) Init() *PacketIntervalList

Init initializes or clears list l.

func (*PacketIntervalList) InsertAfter

func (l *PacketIntervalList) InsertAfter(v PacketInterval, mark *PacketIntervalElement) *PacketIntervalElement

InsertAfter inserts a new element e with value v immediately after mark and returns e. If mark is not an element of l, the list is not modified. The mark must not be nil.

func (*PacketIntervalList) InsertBefore

func (l *PacketIntervalList) InsertBefore(v PacketInterval, mark *PacketIntervalElement) *PacketIntervalElement

InsertBefore inserts a new element e with value v immediately before mark and returns e. If mark is not an element of l, the list is not modified. The mark must not be nil.

func (*PacketIntervalList) Len

func (l *PacketIntervalList) Len() int

Len returns the number of elements of list l. The complexity is O(1).

func (*PacketIntervalList) MoveAfter

func (l *PacketIntervalList) MoveAfter(e, mark *PacketIntervalElement)

MoveAfter moves element e to its new position after mark. If e or mark is not an element of l, or e == mark, the list is not modified. The element and mark must not be nil.

func (*PacketIntervalList) MoveBefore

func (l *PacketIntervalList) MoveBefore(e, mark *PacketIntervalElement)

MoveBefore moves element e to its new position before mark. If e or mark is not an element of l, or e == mark, the list is not modified. The element and mark must not be nil.

func (*PacketIntervalList) MoveToBack

func (l *PacketIntervalList) MoveToBack(e *PacketIntervalElement)

MoveToBack moves element e to the back of list l. If e is not an element of l, the list is not modified. The element must not be nil.

func (*PacketIntervalList) MoveToFront

func (l *PacketIntervalList) MoveToFront(e *PacketIntervalElement)

MoveToFront moves element e to the front of list l. If e is not an element of l, the list is not modified. The element must not be nil.

func (*PacketIntervalList) PushBack

func (l *PacketIntervalList) PushBack(v PacketInterval) *PacketIntervalElement

PushBack inserts a new element e with value v at the back of list l and returns e.

func (*PacketIntervalList) PushBackList

func (l *PacketIntervalList) PushBackList(other *PacketIntervalList)

PushBackList inserts a copy of an other list at the back of list l. The lists l and other may be the same. They must not be nil.

func (*PacketIntervalList) PushFront

func (l *PacketIntervalList) PushFront(v PacketInterval) *PacketIntervalElement

PushFront inserts a new element e with value v at the front of list l and returns e.

func (*PacketIntervalList) PushFrontList

func (l *PacketIntervalList) PushFrontList(other *PacketIntervalList)

PushFrontList inserts a copy of an other list at the front of list l. The lists l and other may be the same. They must not be nil.

func (*PacketIntervalList) Remove

func (l *PacketIntervalList) Remove(e *PacketIntervalElement) PacketInterval

Remove removes e from l if e is an element of list l. It returns the element value e.Value. The element must not be nil.

type Timer

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

A Timer wrapper that behaves correctly when resetting

func NewTimer

func NewTimer() *Timer

NewTimer creates a new timer that is not set

func (*Timer) Chan

func (t *Timer) Chan() <-chan time.Time

Chan returns the channel of the wrapped timer

func (*Timer) Reset

func (t *Timer) Reset(deadline time.Time)

Reset the timer, no matter whether the value was read or not

func (*Timer) SetRead

func (t *Timer) SetRead()

SetRead should be called after the value from the chan was read

func (*Timer) Stop

func (t *Timer) Stop()

Stop stops the timer

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier