This section describes version 1.0 of the event protocol. Note that this particular version number should not imply stability of any kind. This is the first protocol version, not the first stable protocol.
CCA_Client_Name
NULL
string
NULL
string
CCA_Client_Name
with a
NULL
string. The string will be NULL
if the client has not
set a user-visible name, and the name itself if it has.
CCA_Jack_Client_Name
NULL
string
CCA_Jack_Client_Name
event after connecting without the
CCA_Use_Jack
flag; the server will simply update its server-side
description to reflect this. Bear in mind that flags are inherited by
resumed clients. This may be an in issue if a client that does not set the
CCA_Use_Jack
flag sends a CCA_Jack_Client_Name
event and is
later resumed by a client which does not become a JACK client. The
@option{--ladcca-no-autoresume} option can still be used in such situations.
Clients should only ever send one non-NULL
CCA_Jack_Client_Name
event.
NULL
string
CCA_Jack_Client_Name
with a
NULL
string. The string will be NULL
if the client has not
set a JACK client name, and the client name itself if it has.
CCA_Alsa_Client_ID
{ id, '\0' }
as the
event string. A
convenience function, cca_alsa_client_id
, exists to do this for you
(see @xref{cca_alsa_client_id}.)
NULL
string
CCA_Alsa_Client_ID
event after connecting without the
CCA_Use_Alsa
flag; the server will simply update its server-side
description to reflect this. Bear in mind that flags are inherited by
resumed clients. This may be an in issue if a client that does not set the
CCA_Use_Alsa
flag sends a CCA_Alsa_Client_ID
event and is
later resumed by a client which does not become an ALSA client. The
@option{--ladcca-no-autoresume} option can still be used in such situations.
Clients should only ever send one non-NULL
CCA_Alsa_Client_ID
event.
NULL
string
CCA_Alsa_Client_ID
with a
NULL
string. The string will be NULL
if the client has not
set an ALSA client ID, and a string containing the ALSA client ID as described
above if it has.
CCA_Save_File
NULL
and will contain the name of the
directory in which the client should save its data. Clients must always
send a CCA_Save_File
event back to the server when they have finished
saving their data. The client should not
rely on the directory existing after it has sent its CCA_Save_File
event back. It is valid behaviour for a client to save no files within the
directory. Files should always be overwritten (ie, using the "w" flag
with fopen()
,) preferably without user confirmation if you care
for their sanity.
CCA_Restore_File
NULL
and will contain the name of the
directory from which the client should load its data. Clients must always
send a CCA_Restore_File
event back to the server when they have finished
saving their data. The client should not
rely on the directory existing after it has sent its CCA_Restore_File
event back.
CCA_Save_Data_Set
CCA_Save_Data_Set
event back to the server when it has finished sending its configs. The
event string will always be NULL
.
CCA_Restore_Data_Set
NULL
. The client must always send
a CCA_Restore_Data_Set
back to the server when it has recieved
all of its configs.
CCA_Save
CCA_Quit
The server interface protocol is not well developed at all.
CCA_Project
CCA_Project_Dir
CCA_Project_Name
CCA_Projects
CCA_Restore
Go to the first, previous, next, last section, table of contents.