ConfigControl
[XMMSClient]

This controls configuration values on the XMMS server. More...

Functions

xmmsc_result_txmmsc_configval_register (xmmsc_connection_t *c, const char *key, const char *value)
 Registers a configvalue in the server.
xmmsc_result_txmmsc_config_register_value (xmmsc_connection_t *c, const char *key, const char *value)
 Registers a configvalue in the server.
xmmsc_result_txmmsc_configval_set (xmmsc_connection_t *c, const char *key, const char *val)
 Sets a configvalue in the server.
xmmsc_result_txmmsc_config_set_value (xmmsc_connection_t *c, const char *key, const char *val)
 Sets a configvalue in the server.
xmmsc_result_txmmsc_configval_get (xmmsc_connection_t *c, const char *key)
 Retrives a list of configvalues in server.
xmmsc_result_txmmsc_config_get_value (xmmsc_connection_t *c, const char *key)
 Retrieves a configvalue from the server.
xmmsc_result_txmmsc_configval_list (xmmsc_connection_t *c)
 Lists all configuration values.
xmmsc_result_txmmsc_config_list_values (xmmsc_connection_t *c)
 Lists all configuration values.
xmmsc_result_txmmsc_broadcast_configval_changed (xmmsc_connection_t *c)
 Requests the configval_changed broadcast.
xmmsc_result_txmmsc_broadcast_config_value_changed (xmmsc_connection_t *c)
 Requests the config_value_changed broadcast.

Detailed Description

This controls configuration values on the XMMS server.


Function Documentation

xmmsc_result_t* xmmsc_broadcast_config_value_changed ( xmmsc_connection_t c  ) 

Requests the config_value_changed broadcast.

This will be called when a configvalue has been updated.

Parameters:
c The connection structure.

Definition at line 181 of file config.c.

Referenced by xmmsc_broadcast_configval_changed().

xmmsc_result_t* xmmsc_broadcast_configval_changed ( xmmsc_connection_t c  ) 

Requests the configval_changed broadcast.

This will be called when a configvalue has been updated.

Parameters:
c The connection structure.
Deprecated:

Definition at line 169 of file config.c.

xmmsc_result_t* xmmsc_config_get_value ( xmmsc_connection_t c,
const char *  key 
)

Retrieves a configvalue from the server.

Parameters:
c The connection structure.
key The key of the configval to retrieve.

Definition at line 127 of file config.c.

Referenced by xmmsc_configval_get().

xmmsc_result_t* xmmsc_config_list_values ( xmmsc_connection_t c  ) 

Lists all configuration values.

Parameters:
c The connection structure.

Definition at line 154 of file config.c.

Referenced by xmmsc_configval_list().

xmmsc_result_t* xmmsc_config_register_value ( xmmsc_connection_t c,
const char *  key,
const char *  value 
)

Registers a configvalue in the server.

Parameters:
c The connection structure.
key should be <clientname>.myval like cli.path or something like that.
value The default value of this config value.

Definition at line 61 of file config.c.

Referenced by xmmsc_configval_register().

xmmsc_result_t* xmmsc_config_set_value ( xmmsc_connection_t c,
const char *  key,
const char *  val 
)

Sets a configvalue in the server.

Parameters:
c The connection structure.
key The key of the configval to set a value for.
val The new value of the configval.

Definition at line 95 of file config.c.

Referenced by xmmsc_configval_set().

xmmsc_result_t* xmmsc_configval_get ( xmmsc_connection_t c,
const char *  key 
)

Retrives a list of configvalues in server.

Parameters:
c The connection structure.
key The key of the configval to retrieve.
Deprecated:

Definition at line 115 of file config.c.

xmmsc_result_t* xmmsc_configval_list ( xmmsc_connection_t c  ) 

Lists all configuration values.

Parameters:
c The connection structure.
Deprecated:

Definition at line 143 of file config.c.

xmmsc_result_t* xmmsc_configval_register ( xmmsc_connection_t c,
const char *  key,
const char *  value 
)

Registers a configvalue in the server.

Parameters:
c The connection structure.
key should be <clientname>.myval like cli.path or something like that.
value The default value of this config value.
Deprecated:

Definition at line 47 of file config.c.

xmmsc_result_t* xmmsc_configval_set ( xmmsc_connection_t c,
const char *  key,
const char *  val 
)

Sets a configvalue in the server.

Parameters:
c The connection structure.
key The key of the configval to set a value for.
val The new value of the configval.
Deprecated:

Definition at line 82 of file config.c.


Generated on Tue Feb 23 18:17:57 2010 for XmmsClient by  doxygen 1.6.1