common

package

v0.9.2 Latest Latest Go to latest Published: Dec 12, 2019 License: BSD-3-Clause Imports: 6 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/intel-go/nff-go

Links

Open Source Insights

Documentation ¶

Overview ¶

Package common is used for combining common functions from other packages which aren't connected with C language part

Index ¶

Constants
func GetDPDKLogLevel() string
func GetDefaultCPUs(cpuNumber int) []int
func HandleCPUList(s string, maxcpu int) ([]int, error)
func LogDebug(logType LogType, v ...interface{})
func LogDrop(logType LogType, v ...interface{})
func LogError(logType LogType, v ...interface{}) string
func LogFatal(logType LogType, v ...interface{})
func LogFatalf(logType LogType, format string, v ...interface{})
func LogTitle(logType LogType, v ...interface{})
func LogWarning(logType LogType, v ...interface{})
func SetLogType(logType LogType)
func WrapWithNFError(err error, message string, code ErrorCode) error
type ErrorCode
- func GetNFErrorCode(err error) ErrorCode
type LogType
type NFError
- func GetNFError(err error) (nferr *NFError)
- func (err *NFError) Cause() error
- func (err NFError) Error() string
- func (err *NFError) Format(s fmt.State, verb rune)
type RXTXStats

Constants ¶

View Source

const (
	// No - no output even after fatal errors
	No LogType = 1 << iota
	// Initialization - output during system initialization
	Initialization = 2
	// Debug - output during execution one time per time period (scheduler ticks)
	Debug = 4
	// Verbose - output during execution as soon as something happens. Can influence performance
	Verbose = 8
)

Variables ¶

This section is empty.

Functions ¶

func GetDPDKLogLevel ¶

func GetDPDKLogLevel() string

GetDPDKLogLevel internal, used in flow package

func GetDefaultCPUs ¶

func GetDefaultCPUs(cpuNumber int) []int

GetDefaultCPUs returns default core list {0, 1, ..., NumCPU}

func HandleCPUList ¶

func HandleCPUList(s string, maxcpu int) ([]int, error)

HandleCPUs parses cpu list string into array of valid core numbers. Removes duplicates

func LogFatalf ¶

func LogFatalf(logType LogType, format string, v ...interface{})

LogFatalf is a wrapper at LogFatal which makes formatting before logger.

func LogWarning ¶

func LogWarning(logType LogType, v ...interface{})

LogWarning internal, used in all packages

func SetLogType ¶

func SetLogType(logType LogType)

SetLogType internal, used in flow package

func WrapWithNFError ¶

func WrapWithNFError(err error, message string, code ErrorCode) error

WrapWithNFError returns an error annotating err with a stack trace at the point WrapWithNFError is called, and the next our NFError. If err is nil, Wrap returns nil.

Types ¶

func GetNFErrorCode ¶

func GetNFErrorCode(err error) ErrorCode

GetNFErrorCode returns value of cCode field if err is NFError or pointer to it and -1 otherwise.

type LogType ¶

type LogType uint8

LogType - type of logging, used in flow package

type NFError ¶

type NFError struct {
	Code     ErrorCode
	Message  string
	CauseErr error
}

NFError is error type returned by nff-go functions

func GetNFError ¶

func GetNFError(err error) (nferr *NFError)

GetNFError if error is NFerror or pointer to int returns pointer to NFError, otherwise returns nil.

func (*NFError) Cause ¶

func (err *NFError) Cause() error

Cause returns the underlying cause of error, if possible. If not, returns err itself.

func (NFError) Error ¶

func (err NFError) Error() string

Error method to implement error interface

func (*NFError) Format ¶

func (err *NFError) Format(s fmt.State, verb rune)

Format makes formatted printing of errors, the following verbs are supported: %s, %v print the error. If the error has a Cause it will be printed recursively %+v - extended format. Each Frame of the error's StackTrace will be printed in detail if possible.

type RXTXStats ¶ added in v0.8.0

type RXTXStats struct {
	PacketsProcessed, PacketsDropped, BytesProcessed uint64
}

RXTXStats describes statistics for sender or receiver flow function node.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL