fakeip

Documentation

Index

• type Options
• type Pool
  • func New(options Options) (*Pool, error)
  • func (p *Pool) Broadcast() netip.Addr
  • func (p *Pool) CloneFrom(o *Pool)
  • func (p *Pool) Exist(ip netip.Addr) bool
  • func (p *Pool) FlushFakeIP() error
  • func (p *Pool) Gateway() netip.Addr
  • func (p *Pool) IPNet() *netip.Prefix
  • func (p *Pool) LookBack(ip netip.Addr) (string, bool)
  • func (p *Pool) Lookup(host string) netip.Addr
  • func (p *Pool) ShouldSkipped(domain string) bool
  • func (p *Pool) StoreState()

Types

type Options

type Options struct {
	IPNet *netip.Prefix
	Host  *trie.DomainTrie[struct{}]

	// Size sets the maximum number of entries in memory
	// and does not work if Persistence is true
	Size int

	// Persistence will save the data to disk.
	// Size will not work and record will be fully stored.
	Persistence bool
}

type Pool

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

Pool is an implementation about fake ip generator without storage

func New

func New(options Options) (*Pool, error)

New return Pool instance

func (*Pool) Broadcast

func (p *Pool) Broadcast() netip.Addr

Broadcast return the last ip

func (*Pool) CloneFrom

func (p *Pool) CloneFrom(o *Pool)

CloneFrom clone cache from old pool

func (*Pool) Exist

func (p *Pool) Exist(ip netip.Addr) bool

Exist returns if given ip exists in fake-ip pool

func (*Pool) FlushFakeIP

func (p *Pool) FlushFakeIP() error

func (*Pool) Gateway

func (p *Pool) Gateway() netip.Addr

Gateway return gateway ip

func (*Pool) IPNet

func (p *Pool) IPNet() *netip.Prefix

IPNet return raw ipnet

func (*Pool) LookBack

func (p *Pool) LookBack(ip netip.Addr) (string, bool)

LookBack return host with the fake ip

func (*Pool) Lookup

func (p *Pool) Lookup(host string) netip.Addr

Lookup return a fake ip with host

func (*Pool) ShouldSkipped

func (p *Pool) ShouldSkipped(domain string) bool

ShouldSkipped return if domain should be skipped

func (*Pool) StoreState

func (p *Pool) StoreState()