Logging

Message logs. More...

Collaboration diagram for Logging:

Modules
	Logger
	Message log back-end.

Files
file	vlc_messages.h
	Logging functions.

Data Structures
struct	vlc_log_t
	Log message. More...

Macros
#define	msg_GenericVa(o, p, fmt, ap)
#define	msg_Generic(o, p, ...)
#define	msg_Info(p_this, ...)    msg_Generic(p_this, VLC_MSG_INFO, __VA_ARGS__)
#define	msg_Err(p_this, ...)    msg_Generic(p_this, VLC_MSG_ERR, __VA_ARGS__)
#define	msg_Warn(p_this, ...)    msg_Generic(p_this, VLC_MSG_WARN, __VA_ARGS__)
#define	msg_Dbg(p_this, ...)    msg_Generic(p_this, VLC_MSG_DBG, __VA_ARGS__)

Typedefs
typedef struct vlc_log_t	vlc_log_t
	Log message.

Enumerations
enum	vlc_log_type { VLC_MSG_INFO =0 , VLC_MSG_ERR , VLC_MSG_WARN , VLC_MSG_DBG }
	Message types. More...

Functions
void	vlc_object_Log (vlc_object_t *obj, int type, const char *module, const char *file, unsigned line, const char *func, const char *format,...)
	Emit a log message.
void	vlc_object_vaLog (vlc_object_t *obj, int prio, const char *module, const char *file, unsigned line, const char *func, const char *format, va_list ap)
	Emit a log message.
const char *	vlc_strerror (int)
	Formats an error message in the current locale.
const char *	vlc_strerror_c (int)
	Formats an error message in the POSIX/C locale (i.e.

Variables
const char	vlc_module_name []
void	vlc_LogSet (libvlc_int_t *, const struct vlc_logger_operations *, void *data)
	Sets the message logging callback.

Detailed Description

Message logs.

Functions for modules to emit log messages.

Macro Definition Documentation

msg_Dbg

#define msg_Dbg	(		p_this,
			...
	)		msg_Generic(p_this, VLC_MSG_DBG, __VA_ARGS__)

msg_Err

#define msg_Err	(		p_this,
			...
	)		msg_Generic(p_this, VLC_MSG_ERR, __VA_ARGS__)

msg_Generic

#define msg_Generic	(		o,
			p,
			...
	)

Value:

    vlc_object_Log(VLC_OBJECT(o), p, vlc_module_name, __FILE__, __LINE__, \
                   __func__, __VA_ARGS__)

msg_GenericVa

#define msg_GenericVa	(		o,
			p,
			fmt,
			ap
	)

Value:

    vlc_object_vaLog(VLC_OBJECT(o), p, vlc_module_name, __FILE__, __LINE__, \
                     __func__, fmt, ap)

msg_Info

#define msg_Info	(		p_this,
			...
	)		msg_Generic(p_this, VLC_MSG_INFO, __VA_ARGS__)

msg_Warn

#define msg_Warn	(		p_this,
			...
	)		msg_Generic(p_this, VLC_MSG_WARN, __VA_ARGS__)

Typedef Documentation

vlc_log_t

typedef struct vlc_log_t vlc_log_t

Log message.

Enumeration Type Documentation

vlc_log_type

enum vlc_log_type

Message types.

Enumerator
VLC_MSG_INFO	Important information.
VLC_MSG_ERR	Error.
VLC_MSG_WARN	Warning.
VLC_MSG_DBG	Debug.

Function Documentation

vlc_LogSet()

void vlc_LogSet	(	libvlc_int_t *	vlc,
		const struct vlc_logger_operations *	ops,
		void *	opaque
	)

Sets the message logging callback.

Parameters

vlc	the libvlc private instance to replace the logger for
ops	message callback, or NULL to clear
opaque	data pointer for the message callback

References discard_log, vlc_logger::ops, vlc_LogExternalCreate(), vlc_LogSpam(), vlc_LogSwitch(), and VLC_OBJECT.

vlc_object_Log()

void vlc_object_Log	(	vlc_object_t *	obj,
		int	type,
		const char *	module,
		const char *	file,
		unsigned	line,
		const char *	func,
		const char *	format,
			...
	)

Emit a log message.

Parameters

obj	VLC object emitting the message or NULL
type	VLC_MSG_* message type (info, error, warning or debug)
module	name of module from which the message come (normally vlc_module_name)
file	source module file name (normally FILE) or NULL
line	function call source line number (normally LINE) or 0
func	calling function name (normally func) or NULL
format	printf-like message format

References vlc_object_vaLog().

vlc_object_vaLog()

void vlc_object_vaLog	(	vlc_object_t *	obj,
		int	prio,
		const char *	module,
		const char *	file,
		unsigned	line,
		const char *	func,
		const char *	format,
		va_list	ap
	)

Emit a log message.

This function is the variable argument list equivalent to vlc_object_Log().

References vlc_object_t::logger, vlc_object_typename(), and vlc_vaLog().

Referenced by vlc_object_Log().

vlc_strerror()

const char * vlc_strerror

(

int

errnum

)

Formats an error message in the current locale.

Parameters

errnum

error number (as in errno.h)

Returns

A string pointer, valid until the next call to a function of the strerror() family in the same thread. This function cannot fail.

References vlc_strerror_c(), and vlc_strerror_l().

vlc_strerror_c()

const char * vlc_strerror_c

(

int

errnum

)

Formats an error message in the POSIX/C locale (i.e.

American English).

Parameters

errnum

error number (as in errno.h)

Returns

A string pointer, valid until the next call to a function of the strerror() family in the same thread. This function cannot fail.

References _, wsaerrmsg_t::msg, vlc_strerror_l(), and wsaerrmsg.

Referenced by config_CreateDir(), config_LoadConfigFile(), config_OpenConfigFile(), config_SaveConfigFile(), httpdLoop(), ImageWriteUrl(), input_SaveArt(), libvlc_InternalCleanup(), net_Accept(), net_Connect(), net_ConnectDgram(), net_Listen(), net_ListenSingle(), net_OpenDgram(), net_Read(), net_SetMcastHopLimit(), net_SetMcastOut(), net_SetupDgramSocket(), net_Socket(), net_SourceSubscribe(), net_Subscribe(), net_Write(), OpenURL(), rtp_dgram_thread(), vlc_h1_request(), vlc_playlist_Export(), vlc_stream_ReadLine(), vlc_strerror(), vlc_thread_fatal_print(), vlc_tls_SocketOpenTCP(), and vlc_tls_SocketOpenTLS().

Variable Documentation

vlc_module_name

const char vlc_module_name[]

extern