libvlc_log
[libvlc, libvlc_core]

Collaboration diagram for libvlc_log:

LibVLC Message Logging. More...

Data Structures
struct	libvlc_log_message_t
Typedefs
typedef struct libvlc_log_t	libvlc_log_t
	This structure is opaque.
typedef struct libvlc_log_iterator_t	libvlc_log_iterator_t
	This structure is opaque.
Functions
unsigned	libvlc_get_log_verbosity (const libvlc_instance_t *p_instance)
	Return the VLC messaging verbosity level.
void	libvlc_set_log_verbosity (libvlc_instance_t *p_instance, unsigned level)
	Set the VLC messaging verbosity level.
libvlc_log_t *	libvlc_log_open (libvlc_instance_t *, libvlc_exception_t *)
	Open a VLC message log instance.
void	libvlc_log_close (libvlc_log_t *p_log)
	Close a VLC message log instance.
unsigned	libvlc_log_count (const libvlc_log_t *p_log)
	Returns the number of messages in a log instance.
void	libvlc_log_clear (libvlc_log_t *p_log)
	Clear a log instance.
libvlc_log_iterator_t *	libvlc_log_get_iterator (const libvlc_log_t *, libvlc_exception_t *)
	Allocate and returns a new iterator to messages in log.
void	libvlc_log_iterator_free (libvlc_log_iterator_t *p_iter)
	Release a previoulsy allocated iterator.
int	libvlc_log_iterator_has_next (const libvlc_log_iterator_t *p_iter)
	Return whether log iterator has more messages.
libvlc_log_message_t *	libvlc_log_iterator_next (libvlc_log_iterator_t *p_iter, libvlc_log_message_t *p_buffer, libvlc_exception_t *p_e)
	Return the next log message.

---

Detailed Description

LibVLC Message Logging.

---

Typedef Documentation

typedef struct libvlc_log_iterator_t libvlc_log_iterator_t

This structure is opaque.

It represents a libvlc log iterator

typedef struct libvlc_log_t libvlc_log_t

This structure is opaque.

It represents a libvlc log instance

---

Function Documentation

unsigned libvlc_get_log_verbosity

(

const libvlc_instance_t *

p_instance

)

Return the VLC messaging verbosity level.

Parameters:

p_instance

libvlc instance

Returns:

verbosity level for messages

References libvlc_instance_t::verbosity.

void libvlc_log_clear

(

libvlc_log_t *

p_log

)

Clear a log instance.

All messages in the log are removed. The log should be cleared on a regular basis to avoid clogging.

Parameters:

p_log

libvlc log instance or NULL

References msg_cb_data_t::count, libvlc_log_t::data, i, msg_cb_data_t::items, msg_cb_data_t::lock, msg_Release(), vlc_spin_lock, and vlc_spin_unlock.

Referenced by libvlc_log_close().

void libvlc_log_close

(

libvlc_log_t *

p_log

)

Close a VLC message log instance.

Parameters:

p_log

libvlc log instance or NULL

References libvlc_log_t::data, libvlc_log_clear(), libvlc_release(), msg_cb_data_t::lock, msg_Unsubscribe(), libvlc_log_t::p_instance, libvlc_log_t::p_messages, and vlc_spin_destroy.

unsigned libvlc_log_count

(

const libvlc_log_t *

p_log

)

Returns the number of messages in a log instance.

Parameters:

p_log

libvlc log instance or NULL

Returns:

number of log messages, 0 if p_log is NULL

References msg_cb_data_t::count, libvlc_log_t::data, msg_cb_data_t::lock, vlc_spin_lock, and vlc_spin_unlock.

libvlc_log_iterator_t* libvlc_log_get_iterator	(	const libvlc_log_t *	,
		libvlc_exception_t *
	)

Allocate and returns a new iterator to messages in log.

Parameters:

	p_log	libvlc log instance
	p_e	an initialized exception pointer

Returns:

log iterator object

References msg_cb_data_t::count, libvlc_log_iterator_t::i_end, libvlc_log_iterator_t::i_pos, msg_cb_data_t::lock, libvlc_log_iterator_t::p_data, RAISENULL, vlc_spin_lock, and vlc_spin_unlock.

void libvlc_log_iterator_free

(

libvlc_log_iterator_t *

p_iter

)

Release a previoulsy allocated iterator.

Parameters:

p_iter

libvlc log iterator or NULL

int libvlc_log_iterator_has_next

(

const libvlc_log_iterator_t *

p_iter

)

Return whether log iterator has more messages.

Parameters:

p_iter

libvlc log iterator or NULL

Returns:

true if iterator has more message objects, else false

References libvlc_log_iterator_t::i_end, and libvlc_log_iterator_t::i_pos.

libvlc_log_message_t* libvlc_log_iterator_next	(	libvlc_log_iterator_t *	p_iter,
		libvlc_log_message_t *	p_buffer,
		libvlc_exception_t *	p_e
	)

Return the next log message.

The message contents must not be freed

Parameters:

	p_iter	libvlc log iterator or NULL
	p_buffer	log buffer
	p_e	an initialized exception pointer

Returns:

log message object

References libvlc_log_iterator_t::i_end, libvlc_log_iterator_t::i_pos, libvlc_log_message_t::i_severity, msg_item_t::i_type, msg_cb_data_t::items, msg_cb_data_t::lock, msg, libvlc_log_iterator_t::p_data, msg_item_t::psz_header, libvlc_log_message_t::psz_header, libvlc_log_message_t::psz_message, msg_item_t::psz_module, msg_item_t::psz_msg, libvlc_log_message_t::psz_name, msg_item_t::psz_object_type, libvlc_log_message_t::psz_type, RAISENULL, vlc_spin_lock, and vlc_spin_unlock.

libvlc_log_t* libvlc_log_open	(	libvlc_instance_t *	,
		libvlc_exception_t *
	)

Open a VLC message log instance.

Parameters:

	p_instance	libvlc instance
	p_e	an initialized exception pointer

Returns:

log message instance

References msg_cb_data_t::count, libvlc_log_t::data, handler(), libvlc_retain(), msg_cb_data_t::lock, msg_Subscribe(), libvlc_log_t::p_instance, libvlc_instance_t::p_libvlc_int, libvlc_log_t::p_messages, RAISENULL, libvlc_instance_t::verbosity, msg_cb_data_t::verbosity, and vlc_spin_init().

void libvlc_set_log_verbosity	(	libvlc_instance_t *	p_instance,
		unsigned	level
	)

Set the VLC messaging verbosity level.

Parameters:

	p_instance	libvlc log instance
	level	log level

References libvlc_instance_t::verbosity.