checksum

Documentation

Overview

Package checksum provides the implementation of the encoding and decoding of network protocol headers.

Index

• Constants
• func Checksum(buf []byte, initial uint16) uint16
• func Combine(a, b uint16) uint16
• func Put(b []byte, xsum uint16)
• type Checksumer
  • func (c *Checksumer) Add(b []byte)
  • func (c *Checksumer) Checksum() uint16

Constants

const Size = 2

Size is the size of a checksum.

The checksum is held in a uint16 which is 2 bytes.

Functions

func Checksum

func Checksum(buf []byte, initial uint16) uint16

Checksum calculates the checksum (as defined in RFC 1071) of the bytes in the given byte array. This function uses an optimized version of the checksum algorithm.

The initial checksum must have been computed on an even number of bytes.

func Combine

func Combine(a, b uint16) uint16

Combine combines the two uint16 to form their checksum. This is done by adding them and the carry.

Note that checksum a must have been computed on an even number of bytes.

func Put

func Put(b []byte, xsum uint16)

Put puts the checksum in the provided byte slice.

Types

type Checksumer

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

Checksumer calculates checksum defined in RFC 1071.

func (*Checksumer) Add

func (c *Checksumer) Add(b []byte)

Add adds b to checksum.

func (*Checksumer) Checksum

func (c *Checksumer) Checksum() uint16

Checksum returns the latest checksum value.