res_ari_device_states.c File Reference

Device state resources. More...

#include "asterisk.h"
#include "asterisk/app.h"
#include "asterisk/module.h"
#include "asterisk/stasis_app.h"
#include "ari/resource_device_states.h"

Include dependency graph for res_ari_device_states.c:

Go to the source code of this file.

Macros
#define	MAX_VALS   128

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
static void	ast_ari_device_states_delete_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /deviceStates/{deviceName}.
static void	ast_ari_device_states_get_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /deviceStates/{deviceName}.
static void	ast_ari_device_states_list_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /deviceStates.
static void	ast_ari_device_states_update_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /deviceStates/{deviceName}.
int	ast_ari_device_states_update_parse_body (struct ast_json *body, struct ast_ari_device_states_update_args *args)
	Body parsing function for /deviceStates/{deviceName}.
struct ast_module *	AST_MODULE_SELF_SYM (void)
static int	load_module (void)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "RESTful API module - Device state resources" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .requires = "res_ari,res_ari_model,res_stasis,res_stasis_device_state", }
static const struct ast_module_info *	ast_module_info = &__mod_info
static struct stasis_rest_handlers	deviceStates
	REST handler for /api-docs/deviceStates.json.
static struct stasis_rest_handlers	deviceStates_deviceName
	REST handler for /api-docs/deviceStates.json.

Detailed Description

Device state resources.

Author

Kevin Harwell kharw.nosp@m.ell@.nosp@m.digiu.nosp@m.m.co.nosp@m.m

Definition in file res_ari_device_states.c.

Macro Definition Documentation

MAX_VALS

#define MAX_VALS   128

Definition at line 52 of file res_ari_device_states.c.

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 358 of file res_ari_device_states.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 358 of file res_ari_device_states.c.

ast_ari_device_states_delete_cb()

static void ast_ari_device_states_delete_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /deviceStates/{deviceName}.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 258 of file res_ari_device_states.c.

{
    struct ast_ari_device_states_delete_args args = {};
    struct ast_variable *i;
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    for (i = path_vars; i; i = i->next) {
        if (strcmp(i->name, "deviceName") == 0) {
            args.device_name = (i->value);
        } else
        {}
    }
    ast_ari_device_states_delete(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
    case 404: /* Device name is missing */
    case 409: /* Uncontrolled device specified */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_void(
                response->message);
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /deviceStates/{deviceName}\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /deviceStates/{deviceName}\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_device_states_delete(), ast_ari_response_error(), ast_ari_validate_void(), ast_log, LOG_ERROR, ast_ari_response::message, ast_variable::name, ast_variable::next, NULL, ast_ari_response::response_code, and ast_variable::value.

ast_ari_device_states_get_cb()

static void ast_ari_device_states_get_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /deviceStates/{deviceName}.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 115 of file res_ari_device_states.c.

{
    struct ast_ari_device_states_get_args args = {};
    struct ast_variable *i;
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    for (i = path_vars; i; i = i->next) {
        if (strcmp(i->name, "deviceName") == 0) {
            args.device_name = (i->value);
        } else
        {}
    }
    ast_ari_device_states_get(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_device_state(
                response->message);
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /deviceStates/{deviceName}\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /deviceStates/{deviceName}\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_device_states_get(), ast_ari_response_error(), ast_ari_validate_device_state(), ast_log, LOG_ERROR, ast_ari_response::message, ast_variable::name, ast_variable::next, NULL, ast_ari_response::response_code, and ast_variable::value.

ast_ari_device_states_list_cb()

static void ast_ari_device_states_list_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /deviceStates.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 63 of file res_ari_device_states.c.

{
    struct ast_ari_device_states_list_args args = {};
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    ast_ari_device_states_list(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_list(response->message,
                ast_ari_validate_device_state_fn());
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /deviceStates\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /deviceStates\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_device_states_list(), ast_ari_response_error(), ast_ari_validate_device_state_fn(), ast_ari_validate_list(), ast_log, LOG_ERROR, ast_ari_response::message, NULL, and ast_ari_response::response_code.

ast_ari_device_states_update_cb()

static void ast_ari_device_states_update_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /deviceStates/{deviceName}.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 187 of file res_ari_device_states.c.

{
    struct ast_ari_device_states_update_args args = {};
    struct ast_variable *i;
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    for (i = get_params; i; i = i->next) {
        if (strcmp(i->name, "deviceState") == 0) {
            args.device_state = (i->value);
        } else
        {}
    }
    for (i = path_vars; i; i = i->next) {
        if (strcmp(i->name, "deviceName") == 0) {
            args.device_name = (i->value);
        } else
        {}
    }
    if (ast_ari_device_states_update_parse_body(body, &args)) {
        ast_ari_response_alloc_failed(response);
        goto fin;
    }
    ast_ari_device_states_update(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
    case 404: /* Device name is missing */
    case 409: /* Uncontrolled device specified */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_void(
                response->message);
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /deviceStates/{deviceName}\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /deviceStates/{deviceName}\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_device_states_update(), ast_ari_device_states_update_parse_body(), ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_ari_validate_void(), ast_log, LOG_ERROR, ast_ari_response::message, ast_variable::name, ast_variable::next, NULL, ast_ari_response::response_code, and ast_variable::value.

ast_ari_device_states_update_parse_body()

int ast_ari_device_states_update_parse_body	(	struct ast_json *	body,
		struct ast_ari_device_states_update_args *	args
	)

Body parsing function for /deviceStates/{deviceName}.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 165 of file res_ari_device_states.c.

{
    struct ast_json *field;
    /* Parse query parameters out of it */
    field = ast_json_object_get(body, "deviceState");
    if (field) {
        args->device_state = ast_json_string_get(field);
    }
    return 0;
}

References args, ast_json_object_get(), and ast_json_string_get().

Referenced by ast_ari_device_states_update_cb().

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 358 of file res_ari_device_states.c.

load_module()

static int load_module ( void  )

static

Definition at line 339 of file res_ari_device_states.c.

{
    int res = 0;
 
 
    res |= ast_ari_add_handler(&deviceStates);
    if (res) {
        unload_module();
        return AST_MODULE_LOAD_DECLINE;
    }
 
    return AST_MODULE_LOAD_SUCCESS;
}

References ast_ari_add_handler(), AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, deviceStates, and unload_module().

unload_module()

static int unload_module ( void  )

static

Definition at line 333 of file res_ari_device_states.c.

{
    ast_ari_remove_handler(&deviceStates);
    return 0;
}

References ast_ari_remove_handler(), and deviceStates.

Referenced by load_module().

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "RESTful API module - Device state resources" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .requires = "res_ari,res_ari_model,res_stasis,res_stasis_device_state", }

static

Definition at line 358 of file res_ari_device_states.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 358 of file res_ari_device_states.c.

deviceStates

struct stasis_rest_handlers deviceStates

static

REST handler for /api-docs/deviceStates.json.

Definition at line 324 of file res_ari_device_states.c.

                                                  {
    .path_segment = "deviceStates",
    .callbacks = {
        [AST_HTTP_GET] = ast_ari_device_states_list_cb,
    },
    .num_children = 1,
    .children = { &deviceStates_deviceName, }
};

Referenced by load_module(), and unload_module().

deviceStates_deviceName

struct stasis_rest_handlers deviceStates_deviceName

static

REST handler for /api-docs/deviceStates.json.

Definition at line 312 of file res_ari_device_states.c.

                                                             {
    .path_segment = "deviceName",
    .is_wildcard = 1,
    .callbacks = {
        [AST_HTTP_GET] = ast_ari_device_states_get_cb,
        [AST_HTTP_PUT] = ast_ari_device_states_update_cb,
        [AST_HTTP_DELETE] = ast_ari_device_states_delete_cb,
    },
    .num_children = 0,
    .children = {  }
};