MyFavMirrors/owntone-server
1
0
Fork 0
mirror of https://github.com/owntone/owntone-server.git synced 2024-12-27 07:35:57 -05:00
Code Issues Packages Projects Releases Wiki Activity

[commands] Add some code comments

Browse Source
This commit is contained in:
chme 2016-06-11 10:11:42 +02:00
parent 32ac6c2ea9
commit c0c6cca79f
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/commands.c
View File

@ -168,7 +168,10 @@ send_command(struct commands_base *cmdbase, struct command *cmd)
}
/*
* Creates a new command base, needs to be freed by commands_base_free.
* Creates a new command base, needs to be freed by commands_base_destroy or commands_base_free.
*
* @param evbase The libevent base to use for command handling
* @param exit_cb Callback function to be called during commands_base_destroy
*/
struct commands_base *
commands_base_new(struct event_base *evbase, command_exit_cb exit_cb)
@ -364,6 +367,15 @@ commands_exec_async(struct commands_base *cmdbase, command_function func, void *
return 0;
}
/*
* Command to break the libevent loop
*
* If the command base was created with an exit_cb function, exit_cb is called before breaking the
* libevent loop.
*
* @param arg The command base
* @param retval Always set to COMMAND_END
*/
static enum command_state
cmdloop_exit(void *arg, int *retval)
{
@ -378,6 +390,12 @@ cmdloop_exit(void *arg, int *retval)
return COMMAND_END;
}
/*
* Break the libevent loop for the given command base, closes the internally used pipes
* and frees the command base.
*
* @param cmdbase The command base
*/
void
commands_base_destroy(struct commands_base *cmdbase)
{