resource_events.c File Reference

/api-docs/events.{format} implementation- WebSocket resource More...

#include "asterisk.h"
#include "resource_events.h"
#include "internal.h"
#include "asterisk/stasis_app.h"
#include "asterisk/stasis_app_broadcast.h"

Include dependency graph for resource_events.c:

Go to the source code of this file.

Functions
void	ast_ari_events_claim_channel (struct ast_variable *headers, struct ast_ari_events_claim_channel_args *args, struct ast_ari_response *response)
	Claim a broadcast channel for this application.
void	ast_ari_events_user_event (struct ast_variable *headers, struct ast_ari_events_user_event_args *args, struct ast_ari_response *response)
	Generate a user event.

Detailed Description

/api-docs/events.{format} implementation- WebSocket resource

Author

David M. Lee, II dlee@.nosp@m.digi.nosp@m.um.co.nosp@m.m

Definition in file resource_events.c.

Function Documentation

ast_ari_events_claim_channel()

void ast_ari_events_claim_channel	(	struct ast_variable *	headers,
		struct ast_ari_events_claim_channel_args *	args,
		struct ast_ari_response *	response
	)

Claim a broadcast channel for this application.

Atomically claims a channel that is in broadcast state. Only the first claim succeeds.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 92 of file resource_events.c.

{
    int res;
 
    if (ast_strlen_zero(args->channel_id)) {
        ast_ari_response_error(response, 400, "Bad Request",
            "channelId parameter is required");
        return;
    }
 
    if (ast_strlen_zero(args->application)) {
        ast_ari_response_error(response, 400, "Bad Request",
            "application parameter is required");
        return;
    }
 
    res = stasis_app_claim_channel(args->channel_id, args->application);
 
    switch (res) {
    case 0:
        /* Success */
        ast_ari_response_no_content(response);
        break;
    case -1:
        /* Channel not found */
        ast_ari_response_error(response, 404, "Not Found",
            "Channel not found or not in broadcast state");
        break;
    case -2:
        /* Already claimed */
        ast_ari_response_error(response, 409, "Conflict",
            "Channel has already been claimed by another application");
        break;
    case AST_OPTIONAL_API_UNAVAILABLE:
        /* Module not loaded */
        ast_ari_response_error(response, 501, "Not Implemented",
            "Broadcast functionality not available (res_stasis_broadcast not loaded)");
        break;
    default:
        ast_ari_response_error(response, 500, "Internal Server Error",
            "Failed to claim channel");
        break;
    }
}

References args, ast_ari_response_error(), ast_ari_response_no_content(), AST_OPTIONAL_API_UNAVAILABLE, ast_strlen_zero(), and stasis_app_claim_channel().

Referenced by ast_ari_events_claim_channel_cb().

ast_ari_events_user_event()

void ast_ari_events_user_event	(	struct ast_variable *	headers,
		struct ast_ari_events_user_event_args *	args,
		struct ast_ari_response *	response
	)

Generate a user event.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 37 of file resource_events.c.

{
    enum stasis_app_user_event_res res;
    struct ast_json *json_variables = NULL;
 
    if (args->variables) {
        ast_ari_events_user_event_parse_body(args->variables, args);
        json_variables = ast_json_object_get(args->variables, "variables");
    }
 
    if (ast_strlen_zero(args->application)) {
        ast_ari_response_error(response, 400, "Bad Request",
            "Missing parameter application");
        return;
    }
 
    res = stasis_app_user_event(args->application,
        args->event_name,
        args->source, args->source_count,
        json_variables);
 
    switch (res) {
    case STASIS_APP_USER_OK:
        ast_ari_response_no_content(response);
        break;
 
    case STASIS_APP_USER_APP_NOT_FOUND:
        ast_ari_response_error(response, 404, "Not Found",
            "Application not found");
        break;
 
    case STASIS_APP_USER_EVENT_SOURCE_NOT_FOUND:
        ast_ari_response_error(response, 422, "Unprocessable Entity",
            "Event source was not found");
        break;
 
    case STASIS_APP_USER_EVENT_SOURCE_BAD_SCHEME:
        ast_ari_response_error(response, 400, "Bad Request",
            "Invalid event source URI scheme");
        break;
 
    case STASIS_APP_USER_USEREVENT_INVALID:
        ast_ari_response_error(response, 400, "Bad Request",
            "Invalid userevent data");
        break;
 
    case STASIS_APP_USER_INTERNAL_ERROR:
    default:
        ast_ari_response_error(response, 500, "Internal Server Error",
            "Error processing request");
    }
}

References args, ast_ari_events_user_event_parse_body(), ast_ari_response_error(), ast_ari_response_no_content(), ast_json_object_get(), ast_strlen_zero(), NULL, STASIS_APP_USER_APP_NOT_FOUND, stasis_app_user_event(), STASIS_APP_USER_EVENT_SOURCE_BAD_SCHEME, STASIS_APP_USER_EVENT_SOURCE_NOT_FOUND, STASIS_APP_USER_INTERNAL_ERROR, STASIS_APP_USER_OK, and STASIS_APP_USER_USEREVENT_INVALID.

Referenced by ast_ari_events_user_event_cb().