ippool

Documentation

Overview

* Copyright (c) 2022 NetLOX Inc * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

Index

• type IPGenerater
  • func InitIPGenerater(cidr string) (*IPGenerater, error)
  • func (i *IPGenerater) CheckIPAddressInSubnet(ipStr string) bool
  • func (i *IPGenerater) GetBroadcastIP() net.IP
  • func (i *IPGenerater) GetNetwork() net.IP
  • func (i *IPGenerater) NextIP() net.IP
• type IPPool
  • func NewIPPool(netCIDR string) (*IPPool, error)
  • func (i *IPPool) AssignNewIPv4() net.IP
  • func (i *IPPool) CheckSubnetAndUpdateIPPool(ip string) bool
  • func (i *IPPool) RetrieveIPv4(retrieveIP string)
  • func (i *IPPool) UpdateAllocateddIPv4(allocatedIP string)
• type IPSet
  • func NewSet() *IPSet
  • func (s *IPSet) Add(value string)
  • func (s *IPSet) Contains(value string) bool
  • func (s *IPSet) GetAll() []string
  • func (s *IPSet) IsEqual(Pair *IPSet) (isEqual bool, added, deleted IPSet)
  • func (s *IPSet) Remove(value string)

Types

type IPGenerater

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

func InitIPGenerater

func InitIPGenerater(cidr string) (*IPGenerater, error)

func (*IPGenerater) CheckIPAddressInSubnet

func (i *IPGenerater) CheckIPAddressInSubnet(ipStr string) bool

func (*IPGenerater) GetBroadcastIP

func (i *IPGenerater) GetBroadcastIP() net.IP

func (*IPGenerater) GetNetwork

func (i *IPGenerater) GetNetwork() net.IP

func (*IPGenerater) NextIP

func (i *IPGenerater) NextIP() net.IP

type IPPool

type IPPool struct {
	IPv4Generator *IPGenerater
	IPv4Pool      *IPSet
	// contains filtered or unexported fields
}

func NewIPPool

func NewIPPool(netCIDR string) (*IPPool, error)

Initailize IP Pool

func (*IPPool) AssignNewIPv4

func (i *IPPool) AssignNewIPv4() net.IP

AssignNewIPv4 generate new IP and add key(IP) in IP Pool. If IP is already in pool, try to generate next IP. Returns nil If all IPs in the subnet are already in the pool.

func (*IPPool) CheckSubnetAndUpdateIPPool

func (i *IPPool) CheckSubnetAndUpdateIPPool(ip string) bool

func (*IPPool) RetrieveIPv4

func (i *IPPool) RetrieveIPv4(retrieveIP string)

RetrieveIPv4 remove key(IP) in IP Pool

func (*IPPool) UpdateAllocateddIPv4

func (i *IPPool) UpdateAllocateddIPv4(allocatedIP string)

type IPSet

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

func NewSet

func NewSet() *IPSet

func (*IPSet) Add

func (s *IPSet) Add(value string)

func (*IPSet) Contains

func (s *IPSet) Contains(value string) bool

func (*IPSet) GetAll

func (s *IPSet) GetAll() []string

func (*IPSet) IsEqual

func (s *IPSet) IsEqual(Pair *IPSet) (isEqual bool, added, deleted IPSet)

func (*IPSet) Remove

func (s *IPSet) Remove(value string)