diff --git a/ackhandler/entropy_accumulator.go b/ackhandler/entropy_accumulator.go index f6b11aa33..98a867403 100644 --- a/ackhandler/entropy_accumulator.go +++ b/ackhandler/entropy_accumulator.go @@ -12,7 +12,7 @@ func (e *EntropyAccumulator) Add(packetNumber protocol.PacketNumber, entropyFlag } } -// Add the contribution of the entropy flag of a given packet number +// Substract the contribution of the entropy flag of a given packet number func (e *EntropyAccumulator) Substract(packetNumber protocol.PacketNumber, entropyFlag bool) { e.Add(packetNumber, entropyFlag) } diff --git a/ackhandler/interfaces.go b/ackhandler/interfaces.go index 8ac231e68..67aa803d3 100644 --- a/ackhandler/interfaces.go +++ b/ackhandler/interfaces.go @@ -25,6 +25,7 @@ type ReceivedPacketHandler interface { DequeueAckFrame() *frames.AckFrame } +// StopWaitingManager manages StopWaitings for sent packets type StopWaitingManager interface { RegisterPacketForRetransmission(packet *Packet) GetStopWaitingFrame() *frames.StopWaitingFrame diff --git a/ackhandler/packet.go b/ackhandler/packet.go index 61db3d2e6..c0db8f4bf 100644 --- a/ackhandler/packet.go +++ b/ackhandler/packet.go @@ -21,8 +21,9 @@ type Packet struct { sendTime time.Time } +// GetStreamFramesForRetransmission gets all the streamframes for retransmission func (p *Packet) GetStreamFramesForRetransmission() []*frames.StreamFrame { - streamFrames := make([]*frames.StreamFrame, 0) + var streamFrames []*frames.StreamFrame for _, frame := range p.Frames { if streamFrame, isStreamFrame := frame.(*frames.StreamFrame); isStreamFrame { streamFrames = append(streamFrames, streamFrame) @@ -31,8 +32,9 @@ func (p *Packet) GetStreamFramesForRetransmission() []*frames.StreamFrame { return streamFrames } +// GetControlFramesForRetransmission gets all the control frames for retransmission func (p *Packet) GetControlFramesForRetransmission() []frames.Frame { - controlFrames := make([]frames.Frame, 0) + var controlFrames []frames.Frame for _, frame := range p.Frames { // omit ACKs if _, isStreamFrame := frame.(*frames.StreamFrame); isStreamFrame { diff --git a/ackhandler/received_packet_handler.go b/ackhandler/received_packet_handler.go index e20fc4165..ed7fea729 100644 --- a/ackhandler/received_packet_handler.go +++ b/ackhandler/received_packet_handler.go @@ -7,6 +7,7 @@ import ( "github.com/lucas-clemente/quic-go/protocol" ) +// ErrDuplicatePacket occurres when a duplicate packet is received var ErrDuplicatePacket = errors.New("ReceivedPacketHandler: Duplicate Packet") type receivedPacketHandler struct { diff --git a/ackhandler/stop_waiting_manager.go b/ackhandler/stop_waiting_manager.go index 1a855d1fe..adbc08f66 100644 --- a/ackhandler/stop_waiting_manager.go +++ b/ackhandler/stop_waiting_manager.go @@ -20,7 +20,7 @@ func NewStopWaitingManager() StopWaitingManager { } } -// RegisterPacketForRetransmission prepares the StopWaitingFrame, if neccessary +// RegisterPacketForRetransmission prepares the StopWaitingFrame, if necessary func (h *stopWaitingManager) RegisterPacketForRetransmission(packet *Packet) { if h.currentStopWaitingFrame == nil || h.currentStopWaitingFrame.LeastUnacked <= packet.PacketNumber { // <= because for StopWaitingFrames LeastUnacked = packet.PacketNumber + 1 h.currentStopWaitingFrame = &frames.StopWaitingFrame{ diff --git a/frames/ack_frame.go b/frames/ack_frame.go index 4eefa8735..bc1f269f9 100644 --- a/frames/ack_frame.go +++ b/frames/ack_frame.go @@ -188,7 +188,7 @@ func ParseAckFrame(r *bytes.Reader) (*AckFrame, error) { } // Invalid NACK Handling: - // NACKs contain a lot of offsets that require substractions of PacketNumbers. If an ACK contains invalid data, it is possible to underflow the uint64 used to store the PacketNumber + // NACKs contain a lot of offsets that require subtractions of PacketNumbers. If an ACK contains invalid data, it is possible to underflow the uint64 used to store the PacketNumber // TODO: handle uint64 overflows if hasNACK { var numRanges uint8 diff --git a/frames/nack_range.go b/frames/nack_range.go index 455478df4..ebb1a29fb 100644 --- a/frames/nack_range.go +++ b/frames/nack_range.go @@ -13,7 +13,7 @@ func (n *NackRange) Len() uint64 { return uint64(n.LastPacketNumber) - uint64(n.FirstPacketNumber) } -// IsInRange checks if a packetNumber is contained in a NACK range +// ContainsPacketNumber checks if a packetNumber is contained in a NACK range func (n *NackRange) ContainsPacketNumber(packetNumber protocol.PacketNumber) bool { if packetNumber >= n.FirstPacketNumber && packetNumber <= n.LastPacketNumber { return true diff --git a/server.go b/server.go index c879774a6..5ba6f422b 100644 --- a/server.go +++ b/server.go @@ -11,6 +11,7 @@ import ( "github.com/lucas-clemente/quic-go/protocol" ) +// PacketHandler handles packets type PacketHandler interface { HandlePacket(addr interface{}, publicHeader *PublicHeader, r *bytes.Reader) Run() diff --git a/stream.go b/stream.go index 3cfad2ae4..6b39fcdee 100644 --- a/stream.go +++ b/stream.go @@ -17,7 +17,7 @@ type stream struct { session streamHandler streamID protocol.StreamID // The chan of unordered stream frames. A nil in this channel is sent by the - // session if an error occured, in this case, remoteErr is filled before. + // session if an error occurred, in this case, remoteErr is filled before. streamFrames chan *frames.StreamFrame currentFrame *frames.StreamFrame readPosInFrame int