mympd_state.h File Reference

Central myMPD state for the mympd_api thread. More...

#include "dist/sds/sds.h"
#include "src/lib/cache/cache_rax.h"
#include "src/lib/config_def.h"
#include "src/lib/event.h"
#include "src/lib/fields.h"
#include "src/lib/jukebox.h"
#include "src/lib/list.h"
#include "src/lib/webradio.h"
#include <time.h>

Include dependency graph for mympd_state.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	t_mpd_features
struct	t_mpd_state
struct	t_jukebox_state
struct	t_partition_state
struct	t_stickerdb_state
struct	t_timer_definition
struct	t_timer_list
struct	t_lyrics
struct	t_mympd_state

Enumerations
enum	mpd_conn_states { MPD_CONNECTED , MPD_DISCONNECTED , MPD_FAILURE }

Functions
void	mympd_state_save (struct t_mympd_state *mympd_state, bool free_data)
void	mympd_state_default (struct t_mympd_state *mympd_state, struct t_config *config)
void	mympd_state_free (struct t_mympd_state *mympd_state)
void	mympd_mpd_state_features_default (struct t_mpd_features *feat)
void	mympd_mpd_state_features_copy (struct t_mpd_features *src, struct t_mpd_features *dst)
void	mympd_mpd_state_default (struct t_mpd_state *mpd_state, struct t_config *config)
void	mympd_mpd_state_copy (struct t_mpd_state *src, struct t_mpd_state *dst)
void	mympd_mpd_state_free (struct t_mpd_state *mpd_state)
void	partition_state_default (struct t_partition_state *partition_state, const char *name, struct t_mpd_state *mpd_state, struct t_config *config)
void	partition_state_free (struct t_partition_state *partition_state)
void	stickerdb_state_default (struct t_stickerdb_state *stickerdb, struct t_config *config)
void	stickerdb_state_free (struct t_stickerdb_state *stickerdb)
void	jukebox_state_default (struct t_jukebox_state *jukebox_state)
void	jukebox_state_copy (struct t_jukebox_state *src, struct t_jukebox_state *dst)
void	jukebox_state_free (struct t_jukebox_state *jukebox_state)

Detailed Description

Central myMPD state for the mympd_api thread.

Enumeration Type Documentation

mpd_conn_states

enum mpd_conn_states

MPD connection states

Enumerator
MPD_CONNECTED	mpd is connected
MPD_DISCONNECTED	mpd is disconnected
MPD_FAILURE	mpd is in unrecoverable failure state

Function Documentation

jukebox_state_copy()

void jukebox_state_copy	(	struct t_jukebox_state *	src,
		struct t_jukebox_state *	dst
	)

Copies the jukebox settings

Parameters

src	source
dst	destination

jukebox_state_default()

void jukebox_state_default

(

struct t_jukebox_state *

jukebox_state

)

Sets jukebox state defaults

Parameters

jukebox_state

pointer to t_jukebox_state struct

jukebox_state_free()

void jukebox_state_free

(

struct t_jukebox_state *

jukebox_state

)

Frees the t_jukebox_state struct

Parameters

jukebox_state

pointer to t_jukebox_state struct

mympd_mpd_state_copy()

void mympd_mpd_state_copy	(	struct t_mpd_state *	src,
		struct t_mpd_state *	dst
	)

Copy mpd state

Parameters

src	source
dst	destination

mympd_mpd_state_default()

void mympd_mpd_state_default	(	struct t_mpd_state *	mpd_state,
		struct t_config *	config
	)

Sets mpd_state defaults.

Parameters

mpd_state	pointer to mpd_state
config	pointer to static config

mympd_mpd_state_features_copy()

void mympd_mpd_state_features_copy	(	struct t_mpd_features *	src,
		struct t_mpd_features *	dst
	)

Copy mpd state feature flags

Parameters

src	source
dst	destination

mympd_mpd_state_features_default()

void mympd_mpd_state_features_default

(

struct t_mpd_features *

feat

)

Sets all feature states to default

Parameters

feat	pointer to mpd feature struct

mympd_mpd_state_free()

void mympd_mpd_state_free

(

struct t_mpd_state *

mpd_state

)

Frees the t_mpd_state struct

Parameters

mpd_state

Pointer to mpd_state

mympd_state_default()

void mympd_state_default	(	struct t_mympd_state *	mympd_state,
		struct t_config *	config
	)

Sets mympd_state defaults.

Parameters

mympd_state	pointer to central myMPD state
config	pointer to static config

mympd_state_free()

void mympd_state_free

(

struct t_mympd_state *

mympd_state

)

Frees the myMPD state, frees also the referenced structs.

Parameters

mympd_state

pointer to central myMPD state

mympd_state_save()

void mympd_state_save	(	struct t_mympd_state *	mympd_state,
		bool	free_data
	)

Public functions

Saves in-memory states to disc. This is done on shutdown and on SIGHUP.

Parameters

mympd_state	pointer to central myMPD state
free_data	true=free the struct, else not

partition_state_default()

void partition_state_default	(	struct t_partition_state *	partition_state,
		const char *	name,
		struct t_mpd_state *	mpd_state,
		struct t_config *	config
	)

Sets per partition state defaults

Parameters

partition_state	pointer to t_partition_state struct
name	partition name
mpd_state	pointer to shared mpd state
config	pointer to static config

partition_state_free()

void partition_state_free

(

struct t_partition_state *

partition_state

)

Frees the t_partition_state struct

Parameters

partition_state

pointer to t_partition_state struct

stickerdb_state_default()

void stickerdb_state_default	(	struct t_stickerdb_state *	stickerdb,
		struct t_config *	config
	)

Sets stickerdb state defaults

Parameters

stickerdb	pointer to stickerdb state
config	pointer to static config

stickerdb_state_free()

void stickerdb_state_free

(

struct t_stickerdb_state *

stickerdb

)

Frees the t_stickerdb_state struct

Parameters

stickerdb

pointer to struct