ari_ws_session Struct Reference

#include <ari_websockets.h>

Collaboration diagram for ari_ws_session:

Data Fields
char *	app_name
struct ast_websocket *	ast_ws_session
char *	channel_id
char *	channel_name
int	closing
int	connected
struct {
size_t   current
struct ast_json **   elems
size_t   max
}	message_queue
struct ari_conf_outbound_websocket *	owc
char *	remote_addr
char	session_id []
int	stasis_end_sent
int	subscribe_all
pthread_t	thread
enum ast_websocket_type	type
int(*	validator )(struct ast_json *)
struct ast_vector_string	websocket_apps

Detailed Description

Definition at line 50 of file ari_websockets.h.

Field Documentation

app_name

char* app_name

The name of the Stasis application.

Definition at line 58 of file ari_websockets.h.

Referenced by websocket_established_cb().

ast_ws_session

struct ast_websocket* ast_ws_session

The parent websocket session.

Definition at line 52 of file ari_websockets.h.

Referenced by session_update(), and websocket_established_cb().

channel_id

char* channel_id

The channel id for per-call websocket.

Definition at line 62 of file ari_websockets.h.

channel_name

char* channel_name

The channel name for per-call websocket.

Definition at line 63 of file ari_websockets.h.

closing

int closing

Flag indicating if the session is closing.

Definition at line 66 of file ari_websockets.h.

connected

int connected

Flag indicating if the websocket is connected.

Definition at line 65 of file ari_websockets.h.

Referenced by websocket_established_cb().

current

size_t current

Definition at line 57 of file ari_websockets.h.

elems

struct ast_json* * elems

Definition at line 57 of file ari_websockets.h.

max

size_t max

Definition at line 57 of file ari_websockets.h.

struct { ... } message_queue

Container for holding delayed messages.

Referenced by session_update().

owc

struct ari_conf_outbound_websocket* owc

The outbound websocket configuration.

Definition at line 60 of file ari_websockets.h.

Referenced by outbound_session_create().

remote_addr

char* remote_addr

The remote address.

Definition at line 59 of file ari_websockets.h.

Referenced by session_update().

session_id

char session_id[]

The id for the websocket session.

Definition at line 67 of file ari_websockets.h.

Referenced by ari_websocket_get_session(), session_create(), and websocket_attempted_cb().

stasis_end_sent

int stasis_end_sent

Flag indicating if the StasisEnd message was sent.

Definition at line 64 of file ari_websockets.h.

subscribe_all

int subscribe_all

Flag indicating if all events are subscribed to.

Definition at line 56 of file ari_websockets.h.

thread

pthread_t thread

The thread that handles the websocket.

Definition at line 61 of file ari_websockets.h.

type

enum ast_websocket_type type

The type of websocket session.

Definition at line 51 of file ari_websockets.h.

Referenced by Property::load().

validator

int(* validator) (struct ast_json *)

The message validator.

Definition at line 53 of file ari_websockets.h.

websocket_apps

struct ast_vector_string websocket_apps

List of Stasis apps registered to the websocket session.

Definition at line 54 of file ari_websockets.h.

Referenced by session_update().

---

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

• ari_websockets.h