summaryrefslogtreecommitdiffhomepage
path: root/pkg/tcpip/header/ipv4.go
diff options
context:
space:
mode:
authorEyal Soha <eyalsoha@google.com>2020-03-12 18:38:41 -0700
committergVisor bot <gvisor-bot@google.com>2020-03-12 18:39:40 -0700
commitf693e1334b6fd0bea26fad770dfec3aa7e03c59a (patch)
tree2255b56372a857251c31b2e4b864a9c0f62b5b09 /pkg/tcpip/header/ipv4.go
parentbbf86003bfd2a7547744b89c72e1cd06e9385e66 (diff)
Clarify comments about IHL in ipv4.go.
PiperOrigin-RevId: 300668506
Diffstat (limited to 'pkg/tcpip/header/ipv4.go')
-rw-r--r--pkg/tcpip/header/ipv4.go5
1 files changed, 3 insertions, 2 deletions
diff --git a/pkg/tcpip/header/ipv4.go b/pkg/tcpip/header/ipv4.go
index e5360e7c1..76839eb92 100644
--- a/pkg/tcpip/header/ipv4.go
+++ b/pkg/tcpip/header/ipv4.go
@@ -38,7 +38,8 @@ const (
// IPv4Fields contains the fields of an IPv4 packet. It is used to describe the
// fields of a packet that needs to be encoded.
type IPv4Fields struct {
- // IHL is the "internet header length" field of an IPv4 packet.
+ // IHL is the "internet header length" field of an IPv4 packet. The value
+ // is in bytes.
IHL uint8
// TOS is the "type of service" field of an IPv4 packet.
@@ -138,7 +139,7 @@ func IPVersion(b []byte) int {
}
// HeaderLength returns the value of the "header length" field of the ipv4
-// header.
+// header. The length returned is in bytes.
func (b IPv4) HeaderLength() uint8 {
return (b[versIHL] & 0xf) * 4
}