mu_config Struct Reference

Configuration handling structure. More...

#include <mod_musicindex.h>

Data Fields
char *restrict	search
	string to search
const char *restrict	custom_list
	custom playlist
const char *restrict	title
	title of the page
const char *restrict	directory
	directory where musicindex files are stored
const char *restrict	css
	path to the css
const char *restrict	iceserver
	adress of an icecast server
const cache_backend *restrict	cache
	registered cache backend (if any)
void *restrict	cache_setup
	cache private data (if any)
signed short	dir_per_line
	number of directories to display per line.
unsigned short	cookie_life
	cookie lifetime in seconds
short	rss_items
	number of entries in the RSS file
unsigned short	options
	diverse options
unsigned short	options_not
	used to disable options
unsigned short	sets
	which field are dynamically set.
unsigned char	order [SB_MAX+1]
	Sort order.
unsigned char	fields [SB_MAX+1]
	Fields to display.

Detailed Description

Configuration handling structure.

We use it to share configuration throughout the whole module

Definition at line 388 of file mod_musicindex.h.

Field Documentation

const cache_backend* restrict mu_config::cache

registered cache backend (if any)

Definition at line 399 of file mod_musicindex.h.

Referenced by cache_file_setup(), cache_mysql_setup(), handle_musicfile(), handle_musicindex(), make_cache_entry(), make_music_entry(), musicindex_closedir(), musicindex_opendir(), musicindex_readdir(), and treat_post_args().

void* restrict mu_config::cache_setup

cache private data (if any)

Definition at line 400 of file mod_musicindex.h.

Referenced by cache_file_opendir(), cache_file_setup(), cache_file_write(), cache_mysql_setup(), file_make_cache_entry(), mysql_cache_epilogue(), mysql_cache_make_entry(), mysql_cache_opendir(), mysql_cache_prologue(), and mysql_cache_write().

unsigned short mu_config::cookie_life

cookie lifetime in seconds

Definition at line 403 of file mod_musicindex.h.

Referenced by cookie_and_stream_work(), and set_cookie_life().

const char* restrict mu_config::css

path to the css

Definition at line 396 of file mod_musicindex.h.

Referenced by send_head(), and set_css_default().

const char* restrict mu_config::custom_list

custom playlist

Definition at line 391 of file mod_musicindex.h.

Referenced by build_custom_list(), cookie_add(), cookie_and_stream_work(), cookie_remove(), handle_musicindex(), treat_get_args(), and treat_post_args().

signed short mu_config::dir_per_line

number of directories to display per line.

If <0 disable "pretty folders"

Definition at line 402 of file mod_musicindex.h.

Referenced by handle_musicindex(), make_music_entry(), send_directories(), and set_dirperline().

const char* restrict mu_config::directory

directory where musicindex files are stored

Definition at line 395 of file mod_musicindex.h.

Referenced by send_foot(), and send_head().

unsigned char mu_config::fields[SB_MAX+1]

Fields to display.

Definition at line 412 of file mod_musicindex.h.

Referenced by list_songs(), and set_fields().

const char* restrict mu_config::iceserver

adress of an icecast server

Definition at line 397 of file mod_musicindex.h.

Referenced by handle_musicfile(), send_url(), and set_ice_server().

unsigned short mu_config::options

diverse options

Definition at line 406 of file mod_musicindex.h.

Referenced by basic_config(), cookie_and_stream_work(), go_through_directory(), handle_musicfile(), handle_musicindex(), list_songs(), make_flac_entry(), make_mp3_entry(), make_mp4_entry(), make_music_entry(), make_ogg_entry(), mysql_cache_dircontents(), mysql_cache_opendir(), send_head(), send_rss(), send_tracks(), send_url(), set_display(), treat_get_args(), and treat_post_args().

unsigned short mu_config::options_not

used to disable options

Definition at line 407 of file mod_musicindex.h.

Referenced by basic_config(), and set_display().

unsigned char mu_config::order[SB_MAX+1]

Sort order.

Definition at line 411 of file mod_musicindex.h.

Referenced by cookie_addall(), handle_musicindex(), send_tracks(), set_display(), sort_order(), treat_get_args(), and treat_post_args().

short mu_config::rss_items

number of entries in the RSS file

Definition at line 404 of file mod_musicindex.h.

Referenced by basic_config(), send_head(), send_rss(), set_display(), and treat_get_args().

char* restrict mu_config::search

string to search

Definition at line 390 of file mod_musicindex.h.

Referenced by go_through_directory(), handle_musicindex(), list_songs(), make_music_entry(), mysql_cache_dircontents(), send_tracks(), and treat_post_args().

unsigned short mu_config::sets

which field are dynamically set.

Used to merge configs

Definition at line 409 of file mod_musicindex.h.

Referenced by set_cache_uri(), set_cookie_life(), set_css_default(), set_dirperline(), set_display(), set_fields(), set_ice_server(), set_page_title(), and sort_order().

const char* restrict mu_config::title

title of the page

Definition at line 394 of file mod_musicindex.h.

Referenced by send_head(), and set_page_title().

---

The documentation for this struct was generated from the following file:

• mod_musicindex.h