package logging

Import Path
	github.com/pion/logging (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 21 packages

Involved Source Files

	  d logger.go
		Package logging provides the logging library used by Pion

	    scoped.go
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type DefaultLeveledLogger (struct)
		DefaultLeveledLogger encapsulates functionality for providing logging at.
		user-defined levels.

		Methods (total 17)
			(*DefaultLeveledLogger) Debug(msg string)
				Debug emits the preformatted message if the logger is at or below LogLevelDebug.

			(*DefaultLeveledLogger) Debugf(format string, args ...interface{})
				Debugf formats and emits a message if the logger is at or below LogLevelDebug.

			(*DefaultLeveledLogger) Error(msg string)
				Error emits the preformatted message if the logger is at or below LogLevelError.

			(*DefaultLeveledLogger) Errorf(format string, args ...interface{})
				Errorf formats and emits a message if the logger is at or below LogLevelError.

			(*DefaultLeveledLogger) Info(msg string)
				Info emits the preformatted message if the logger is at or below LogLevelInfo.

			(*DefaultLeveledLogger) Infof(format string, args ...interface{})
				Infof formats and emits a message if the logger is at or below LogLevelInfo.

			(*DefaultLeveledLogger) SetLevel(newLevel LogLevel)
				SetLevel sets the logger's logging level.

			(*DefaultLeveledLogger) Trace(msg string)
				Trace emits the preformatted message if the logger is at or below LogLevelTrace.

			(*DefaultLeveledLogger) Tracef(format string, args ...interface{})
				Tracef formats and emits a message if the logger is at or below LogLevelTrace.

			(*DefaultLeveledLogger) Warn(msg string)
				Warn emits the preformatted message if the logger is at or below LogLevelWarn.

			(*DefaultLeveledLogger) Warnf(format string, args ...interface{})
				Warnf formats and emits a message if the logger is at or below LogLevelWarn.

			(*DefaultLeveledLogger) WithDebugLogger(log *log.Logger) *DefaultLeveledLogger
				WithDebugLogger is a chainable configuration function which sets the
				Debug-level logger.

			(*DefaultLeveledLogger) WithErrorLogger(log *log.Logger) *DefaultLeveledLogger
				WithErrorLogger is a chainable configuration function which sets the
				Error-level logger.

			(*DefaultLeveledLogger) WithInfoLogger(log *log.Logger) *DefaultLeveledLogger
				WithInfoLogger is a chainable configuration function which sets the
				Info-level logger.

			(*DefaultLeveledLogger) WithOutput(output io.Writer) *DefaultLeveledLogger
				WithOutput is a chainable configuration function which sets the logger's
				logging output to the supplied io.Writer.

			(*DefaultLeveledLogger) WithTraceLogger(log *log.Logger) *DefaultLeveledLogger
				WithTraceLogger is a chainable configuration function which sets the
				Trace-level logger.

			(*DefaultLeveledLogger) WithWarnLogger(log *log.Logger) *DefaultLeveledLogger
				WithWarnLogger is a chainable configuration function which sets the
				Warn-level logger.

		Implements (at least 2)
			*DefaultLeveledLogger : LeveledLogger
			*DefaultLeveledLogger : github.com/stretchr/testify/assert.TestingT
		As Outputs Of (at least 7)
			func NewDefaultLeveledLoggerForScope(scope string, level LogLevel, writer io.Writer) *DefaultLeveledLogger
			func (*DefaultLeveledLogger).WithDebugLogger(log *log.Logger) *DefaultLeveledLogger
			func (*DefaultLeveledLogger).WithErrorLogger(log *log.Logger) *DefaultLeveledLogger
			func (*DefaultLeveledLogger).WithInfoLogger(log *log.Logger) *DefaultLeveledLogger
			func (*DefaultLeveledLogger).WithOutput(output io.Writer) *DefaultLeveledLogger
			func (*DefaultLeveledLogger).WithTraceLogger(log *log.Logger) *DefaultLeveledLogger
			func (*DefaultLeveledLogger).WithWarnLogger(log *log.Logger) *DefaultLeveledLogger

	 type DefaultLoggerFactory (struct)
		DefaultLoggerFactory define levels by scopes and creates new DefaultLeveledLogger.

		Fields (total 3)
			DefaultLogLevel LogLevel
			ScopeLevels map[string]LogLevel
			Writer io.Writer
		Methods (only one)
			(*DefaultLoggerFactory) NewLogger(scope string) LeveledLogger
				NewLogger returns a configured LeveledLogger for the given, argsscope.

		Implements (at least one exported)
			*DefaultLoggerFactory : LoggerFactory
		As Outputs Of (at least one exported)
			func NewDefaultLoggerFactory() *DefaultLoggerFactory

	 type LeveledLogger (interface)
		LeveledLogger is the basic pion Logger interface.

		Methods (total 10)
			( LeveledLogger) Debug(msg string)
			( LeveledLogger) Debugf(format string, args ...interface{})
			( LeveledLogger) Error(msg string)
			( LeveledLogger) Errorf(format string, args ...interface{})
			( LeveledLogger) Info(msg string)
			( LeveledLogger) Infof(format string, args ...interface{})
			( LeveledLogger) Trace(msg string)
			( LeveledLogger) Tracef(format string, args ...interface{})
			( LeveledLogger) Warn(msg string)
			( LeveledLogger) Warnf(format string, args ...interface{})
		Implemented By (at least one exported)
			*DefaultLeveledLogger
		Implements (at least one exported)
			 LeveledLogger : github.com/stretchr/testify/assert.TestingT
		As Outputs Of (at least 2)
			func (*DefaultLoggerFactory).NewLogger(scope string) LeveledLogger
			func LoggerFactory.NewLogger(scope string) LeveledLogger
		As Inputs Of (at least 12)
			func github.com/pion/ice/v4.UDPMuxFromPortWithLogger(logger LeveledLogger) ice.UDPMuxFromPortOption
			func github.com/pion/interceptor/pkg/nack.GeneratorLog(log LeveledLogger) nack.GeneratorOption
			func github.com/pion/interceptor/pkg/nack.ResponderLog(log LeveledLogger) nack.ResponderOption
			func github.com/pion/interceptor/pkg/report.ReceiverLog(log LeveledLogger) report.ReceiverOption
			func github.com/pion/interceptor/pkg/report.SenderLog(log LeveledLogger) report.SenderOption
			func github.com/pion/turn/v4.LongTermTURNRESTAuthHandler(sharedSecret string, logger LeveledLogger) turn.AuthHandler
			func github.com/pion/turn/v4.NewLongTermAuthHandler(sharedSecret string, logger LeveledLogger) turn.AuthHandler
			func github.com/pion/turn/v4/internal/allocation.NewAllocation(turnSocket net.PacketConn, fiveTuple *allocation.FiveTuple, log LeveledLogger) *allocation.Allocation
			func github.com/pion/turn/v4/internal/allocation.NewChannelBind(number proto.ChannelNumber, peer net.Addr, log LeveledLogger) *allocation.ChannelBind
			func github.com/pion/turn/v4/internal/allocation.NewPermission(addr net.Addr, log LeveledLogger) *allocation.Permission
			func github.com/pion/webrtc/v4.NewICETCPMux(logger LeveledLogger, listener net.Listener, readBufferSize int) ice.TCPMux
			func github.com/pion/webrtc/v4.NewICEUDPMux(logger LeveledLogger, udpConn net.PacketConn) ice.UDPMux

	 type LoggerFactory (interface)
		LoggerFactory is the basic pion LoggerFactory interface.

		Methods (only one)
			( LoggerFactory) NewLogger(scope string) LeveledLogger
		Implemented By (at least one exported)
			*DefaultLoggerFactory
		As Inputs Of (at least one exported)
			func github.com/pion/webrtc/v4.NewICETransport(gatherer *webrtc.ICEGatherer, loggerFactory LoggerFactory) *webrtc.ICETransport

	 type LogLevel int32 (basic type)
		LogLevel represents the level at which the logger will emit log messages.

		Methods (total 3)
			(*LogLevel) Get() LogLevel
				Get retrieves the current LogLevel value.

			(*LogLevel) Set(newLevel LogLevel)
				Set updates the LogLevel to the supplied value.

			( LogLevel) String() string
		Implements (at least 2)
			 LogLevel : expvar.Var
			 LogLevel : fmt.Stringer
		As Outputs Of (at least one exported)
			func (*LogLevel).Get() LogLevel
		As Inputs Of (at least 3)
			func NewDefaultLeveledLoggerForScope(scope string, level LogLevel, writer io.Writer) *DefaultLeveledLogger
			func (*DefaultLeveledLogger).SetLevel(newLevel LogLevel)
			func (*LogLevel).Set(newLevel LogLevel)
		As Types Of (total 6)
			const LogLevelDebug
			const LogLevelDisabled
			const LogLevelError
			const LogLevelInfo
			const LogLevelTrace
			const LogLevelWarn


Package-Level Functions (total 2)

	 func NewDefaultLeveledLoggerForScope(scope string, level LogLevel, writer io.Writer) *DefaultLeveledLogger
		NewDefaultLeveledLoggerForScope returns a configured LeveledLogger.

	 func NewDefaultLoggerFactory() *DefaultLoggerFactory
		NewDefaultLoggerFactory creates a new DefaultLoggerFactory.


Package-Level Constants (total 6)

	const LogLevelDebug LogLevel = 4
		LogLevelDebug is for logging low-level library information (e.g. internal operations).

	const LogLevelDisabled LogLevel = 0
		LogLevelDisabled completely disables logging of any events.

	const LogLevelError LogLevel = 1
		LogLevelError is for fatal errors which should be handled by user code,
		but are logged to ensure that they are seen.

	const LogLevelInfo LogLevel = 3
		LogLevelInfo is for logging normal library operation (e.g. state transitions, etc.).

	const LogLevelTrace LogLevel = 5
		LogLevelTrace is for logging very low-level library information (e.g. network traces).

	const LogLevelWarn LogLevel = 2
		LogLevelWarn is for logging abnormal, but non-fatal library operation.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.