stasis_rest_handlers Struct Reference

Handler for a single RESTful path segment. More...

#include <ari.h>

Collaboration diagram for stasis_rest_handlers:

Data Fields
union {
int   is_websocket
struct ast_websocket_server *   ws_server
};
stasis_rest_callback	callbacks [AST_HTTP_MAX_METHOD]
struct stasis_rest_handlers *	children []
int	is_wildcard
size_t	num_children
const char *	path_segment

Detailed Description

Handler for a single RESTful path segment.

Definition at line 69 of file ari.h.

Field Documentation

[union]

union { ... }

ws_server is no longer needed to indicate if a path should cause an Upgrade to websocket but is kept for backwards compatability. Instead, simply set is_websocket to true.

callbacks

stasis_rest_callback callbacks[AST_HTTP_MAX_METHOD]

Callbacks for all handled HTTP methods.

Definition at line 80 of file ari.h.

children

struct stasis_rest_handlers* children[]

Handlers for sub-paths

Definition at line 95 of file ari.h.

Referenced by ast_ari_invoke(), and ast_ari_remove_handler().

is_websocket

int is_websocket

The path segment is handled by the websocket

Definition at line 90 of file ari.h.

Referenced by load_module().

is_wildcard

int is_wildcard

If true (non-zero), path_segment is a wildcard, and will match all values.

Value of the segement will be passed into the path_vars parameter of the callback.

Definition at line 78 of file ari.h.

Referenced by ast_ari_invoke().

num_children

size_t num_children

Number of children in the children array

Definition at line 93 of file ari.h.

Referenced by ast_ari_add_handler(), ast_ari_invoke(), and ast_ari_remove_handler().

path_segment

const char* path_segment

Path segement to handle

Definition at line 71 of file ari.h.

Referenced by ast_ari_invoke().

ws_server

struct ast_websocket_server* ws_server

Deprecated:

WebSocket server for handling WebSocket upgrades.

Definition at line 88 of file ari.h.

---

The documentation for this struct was generated from the following file:

• ari.h