kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-12 15:45:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

res_ari: Fix for Doxygen.

Browse Source 
ASTERISK-29756

Change-Id: I2f1c1eea1c902492b77b74de9950f20ebbb7e758
This commit is contained in:
Alexander Traud
2021-11-17 13:18:32 +01:00
committed by Friendly Automation
parent e27b91d542
commit 5b5a9ea4f0
20 changed files with 405 additions and 353 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
include/asterisk/ari.h
View File

@@ -54,6 +54,7 @@ struct ast_ari_response;
* \param get_params GET parameters from the HTTP request.
* \param path_vars Path variables from any wildcard path segments.
* \param headers HTTP headers from the HTTP requiest.
* \param body
* \param[out] response The RESTful response.
*/
typedef void (*stasis_rest_callback)(
@@ -91,7 +92,7 @@ struct stasis_rest_handlers {
struct ast_ari_response {
/*! Response message */
struct ast_json *message;
/*! \r\n seperated response headers */
/*! \\r\\n seperated response headers */
struct ast_str *headers;
/*! HTTP response code.
* See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html */
@@ -107,16 +108,16 @@ struct ast_ari_response {
/*!
* Add a resource for REST handling.
* \param handler Handler to add.
* \return 0 on success.
* \return non-zero on failure.
* \retval 0 on success.
* \retval non-zero on failure.
*/
int ast_ari_add_handler(struct stasis_rest_handlers *handler);
/*!
* Remove a resource for REST handling.
* \param handler Handler to add.
* \return 0 on success.
* \return non-zero on failure.
* \retval 0 on success.
* \retval non-zero on failure.
*/
int ast_ari_remove_handler(struct stasis_rest_handlers *handler);
@@ -132,6 +133,7 @@ int ast_ari_remove_handler(struct stasis_rest_handlers *handler);
* \param method HTTP method.
* \param get_params HTTP \c GET parameters.
* \param headers HTTP headers.
* \param body
* \param[out] response RESTful HTTP response.
*/
void ast_ari_invoke(struct ast_tcptls_session_instance *ser,
@@ -165,7 +167,7 @@ struct ast_ari_websocket_session;
* \param ws_session Underlying WebSocket session.
* \param validator Function to validate outgoing messages.
* \return New ARI WebSocket session.
* \return \c NULL on error.
* \retval NULL on error.
*/
struct ast_ari_websocket_session *ast_ari_websocket_session_create(
struct ast_websocket *ws_session, int (*validator)(struct ast_json *));
@@ -175,7 +177,7 @@ struct ast_ari_websocket_session *ast_ari_websocket_session_create(
*
* \param session Session to read from.
* \return Message received.
* \return \c NULL if WebSocket could not be read.
* \retval NULL if WebSocket could not be read.
*/
struct ast_json *ast_ari_websocket_session_read(
struct ast_ari_websocket_session *session);
@@ -185,8 +187,8 @@ struct ast_json *ast_ari_websocket_session_read(
*
* \param session Session to write to.
* \param message Message to send.
* \return 0 on success.
* \return Non-zero on error.
* \retval 0 on success.
* \retval Non-zero on error.
*/
int ast_ari_websocket_session_write(struct ast_ari_websocket_session *session,
struct ast_json *message);
@@ -196,7 +198,7 @@ int ast_ari_websocket_session_write(struct ast_ari_websocket_session *session,
*
* \param session Session to query.
* \return Session ID.
* \return \c NULL on error.
* \retval NULL on error.
*/
const char *ast_ari_websocket_session_id(
const struct ast_ari_websocket_session *session);