common

Documentation

Index

• Constants
• type Config
  • func NewConfig(log *Logger) (*Config, error)
• type Logger
  • func NewLogger() *Logger
• type Packet
  • func NewPacket(buf []byte, src syscall.Sockaddr, size int) *Packet

Constants

const (
	// EnvironmentVariablePrefix - the prefix for all nexus related configuration environment variables.
	EnvironmentVariablePrefix = "NEXUS_"

	// RollingRestart - the environment variable to signify a rolling restart
	RollingRestart = EnvironmentVariablePrefix + "ROLLING_RESTART_TRIGGER"
)

Types

type Config

type Config struct {
	ConfigFile string
	PidFile    string
	NumWorkers int
	ListenIP   string
	ListenPort int

	RollingRestart string
	ReuseFDS       bool

	ListenAddress syscall.Sockaddr
	// contains filtered or unexported fields
}

Config object for base level options

func NewConfig

func NewConfig(log *Logger) (*Config, error)

NewConfig object

type Logger

type Logger struct {
	Info  *log.Logger
	Warn  *log.Logger
	Error *log.Logger
}

Logger type to allow for a single point of logging configuration

func NewLogger

func NewLogger() *Logger

NewLogger creates a new logger based on user config.

type Packet

type Packet struct {
	Data               []byte
	Length             int
	DestinationAddress syscall.Sockaddr
	SourceAddress      syscall.Sockaddr
}

Packet object to represent a packet traversing the system

func NewPacket

func NewPacket(buf []byte, src syscall.Sockaddr, size int) *Packet

NewPacket object