loxilib

README

What is loxilib

loxilib is a standalone golang package providing utility routines like lpm, networking utils, counters, logging etc. Originally designed to work only with loxilb, it can now be used with any golang project. It exports functionality not found usually in other standard golang packages.

Documentation

Index

• Constants
• Variables
• func CountAllSetBitsInArr(arr []uint8) int
• func CountSetBitsInArr(arr []uint8, bPos int) int
• func HTTPProber(urls string) bool
• func Htonl(i uint32) uint32
• func Htons(i uint16) uint16
• func IPtonl(ip net.IP) uint32
• func IsBitSetInArr(arr []uint8, bPos int) bool
• func L4ServiceProber(sType string, sName string) bool
• func LogIt(l LogLevelT, format string, v ...interface{})
• func LogItInit(logFile string, logLevel LogLevelT, toTTY bool)
• func NltoIP(addr uint32) net.IP
• func Ntohl(i uint32) uint32
• func Ntohs(i uint16) uint16
• func SetBitInArr(arr []uint8, bPos int)
• func UnSetBitInArr(arr []uint8, bPos int)
• type Counter
  • func NewCounter(begin int, length int) *Counter
  • func (C *Counter) GetCounter() (int, error)
  • func (C *Counter) PutCounter(id int) error
• type LogLevelT
• type TrieData
• type TrieIterIntf
• type TrieRoot
  • func TrieInit(v6 bool) *TrieRoot
  • func (t *TrieRoot) AddTrie(cidr string, data TrieData) int
  • func (t *TrieRoot) DelTrie(cidr string) int
  • func (t *TrieRoot) FindTrie(IP string) (int, *net.IPNet, TrieData)
  • func (t *TrieRoot) Trie2String(tf TrieIterIntf)

Constants

const (
	TrieSuccess = -iota
	TrieErrGeneric
	TrieErrExists
	TrieErrNoEnt
	TrieErrNoMem
	TrieErrUnknown
	TrieErrPrefix
)

return codes

const (
	TrieJmpLength   = 8
	PrefixArrLenfth = (1 << (TrieJmpLength + 1)) - 1
	PrefixArrNbits  = ((PrefixArrLenfth + TrieJmpLength) & ^TrieJmpLength) / TrieJmpLength
	PtrArrLength    = (1 << TrieJmpLength)
	PtrArrNBits     = ((PtrArrLength + TrieJmpLength) & ^TrieJmpLength) / TrieJmpLength
)

constants

Variables

var (
	LogTTY       bool
	CurrLogLevel LogLevelT
	LogItEmer    *log.Logger
	LogItAlert   *log.Logger
	LogItCrit    *log.Logger
	LogItErr     *log.Logger
	LogItWarn    *log.Logger
	LogItNotice  *log.Logger
	LogItInfo    *log.Logger
	LogItDebug   *log.Logger
)

variables used

Functions

func CountAllSetBitsInArr

func CountAllSetBitsInArr(arr []uint8) int

CountAllSetBitsInArr - count set bits in an array of uint8

func CountSetBitsInArr

func CountSetBitsInArr(arr []uint8, bPos int) int

CountSetBitsInArr - count set bits in an array of uint8 from bPos

func HTTPProber

func HTTPProber(urls string) bool

HTTPProber - Do a http probe for given url returns true/false depending on whether probing was successful

func Htonl

func Htonl(i uint32) uint32

Htonl - Host to network byte-order long

func Htons

func Htons(i uint16) uint16

Htons - Host to network byte-order short

func IPtonl

func IPtonl(ip net.IP) uint32

IPtonl - Convert net.IP to network byte-order long

func IsBitSetInArr

func IsBitSetInArr(arr []uint8, bPos int) bool

IsBitSetInArr - check given bPos bit is set in the array

func L4ServiceProber

func L4ServiceProber(sType string, sName string) bool

L4ServiceProber - Do a probe for L4 service end-points sType is "tcp" or "udp" sName is end-point IP address in string format returns true/false depending on whether probing was successful

func LogIt

func LogIt(l LogLevelT, format string, v ...interface{})

LogIt uses Printf format internally Arguments are considered in-line with fmt.Printf.

func LogItInit

func LogItInit(logFile string, logLevel LogLevelT, toTTY bool)

LogItInit - Initialize the logger logFile - name of the logfile logLevel - specify current loglevel toTTY - specify if logs need to be redirected to TTY as well or not

func NltoIP

func NltoIP(addr uint32) net.IP

NltoIP - Convert network byte-order long to net.IP

func Ntohl

func Ntohl(i uint32) uint32

Ntohl - Network to host byte-order long

func Ntohs

func Ntohs(i uint16) uint16

Ntohs - Network to host byte-order short

func SetBitInArr

func SetBitInArr(arr []uint8, bPos int)

SetBitInArr - set bPos bit in the array

func UnSetBitInArr

func UnSetBitInArr(arr []uint8, bPos int)

UnSetBitInArr - unset bPos bit in the array

Types

type Counter

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

Counter - context container

func NewCounter

func NewCounter(begin int, length int) *Counter

NewCounter - Allocate a set of counters

func (*Counter) GetCounter

func (C *Counter) GetCounter() (int, error)

GetCounter - Get next available counter

func (*Counter) PutCounter

func (C *Counter) PutCounter(id int) error

PutCounter - Return a counter to the available list

type LogLevelT

type LogLevelT int

LogLevelT - Current log-level

const (
	LogEmerg LogLevelT = iota
	LogAlert
	LogCritical
	LogError
	LogWarning
	LogNotice
	LogInfo
	LogDebug
)

Log levels

type TrieData

type TrieData interface {
}

TrieData - Any user data to be associated with a trie node

type TrieIterIntf

type TrieIterIntf interface {
	TrieNodeWalker(b string)
	TrieData2String(d TrieData) string
}

TrieIterIntf - Interface implementation needed for trie users to traverse and convert data

type TrieRoot

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

TrieRoot - root of a trie data structure

func TrieInit

func TrieInit(v6 bool) *TrieRoot

TrieInit - Initialize a trie root

func (*TrieRoot) AddTrie

func (t *TrieRoot) AddTrie(cidr string, data TrieData) int

AddTrie - Add a trie entry cidr is the route in cidr format and data is any user-defined data returns 0 on success or non-zero error code on error

func (*TrieRoot) DelTrie

func (t *TrieRoot) DelTrie(cidr string) int

DelTrie - Delete a trie entry cidr is the route in cidr format returns 0 on success or non-zero error code on error

func (*TrieRoot) FindTrie

func (t *TrieRoot) FindTrie(IP string) (int, *net.IPNet, TrieData)

FindTrie - Lookup matching route as per longest prefix match IP is the IP address in string format returns the following : 1. 0 on success or non-zero error code on error 2. matching route in *net.IPNet form 3. user-defined data associated with the trie entry

func (*TrieRoot) Trie2String

func (t *TrieRoot) Trie2String(tf TrieIterIntf)

Trie2String - stringify the trie table