mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-04 03:50:31 +00:00
Doxygen documentation update from oej (issue #5505)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@6847 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
16
manager.c
16
manager.c
@@ -16,12 +16,13 @@
|
||||
* at the top of the source tree.
|
||||
*/
|
||||
|
||||
/*
|
||||
/*! \file
|
||||
*
|
||||
* The Asterisk Management Interface - AMI
|
||||
* \brief The Asterisk Management Interface - AMI
|
||||
*
|
||||
* Channel Management and more
|
||||
*
|
||||
* \ref manconf
|
||||
*/
|
||||
|
||||
#include <stdio.h>
|
||||
@@ -100,7 +101,7 @@ static struct mansession *sessions = NULL;
|
||||
static struct manager_action *first_action = NULL;
|
||||
AST_MUTEX_DEFINE_STATIC(actionlock);
|
||||
|
||||
/* If you are calling carefulwrite, it is assumed that you are calling
|
||||
/*! If you are calling ast_carefulwrite, it is assumed that you are calling
|
||||
it on a file descriptor that _DOES_ have NONBLOCK set. This way,
|
||||
there is only one system call made to do a write, unless we actually
|
||||
have a need to wait. This way, we get better performance. */
|
||||
@@ -131,7 +132,7 @@ int ast_carefulwrite(int fd, char *s, int len, int timeoutms)
|
||||
return res;
|
||||
}
|
||||
|
||||
/*--- authority_to_str: Convert authority code to string with serveral options */
|
||||
/*! authority_to_str: Convert authority code to string with serveral options */
|
||||
static char *authority_to_str(int authority, char *res, int reslen)
|
||||
{
|
||||
int running_total = 0, i;
|
||||
@@ -334,7 +335,7 @@ struct ast_variable *astman_get_variables(struct message *m)
|
||||
return head;
|
||||
}
|
||||
|
||||
/* NOTE:
|
||||
/*! NOTE:
|
||||
Callers of astman_send_error(), astman_send_response() or astman_send_ack() must EITHER
|
||||
hold the session lock _or_ be running in an action callback (in which case s->busy will
|
||||
be non-zero). In either of these cases, there is no need to lock-protect the session's
|
||||
@@ -342,7 +343,6 @@ struct ast_variable *astman_get_variables(struct message *m)
|
||||
be read until either the current action finishes or get_input() obtains the session
|
||||
lock.
|
||||
*/
|
||||
|
||||
void astman_send_error(struct mansession *s, struct message *m, char *error)
|
||||
{
|
||||
char *id = astman_get_header(m,"ActionID");
|
||||
@@ -371,7 +371,7 @@ void astman_send_ack(struct mansession *s, struct message *m, char *msg)
|
||||
astman_send_response(s, m, "Success", msg);
|
||||
}
|
||||
|
||||
/* Tells you if smallstr exists inside bigstr
|
||||
/*! Tells you if smallstr exists inside bigstr
|
||||
which is delim by delim and uses no buf or stringsep
|
||||
ast_instring("this|that|more","this",',') == 1;
|
||||
|
||||
@@ -452,7 +452,7 @@ static int ast_strings_to_mask(char *string)
|
||||
return ret;
|
||||
}
|
||||
|
||||
/*
|
||||
/*!
|
||||
Rather than braindead on,off this now can also accept a specific int mask value
|
||||
or a ',' delim list of mask strings (the same as manager.conf) -anthm
|
||||
*/
|
||||
|
Reference in New Issue
Block a user