nod

README

nod

Documentation

Index

• Constants
• func Begin(format string, d ...interface{}) *activity
• func DisableOutput(output string)
• func EnableFileLogger(dir string) (io.Closer, error)
• func EnableOutput(output string)
• func EnableStdErrLogger()
• func EnableStdOutPresenter()
• func Error(err error) error
• func ErrorStr(format string, d ...interface{}) string
• func HandleFunc(handler Handler, output string)
• func Increment(tpw TotalProgressWriter)
• func Log(format string, d ...interface{})
• func QueueBegin(format string, d ...interface{}) *queue
• func RequestLog(h http.Handler) http.Handler
• func TotalInt(tpw TotalProgressWriter, total int)
• type ActCloser
• type Handler
• type MessageType
  • func (mt MessageType) String() string
• type Queue
• type TotalProgressWriter
  • func NewProgress(format string, d ...interface{}) TotalProgressWriter

Constants

const (
	StdOut  = "stdout"
	StdErr  = "stderr"
	FileLog = "file_log"
)

const (
	TimeFormat = "2006-01-02-15-04-05"
)

Functions

func Begin

func Begin(format string, d ...interface{}) *activity

func DisableOutput

func DisableOutput(output string)

func EnableFileLogger

func EnableFileLogger(dir string) (io.Closer, error)

func EnableOutput

func EnableOutput(output string)

func EnableStdErrLogger

func EnableStdErrLogger()

func EnableStdOutPresenter

func EnableStdOutPresenter()

func Error

func Error(err error) error

func ErrorStr

func ErrorStr(format string, d ...interface{}) string

func HandleFunc

func HandleFunc(handler Handler, output string)

func Increment

func Increment(tpw TotalProgressWriter)

func Log

func Log(format string, d ...interface{})

func QueueBegin

func QueueBegin(format string, d ...interface{}) *queue

func RequestLog

func RequestLog(h http.Handler) http.Handler

RequestLog is a trivial logging middleware that logs the URL of the request

func TotalInt

func TotalInt(tpw TotalProgressWriter, total int)

Types

type ActCloser

type ActCloser interface {
	Log(string, ...interface{})
	End()
	Error(error)
	EndWithResult(string, ...interface{})
	EndWithError(error) error
	EndWithSummary(string, map[string][]string)
}

type Handler

type Handler interface {
	Handle(msgType MessageType, payload interface{}, topic string)
	Close() error
}

type MessageType

type MessageType int

const (
	//MsgNone is a message type initial value. No payload
	MsgNone MessageType = iota
	//MsgBegin signals start of an activity. No payload
	MsgBegin
	//MsgError provides not-fatal error that happened during activity execution. Payload: error
	MsgError
	//MsgTotal sets expected total value of an activity progress. Payload: uint64
	MsgTotal
	//MsgCurrent updates current value of an activity progress. Payload: uint64
	MsgCurrent
	//MsgLog sends a value useful for logging. Payload: string
	MsgLog
	//MsgResult provides result of an activity. Payload type: string
	MsgResult
	//MsgSummary provides map of categorized results. Payload: headingSections
	MsgSummary
	//MsgEnd signals completion of an activity. No payload
	MsgEnd
)

func (MessageType) String

func (mt MessageType) String() string

type Queue

type Queue interface {
	Flush()
	Discard()
}

type TotalProgressWriter

type TotalProgressWriter interface {
	Total(uint64)
	Current(uint64)
	Progress(uint64)
	TotalInt(int)
	CurrentInt(int)
	ProgressInt(int)
	Increment()
	io.Writer
	ActCloser
}

func NewProgress

func NewProgress(format string, d ...interface{}) TotalProgressWriter