ipv6/icmp.go

// Copyright 2013 The Go Authors.  All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package ipv6

import (
	"sync"

	"golang.org/x/net/internal/iana"
)

// An ICMPType represents a type of ICMP message.
type ICMPType int

func (typ ICMPType) String() string {
	s, ok := icmpTypes[typ]
	if !ok {
		return "<nil>"
	}
	return s
}

// Protocol returns the ICMPv6 protocol number.
func (typ ICMPType) Protocol() int {
	return iana.ProtocolIPv6ICMP
}

// An ICMPFilter represents an ICMP message filter for incoming
// packets.
type ICMPFilter struct {
	mu sync.RWMutex
	sysICMPv6Filter
}

// Set sets the ICMP type and filter action to the filter.
func (f *ICMPFilter) Set(typ ICMPType, block bool) {
	f.mu.Lock()
	f.set(typ, block)
	f.mu.Unlock()
}

// SetAll sets the filter action to the filter.
func (f *ICMPFilter) SetAll(block bool) {
	f.mu.Lock()
	f.setAll(block)
	f.mu.Unlock()
}

// WillBlock reports whether the ICMP type will be blocked.
func (f *ICMPFilter) WillBlock(typ ICMPType) bool {
	f.mu.RLock()
	ok := f.willBlock(typ)
	f.mu.RUnlock()
	return ok
}