lork

type ArchiveRemover interface {
	// MaxHistory sets max history for logs.
	MaxHistory(max int)

	// CleanAsync cleans logs asynchronously with given time.
	CleanAsync(now time.Time)
}

type Archiver interface {
	// Archive makes an archiver with given filename and archive filename.
	Archive(filename, archiveFilename string) error
}

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

type AsyncWriterOption struct {
	Name      string
	QueueSize int
}

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

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

type Bridge interface {
	Nameable

	// ParseLevel parses the given level string into lork level.
	ParseLevel(lvl string) Level
}

type BytesWriter interface {
	io.Writer

	Nameable

	// Encoder returns encoder used in current writer.
	Encoder() Encoder

	// Filter returns filter used in current writer.
	Filter() Filter
}

type Configurator interface {
	// Configure will configure the logger with writers and return ExecutionStatus.
	Configure(ctx *LoggerContext) ExecutionStatus
}

type ConsoleWriterOption struct {
	Name    string
	Encoder Encoder
	Filter  Filter
}

type Converter interface {
	// AttachNext attaches next converter to the chain.
	AttachNext(next Converter)

	// Next will get next converter from the chain.
	Next() Converter

	// AttachChild attaches child converter to current converter.
	AttachChild(child Converter)

	// AttachOptions attaches options to current converter.
	AttachOptions(opts []string)

	// Convert converts given data into buffer.
	Convert(origin interface{}, buf *bytes.Buffer)
}

type Encoder interface {
	// Encode encodes origin data to formatted data.
	Encode(e *LogEvent) (data []byte, err error)
}

type EventRecorder interface {
	// WriteEvent write LogEvent.
	WriteEvent(event *LogEvent) error
}

type EventWriter interface {
	Nameable

	// Write Writes given event.
	Write(event *LogEvent) error

	// Filter returns filter used in current writer.
	Filter() Filter

	// Synchronized should this writer write data synchronously or not.
	Synchronized() bool
}

type ExecutionStatus int8

type FileWriterOption struct {
	Name          string
	Encoder       Encoder
	Filter        Filter
	RollingPolicy RollingPolicy
	Filename      string
}

type Filter interface {
	// Do filters the logging. The logs will be accepted or denied according to FilterReply.
	Do(e *LogEvent) FilterReply
}

type FilterReply int8

type ILogger interface {
	Nameable

	// SetLevel sets global level for logger.
	SetLevel(lvl Level)

	// Trace logs with trace level.
	Trace() Record

	// Debug logs with debug level.
	Debug() Record

	// Info logs with info level.
	Info() Record

	// Warn logs with warn level.
	Warn() Record

	// Error logs with error level.
	Error() Record

	// Fatal logs with fatal level.
	Fatal() Record

	// Panic logs with panic level.
	Panic() Record

	// Level logs with specified level.
	Level(lvl Level) Record

	// Event writes raw logging event.
	Event(e *LogEvent)
}

type ILoggerFactory interface {
	// Logger gets a ILogger with given name
	Logger(name string) ILogger
}

type Level int8

type Lifecycle interface {
	// Start the component.
	Start()
	// Stop the component.
	Stop()
}

type LogBridgeOption struct {
	Name  string
	Level Level
}

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

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

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

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

type Nameable interface {
	// Name returns the name of this object. The name uniquely identifies the object.
	Name() string
}

type NewConverter func() Converter

type NewLogger func(name string, writer *MultiWriter) ILogger

type PatternEncoderOption struct {
	Pattern    string
	Converters map[string]NewConverter
}

type Provider interface {
	// Name the name of this provider.
	Name() string

	// Prepare prepares the provider.
	Prepare()

	// LoggerFactory gets ILoggerFactory from this provider.
	LoggerFactory() ILoggerFactory
}

type Record interface {
	// Str adds string value to this record.
	Str(key, val string) Record

	// Strs adds string array value to this record.
	Strs(key string, val []string) Record

	// Bytes adds byte array value to this record.
	Bytes(key string, val []byte) Record

	// Err adds err to this record.
	Err(err error) Record

	// Errs adds err array to this record.
	Errs(key string, errs []error) Record

	// Bool adds bool value to this record.
	Bool(key string, val bool) Record

	// Bools adds bool array value to this record.
	Bools(key string, val []bool) Record

	// Int adds int value to this record.
	Int(key string, val int) Record

	// Ints adds int array value to this record.
	Ints(key string, val []int) Record

	// Int8 adds int8 value to this record.
	Int8(key string, val int8) Record

	// Ints8 adds int8 array value to this record.
	Ints8(key string, val []int8) Record

	// Int16 adds int16 value to this record.
	Int16(key string, val int16) Record

	// Ints16 adds int16 array value to this record.
	Ints16(key string, val []int16) Record

	// Int32 adds int32 value to this record.
	Int32(key string, val int32) Record

	// Ints32 adds int32 array value to this record.
	Ints32(key string, val []int32) Record

	// Int64 adds int64 value to this record.
	Int64(key string, val int64) Record

	// Ints64 adds int64 array value to this record.
	Ints64(key string, val []int64) Record

	// Uint adds uint value to this record.
	Uint(key string, val uint) Record

	// Uints adds uint array value to this record.
	Uints(key string, val []uint) Record

	// Uint8 adds uint8 value to this record.
	Uint8(key string, val uint8) Record

	// Uints8 adds uint8 array value to this record.
	Uints8(key string, val []uint8) Record

	// Uint16 adds uint16 value to this record.
	Uint16(key string, val uint16) Record

	// Uints16 adds uint16 array value to this record.
	Uints16(key string, val []uint16) Record

	// Uint32 adds uint32 value to this record.
	Uint32(key string, val uint32) Record

	// Uints32 adds uint32 array value to this record.
	Uints32(key string, val []uint32) Record

	// Uint64 adds uint64 value to this record.
	Uint64(key string, val uint64) Record

	// Uints64 adds uint64 array value to this record.
	Uints64(key string, val []uint64) Record

	// Float32 adds float32 value to this record.
	Float32(key string, val float32) Record

	// Floats32 adds float32 array value to this record.
	Floats32(key string, val []float32) Record

	// Float64 adds float64 value to this record.
	Float64(key string, val float64) Record

	// Floats64 adds float64 array value to this record.
	Floats64(key string, val []float64) Record

	// Time adds time value to this record.
	Time(key string, val time.Time) Record

	// Times adds time array value to this record.
	Times(key string, val []time.Time) Record

	// Dur adds duration value to this record.
	Dur(key string, val time.Duration) Record

	// Durs adds duration array value to this record.
	Durs(key string, val []time.Duration) Record

	// Any adds any value to this record.
	Any(key string, val interface{}) Record

	// Msge outputs log without message
	Msge()

	// Msg adds a message to this record and output log.
	Msg(msg string)

	// Msgf adds a message with format to this record and output log.
	Msgf(format string, v ...interface{})
}

type RollingPolicy interface {
	// Prepare prepares current rolling policy
	Prepare() error

	// Attach attaches file writer.
	Attach(w *fileWriter)

	// ShouldTrigger check if there's necessary to trigger rolling.
	ShouldTrigger(fileSize int64) bool

	// Rotate does the log rolling.
	Rotate() error
}

type SizeAndTimeBasedRPOption struct {
	FilenamePattern string
	MaxFileSize     string
	MaxHistory      int
}

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

type SocketReaderOption struct {
	Path string
	Port int
}

type SocketWriterOption struct {
	Name              string
	RemoteUrl         string
	QueueSize         int
	ReconnectionDelay time.Duration
	Filter            Filter
}

type SyslogWriterOption struct {
	Name string
	Tag  string
	// See net.Dial
	Address, Network string
	Filter           Filter
}

type TimeBasedRPOption struct {
	FilenamePattern string
	MaxHistory      int
}

type Writer interface {
	Nameable

	// DoWrite this is where a writer accomplishes its work.
	// Lork will send LogEvent to this writer.
	DoWrite(event *LogEvent) error
}

type WriterAttachable interface {
	// AddWriter add one or more writer to this bucket.
	AddWriter(writers ...Writer)

	// GetWriter gets a writer with given name.
	GetWriter(name string) Writer

	// Attached check if the given writer is attached.
	Attached(writer Writer) bool

	// ResetWriter will remove and stop all writers added before.
	ResetWriter()
}