6.1.1 Server interaction
- Macro: cca_enabled (client)
- Check whether the cca_client_t pointer client is not
NULL
, and if it
isn't, that the server is still connected.
- Function: cca_args_t * cca_extract_args (int * argc, char *** argv)
- Extract LADCCA-specific arguments from argc/argv. This should be done before the
client checks the arguments, obviously.
- Function: cca_client_t * cca_init (cca_args_t * args, const char * client_class, int client_flags, cca_protocol_t protocol)
- Open a connection to the server. Returns
NULL
on failure. See
Protocol versioning for information on how to contruct a cca_protocol_t
variable.
- Function: const char * cca_get_server_name (cca_client_t * client)
- Get the hostname of the server.
- Function: unsigned int cca_get_pending_event_count (cca_client_t * client)
- Get the number of pending events.
- Function: cca_event_t * cca_get_event (cca_client_t * client)
- Retrieve an event. The event must be freed using
cca_event_destroy
.
Returns NULL
if there are no events pending.
- Function: unsigned int cca_get_pending_config_count (cca_client_t * client)
- Get the number of pending configs.
- Function: cca_config_t * cca_get_config (cca_client_t * client)
- Retrieve a config. The config must be freed using
cca_config_destroy
.
Returns NULL
if there are no configs pending.
- Function: void cca_send_event (cca_client_t * client, cca_event_t * event)
- Send an event to the server. The event must be created using
cca_event_new
or cca_event_new_with_type
. The library takes over
ownership of the memory and it should not be freed by the client.
- Function: void cca_send_config (cca_client_t * client, cca_config_t * config)
- Send some configuration data to the server. The config must be created using
cca_config_new
, cca_config_new_with_key
or
cca_config_dup
. The library takes
over ownership of the memory and it should not be freed by the client.
- Function: int cca_server_connected (cca_client_t * client)
- Check whether the server is connected. Returns 1 if the server is still
connected or 0 if it isn't
- Function: void cca_jack_client_name (cca_client_t * client, const char * name)
- Tell the server the client's JACK client name.
- Function: void cca_alsa_client_id (cca_client_t * client, unsigned char id);
- Tell the server the client's ALSA client id.
This document was generated
on February, 6 2003
using texi2html