Asterisk - The Open Source Telephony Project GIT-master-7e7a603
Data Structures | Macros | Functions
aeap.c File Reference
#include "asterisk.h"
#include <pthread.h>
#include "asterisk/astobj2.h"
#include "asterisk/strings.h"
#include "asterisk/res_aeap.h"
#include "asterisk/res_aeap_message.h"
#include "logger.h"
#include "transaction.h"
#include "transport.h"
Include dependency graph for aeap.c:

Go to the source code of this file.

Data Structures

struct  aeap_user_data
 
struct  ast_aeap
 

Macros

#define AEAP_RECV_SIZE   32768
 
#define USER_DATA_BUCKETS   11
 

Functions

static void aeap_destructor (void *obj)
 
static void * aeap_receive (void *data)
 
static int aeap_send (struct ast_aeap *aeap, const void *buf, uintmax_t size, enum AST_AEAP_DATA_TYPE type)
 
static struct aeap_user_dataaeap_user_data_create (const char *id, void *obj, ast_aeap_user_obj_cleanup cleanup)
 
 AO2_STRING_FIELD_CMP_FN (aeap_user_data, id)
 
 AO2_STRING_FIELD_HASH_FN (aeap_user_data, id)
 
int ast_aeap_connect (struct ast_aeap *aeap, const char *url, const char *protocol, int timeout)
 Connect to an external application. More...
 
struct ast_aeapast_aeap_create (const char *transport_type, const struct ast_aeap_params *params)
 Create an Asterisk external application object. More...
 
struct ast_aeapast_aeap_create_and_connect (const char *type, const struct ast_aeap_params *params, const char *url, const char *protocol, int timeout)
 Create and connect to an Asterisk external application. More...
 
int ast_aeap_disconnect (struct ast_aeap *aeap)
 Disconnect an Asterisk external application object. More...
 
int ast_aeap_send_binary (struct ast_aeap *aeap, const void *buf, uintmax_t size)
 Send a binary data to an external application. More...
 
int ast_aeap_send_msg (struct ast_aeap *aeap, struct ast_aeap_message *msg)
 Send a message to an external application. More...
 
int ast_aeap_send_msg_tsx (struct ast_aeap *aeap, struct ast_aeap_tsx_params *params)
 Send a transaction based message to an external application using the given parameters. More...
 
void * ast_aeap_user_data_object_by_id (struct ast_aeap *aeap, const char *id)
 Retrieve a registered user data object by its id. More...
 
int ast_aeap_user_data_register (struct ast_aeap *aeap, const char *id, void *obj, ast_aeap_user_obj_cleanup cleanup)
 Register a user data object. More...
 
void ast_aeap_user_data_unregister (struct ast_aeap *aeap, const char *id)
 Un-register a user data object. More...
 
static void raise_msg (struct ast_aeap *aeap, const void *buf, intmax_t size, enum AST_AEAP_DATA_TYPE serial_type)
 
static int raise_msg_handler (struct ast_aeap *aeap, const struct ast_aeap_message_handler *handlers, size_t size, struct ast_aeap_message *msg, void *data)
 
static int tsx_end (void *obj, void *arg, int flags)
 

Macro Definition Documentation

◆ AEAP_RECV_SIZE

#define AEAP_RECV_SIZE   32768

Definition at line 33 of file aeap.c.

◆ USER_DATA_BUCKETS

#define USER_DATA_BUCKETS   11

Definition at line 45 of file aeap.c.

Function Documentation

◆ aeap_destructor()

static void aeap_destructor ( void *  obj)
static

Definition at line 67 of file aeap.c.

68{
69 struct ast_aeap *aeap = obj;
70
71 /* Disconnect things first, which keeps transactions from further executing */
73
75
76 /*
77 * Each contained transaction holds a pointer back to this transactions container,
78 * which is removed upon transaction end. Thus by explicitly ending each transaction
79 * here we can ensure all references to the transactions container are removed.
80 */
82 tsx_end, NULL);
84
86}
int ast_aeap_disconnect(struct ast_aeap *aeap)
Disconnect an Asterisk external application object.
Definition: aeap.c:381
static int tsx_end(void *obj, void *arg, int flags)
Definition: aeap.c:60
#define ao2_callback(c, flags, cb_fn, arg)
ao2_callback() is a generic function that applies cb_fn() to all objects in a container,...
Definition: astobj2.h:1693
#define ao2_cleanup(obj)
Definition: astobj2.h:1934
@ OBJ_NODATA
Definition: astobj2.h:1044
@ OBJ_MULTIPLE
Definition: astobj2.h:1049
@ OBJ_UNLINK
Definition: astobj2.h:1039
#define NULL
Definition: resample.c:96
Definition: aeap.c:47
struct aeap_transport * transport
Definition: aeap.c:55
struct ao2_container * transactions
Definition: aeap.c:53
struct ao2_container * user_data
Definition: aeap.c:51
void aeap_transport_destroy(struct aeap_transport *transport)
Destroy a transport.
Definition: transport.c:117

References aeap_transport_destroy(), ao2_callback, ao2_cleanup, ast_aeap_disconnect(), NULL, OBJ_MULTIPLE, OBJ_NODATA, OBJ_UNLINK, ast_aeap::transactions, ast_aeap::transport, tsx_end(), and ast_aeap::user_data.

Referenced by ast_aeap_create().

◆ aeap_receive()

static void * aeap_receive ( void *  data)
static

Definition at line 269 of file aeap.c.

270{
271 struct ast_aeap *aeap = data;
272 void *buf;
273
275 if (!buf) {
276 aeap_error(aeap, NULL, "unable to create read buffer");
277 goto aeap_receive_error;
278 }
279
281 enum AST_AEAP_DATA_TYPE rtype;
282 intmax_t size;
283
284 size = aeap_transport_read(aeap->transport, buf, AEAP_RECV_SIZE, &rtype);
285 if (size < 0) {
286 goto aeap_receive_error;
287 }
288
289 if (!size) {
290 continue;
291 }
292
293 switch (rtype) {
295 if (aeap->params && aeap->params->on_binary) {
296 aeap->params->on_binary(aeap, buf, size);
297 }
298 break;
300 ast_debug(3, "AEAP: received message: %s\n", (char *)buf);
301 if (aeap->params && aeap->params->on_string) {
302 aeap->params->on_string(aeap, (const char *)buf, size - 1);
303 }
304 break;
305 default:
306 break;
307 }
308
309 raise_msg(aeap, buf, size, rtype);
310 };
311
312 ast_free(buf);
313 return NULL;
314
315aeap_receive_error:
316 /*
317 * An unrecoverable error occurred so ensure the aeap and transport reset
318 * to a disconnected state. We don't want this thread to "join" itself so set
319 * its id to NULL prior to disconnecting.
320 */
321 aeap_error(aeap, NULL, "unrecoverable read error, disconnecting");
322
323 ao2_lock(aeap);
325 ao2_unlock(aeap);
326
328
329 ast_free(buf);
330
331 if (aeap->params && aeap->params->on_error) {
332 aeap->params->on_error(aeap);
333 }
334
335 return NULL;
336}
#define AEAP_RECV_SIZE
Definition: aeap.c:33
static void raise_msg(struct ast_aeap *aeap, const void *buf, intmax_t size, enum AST_AEAP_DATA_TYPE serial_type)
Definition: aeap.c:236
#define ast_free(a)
Definition: astmm.h:180
#define ast_calloc(num, len)
A wrapper for calloc()
Definition: astmm.h:202
#define ao2_unlock(a)
Definition: astobj2.h:729
#define ao2_lock(a)
Definition: astobj2.h:717
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
#define ast_debug(level,...)
Log a DEBUG message.
#define AST_PTHREADT_NULL
Definition: lock.h:66
#define aeap_error(obj, name, fmt,...)
Log an Asterisk external application error.
AST_AEAP_DATA_TYPE
Supported Asterisk external application data types.
Definition: res_aeap.h:135
@ AST_AEAP_DATA_TYPE_BINARY
Definition: res_aeap.h:137
@ AST_AEAP_DATA_TYPE_STRING
Definition: res_aeap.h:138
void(* on_string)(struct ast_aeap *aeap, const char *buf, intmax_t size)
Raised when string data is received.
Definition: res_aeap.h:180
void(* on_error)(struct ast_aeap *aeap)
Raised when an error occurs during reading.
Definition: res_aeap.h:192
void(* on_binary)(struct ast_aeap *aeap, const void *buf, intmax_t size)
Raised when binary data is received.
Definition: res_aeap.h:171
const struct ast_aeap_params * params
Definition: aeap.c:49
pthread_t read_thread_id
Definition: aeap.c:57
intmax_t aeap_transport_read(struct aeap_transport *transport, void *buf, intmax_t size, enum AST_AEAP_DATA_TYPE *rtype)
Read data from the transport.
Definition: transport.c:134
int aeap_transport_is_connected(struct aeap_transport *transport)
Whether or not the transport is in a connected state.
Definition: transport.c:85

References aeap_error, AEAP_RECV_SIZE, aeap_transport_is_connected(), aeap_transport_read(), ao2_lock, ao2_unlock, AST_AEAP_DATA_TYPE_BINARY, AST_AEAP_DATA_TYPE_STRING, ast_aeap_disconnect(), ast_calloc, ast_debug, ast_free, AST_PTHREADT_NULL, buf, NULL, ast_aeap_params::on_binary, ast_aeap_params::on_error, ast_aeap_params::on_string, ast_aeap::params, raise_msg(), ast_aeap::read_thread_id, and ast_aeap::transport.

Referenced by ast_aeap_connect().

◆ aeap_send()

static int aeap_send ( struct ast_aeap aeap,
const void *  buf,
uintmax_t  size,
enum AST_AEAP_DATA_TYPE  type 
)
static

Definition at line 404 of file aeap.c.

406{
407 intmax_t num;
408
409 num = aeap_transport_write(aeap->transport, buf, size, type);
410
411 if (num == 0) {
412 /* Nothing written, could be disconnected */
413 return 0;
414 }
415
416 if (num < 0) {
417 aeap_error(aeap, NULL, "error sending data");
418 return -1;
419 }
420
421 if (num < size) {
422 aeap_error(aeap, NULL, "not all data sent");
423 return -1;
424 }
425
426 if (num > size) {
427 aeap_error(aeap, NULL, "sent data truncated");
428 return -1;
429 }
430
431 return 0;
432}
static const char type[]
Definition: chan_ooh323.c:109
intmax_t aeap_transport_write(struct aeap_transport *transport, const void *buf, intmax_t size, enum AST_AEAP_DATA_TYPE wtype)
Write data to the transport.
Definition: transport.c:146

References aeap_error, aeap_transport_write(), buf, NULL, ast_aeap::transport, and type.

Referenced by ast_aeap_send_binary(), and ast_aeap_send_msg().

◆ aeap_user_data_create()

static struct aeap_user_data * aeap_user_data_create ( const char *  id,
void *  obj,
ast_aeap_user_obj_cleanup  cleanup 
)
static

Definition at line 127 of file aeap.c.

129{
130 struct aeap_user_data *data;
131
132 ast_assert(id != NULL);
133
134 data = ao2_t_alloc_options(sizeof(*data) + strlen(id) + 1, cleanup,
136 if (!data) {
137 if (cleanup) {
138 cleanup(obj);
139 }
140
141 return NULL;
142 }
143
144 strcpy(data->id, id); /* safe */
145 data->obj = obj;
146
147 return data;
148}
@ AO2_ALLOC_OPT_LOCK_NOLOCK
Definition: astobj2.h:367
#define ao2_t_alloc_options(data_size, destructor_fn, options, debug_msg)
Allocate and initialize an object.
Definition: astobj2.h:402
static void * cleanup(void *unused)
Definition: pbx_realtime.c:124
void * obj
Definition: aeap.c:37
char id[0]
Definition: aeap.c:39
#define ast_assert(a)
Definition: utils.h:739

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_t_alloc_options, ast_assert, cleanup(), aeap_user_data::id, NULL, and aeap_user_data::obj.

Referenced by ast_aeap_user_data_register().

◆ AO2_STRING_FIELD_CMP_FN()

AO2_STRING_FIELD_CMP_FN ( aeap_user_data  ,
id   
)

◆ AO2_STRING_FIELD_HASH_FN()

AO2_STRING_FIELD_HASH_FN ( aeap_user_data  ,
id   
)

◆ ast_aeap_connect()

int ast_aeap_connect ( struct ast_aeap aeap,
const char *  url,
const char *  protocol,
int  timeout 
)

Connect to an external application.

Parameters
aeapAn Asterisk external application object
urlThe url to connect to
protocolA protocol to use
timeoutHow long (in milliseconds) to attempt to connect (-1 equals infinite)
Returns
0 if able to connect, -1 on error

Definition at line 338 of file aeap.c.

339{
340 SCOPED_AO2LOCK(lock, aeap);
341
343 /* Should already be connected, so nothing to do */
344 return 0;
345 }
346
347 if (aeap_transport_connect(aeap->transport, url, protocol, timeout)) {
348 aeap_error(aeap, NULL, "unable to connect transport");
349 return -1;
350 }
351
353 aeap_receive, aeap)) {
354 aeap_error(aeap, NULL, "unable to start read thread: %s",
355 strerror(errno));
357 return -1;
358 }
359
360 return 0;
361}
static void * aeap_receive(void *data)
Definition: aeap.c:269
ast_mutex_t lock
Definition: app_sla.c:331
#define SCOPED_AO2LOCK(varname, obj)
scoped lock specialization for ao2 mutexes.
Definition: lock.h:604
int errno
static char url[512]
int aeap_transport_connect(struct aeap_transport *transport, const char *url, const char *protocol, int timeout)
Connect a transport.
Definition: transport.c:48
#define ast_pthread_create_background(a, b, c, d)
Definition: utils.h:592

References aeap_error, aeap_receive(), aeap_transport_connect(), aeap_transport_is_connected(), ast_aeap_disconnect(), ast_pthread_create_background, errno, lock, NULL, ast_aeap::read_thread_id, SCOPED_AO2LOCK, ast_aeap::transport, and url.

Referenced by ast_aeap_create_and_connect().

◆ ast_aeap_create()

struct ast_aeap * ast_aeap_create ( const char *  type,
const struct ast_aeap_params params 
)

Create an Asterisk external application object.

Parameters
typeThe type of underlying transport
paramsCallbacks and other parameters to use
Returns
A new ao2 reference counted aeap object, or NULL on error

Definition at line 88 of file aeap.c.

90{
91 struct ast_aeap *aeap;
92
93 aeap = ao2_alloc(sizeof(*aeap), aeap_destructor);
94 if (!aeap) {
95 ast_log(LOG_ERROR, "AEAP: unable to create");
96 return NULL;
97 }
98
99 aeap->params = params;
101
103 aeap_user_data_hash_fn, NULL, aeap_user_data_cmp_fn);
104 if (!aeap->user_data) {
105 aeap_error(aeap, NULL, "unable to create user data container");
106 ao2_ref(aeap, -1);
107 return NULL;
108 }
109
111 if (!aeap->transactions) {
112 aeap_error(aeap, NULL, "unable to create transactions container");
113 ao2_ref(aeap, -1);
114 return NULL;
115 }
116
117 aeap->transport = aeap_transport_create(transport_type);
118 if (!aeap->transport) {
119 aeap_error(aeap, NULL, "unable to create transport");
120 ao2_ref(aeap, -1);
121 return NULL;
122 }
123
124 return aeap;
125}
static void aeap_destructor(void *obj)
Definition: aeap.c:67
#define USER_DATA_BUCKETS
Definition: aeap.c:45
#define ast_log
Definition: astobj2.c:42
@ AO2_ALLOC_OPT_LOCK_MUTEX
Definition: astobj2.h:363
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
#define ao2_alloc(data_size, destructor_fn)
Definition: astobj2.h:409
#define ao2_container_alloc_hash(ao2_options, container_options, n_buckets, hash_fn, sort_fn, cmp_fn)
Allocate and initialize a hash container with the desired number of buckets.
Definition: astobj2.h:1303
#define LOG_ERROR
struct ao2_container * aeap_transactions_create(void)
Create an Asterisk external application transactions container.
Definition: transaction.c:272
struct aeap_transport * aeap_transport_create(const char *type)
Create an Asterisk external application transport.
Definition: transport.c:27

References aeap_destructor(), aeap_error, aeap_transactions_create(), aeap_transport_create(), ao2_alloc, AO2_ALLOC_OPT_LOCK_MUTEX, ao2_container_alloc_hash, ao2_ref, ast_log, AST_PTHREADT_NULL, LOG_ERROR, NULL, ast_aeap::params, ast_aeap::read_thread_id, ast_aeap::transactions, ast_aeap::transport, ast_aeap::user_data, and USER_DATA_BUCKETS.

Referenced by aeap_create(), and ast_aeap_create_and_connect().

◆ ast_aeap_create_and_connect()

struct ast_aeap * ast_aeap_create_and_connect ( const char *  type,
const struct ast_aeap_params params,
const char *  url,
const char *  protocol,
int  timeout 
)

Create and connect to an Asterisk external application.

Parameters
typeThe type of client connection to make
paramsCallbacks and other parameters to use
urlThe url to connect to
protocolA protocol to use
timeoutHow long (in milliseconds) to attempt to connect (-1 equals infinite)
Returns
A new ao2 reference counted aeap object, or NULL on error

Definition at line 363 of file aeap.c.

365{
366 struct ast_aeap *aeap;
367
368 aeap = ast_aeap_create(type, params);
369 if (!aeap) {
370 return NULL;
371 }
372
373 if (ast_aeap_connect(aeap, url, protocol, timeout)) {
374 ao2_ref(aeap, -1);
375 return NULL;
376 }
377
378 return aeap;
379}
struct ast_aeap * ast_aeap_create(const char *transport_type, const struct ast_aeap_params *params)
Create an Asterisk external application object.
Definition: aeap.c:88
int ast_aeap_connect(struct ast_aeap *aeap, const char *url, const char *protocol, int timeout)
Connect to an external application.
Definition: aeap.c:338

References ao2_ref, ast_aeap_connect(), ast_aeap_create(), NULL, ast_aeap::params, type, and url.

Referenced by aeap_create(), and AST_TEST_DEFINE().

◆ ast_aeap_disconnect()

int ast_aeap_disconnect ( struct ast_aeap aeap)

Disconnect an Asterisk external application object.

Note
Depending on the underlying transport this call may block
Parameters
aeapAn Asterisk external application object
Returns
0 on success, -1 on error

Definition at line 381 of file aeap.c.

382{
383 ao2_lock(aeap);
384
386
387 if (aeap->read_thread_id != AST_PTHREADT_NULL) {
388 /*
389 * The read thread calls disconnect if an error occurs, so
390 * unlock the aeap before "joining" to avoid a deadlock.
391 */
392 ao2_unlock(aeap);
393 pthread_join(aeap->read_thread_id, NULL);
394 ao2_lock(aeap);
395
397 }
398
399 ao2_unlock(aeap);
400
401 return 0;
402}
int aeap_transport_disconnect(struct aeap_transport *transport)
Disconnect a transport.
Definition: transport.c:94

References aeap_transport_disconnect(), ao2_lock, ao2_unlock, AST_PTHREADT_NULL, NULL, ast_aeap::read_thread_id, and ast_aeap::transport.

Referenced by aeap_destructor(), aeap_receive(), and ast_aeap_connect().

◆ ast_aeap_send_binary()

int ast_aeap_send_binary ( struct ast_aeap aeap,
const void *  buf,
uintmax_t  size 
)

Send a binary data to an external application.

Parameters
aeapAn Asterisk external application object
bufBinary data to send
sizeThe size of the binary data
Returns
0 on success, -1 on error

Definition at line 434 of file aeap.c.

435{
436 return aeap_send(aeap, buf, size, AST_AEAP_DATA_TYPE_BINARY);
437}
static int aeap_send(struct ast_aeap *aeap, const void *buf, uintmax_t size, enum AST_AEAP_DATA_TYPE type)
Definition: aeap.c:404

References aeap_send(), AST_AEAP_DATA_TYPE_BINARY, and buf.

Referenced by speech_aeap_engine_write().

◆ ast_aeap_send_msg()

int ast_aeap_send_msg ( struct ast_aeap aeap,
struct ast_aeap_message msg 
)

Send a message to an external application.

Note
"Steals" the given message reference, thus callers are not required to un-ref the message object after calling this function.
Parameters
aeapAn Asterisk external application object
msgThe message to send
Returns
0 on success, -1 on error

Definition at line 439 of file aeap.c.

440{
441 void *buf;
442 intmax_t size;
443 int res;
444
445 if (!msg) {
446 aeap_error(aeap, NULL, "no message to send");
447 return -1;
448 }
449
450 if (ast_aeap_message_serialize(msg, &buf, &size)) {
451 aeap_error(aeap, NULL, "unable to serialize outgoing message");
452 ao2_ref(msg, -1);
453 return -1;
454 }
455
456 res = aeap_send(aeap, buf, size, msg->type->serial_type);
457
458 ast_free(buf);
459 ao2_ref(msg, -1);
460
461 return res;
462}
int ast_aeap_message_serialize(const struct ast_aeap_message *message, void **buf, intmax_t *size)
Serialize the given message object into a byte/char buffer.
enum AST_AEAP_DATA_TYPE serial_type
const struct ast_aeap_message_type * type

References aeap_error, aeap_send(), ao2_ref, ast_aeap_message_serialize(), ast_free, buf, NULL, ast_aeap_message_type::serial_type, and ast_aeap_message::type.

Referenced by ast_aeap_send_msg_tsx(), handle_request_set(), and raise_msg_handler().

◆ ast_aeap_send_msg_tsx()

int ast_aeap_send_msg_tsx ( struct ast_aeap aeap,
struct ast_aeap_tsx_params params 
)

Send a transaction based message to an external application using the given parameters.

Note
"Steals" the given message reference, thus callers are not required to un-ref the message object after calling this function.
Also handles cleaning up the user object if the obj_cleanup callback is specified in "params".
Parameters
aeapAn Asterisk external application object
params(optional) Additional parameters to consider when sending. Heap allocation not required.
Returns
0 on success, -1 on error

Definition at line 464 of file aeap.c.

465{
466 struct aeap_transaction *tsx = NULL;
467 int res = 0;
468
469 if (!params) {
470 return -1;
471 }
472
473 if (!params->msg) {
475 aeap_error(aeap, NULL, "no message to send");
476 return -1;
477 }
478
479 /* The transaction will take over params cleanup, which includes the msg reference */
482 if (!tsx) {
483 return -1;
484 }
485
487 aeap_transaction_end(tsx, -1); /* Removes container, and tsx ref */
488 return -1;
489 }
490
491 if (aeap_transaction_start(tsx)) {
492 aeap_transaction_end(tsx, -1); /* Removes container, and tsx ref */
493 return -1;
494 }
495
496 res = aeap_transaction_result(tsx);
497
498 ao2_ref(tsx, -1);
499
500 return res;
501}
int ast_aeap_send_msg(struct ast_aeap *aeap, struct ast_aeap_message *msg)
Send a message to an external application.
Definition: aeap.c:439
#define ao2_bump(obj)
Bump refcount on an AO2 object by one, returning the object.
Definition: astobj2.h:480
const char * ast_aeap_message_id(const struct ast_aeap_message *message)
Retrieve a message id.
struct ast_aeap * aeap
Definition: transaction.c:34
struct ast_aeap_tsx_params params
Definition: transaction.c:46
struct ast_aeap_message * msg
Definition: res_aeap.h:333
int aeap_transaction_result(struct aeap_transaction *tsx)
Get a transaction's result.
Definition: transaction.c:222
struct aeap_transaction * aeap_transaction_create_and_add(struct ao2_container *transactions, const char *id, struct ast_aeap_tsx_params *params, struct ast_aeap *aeap)
Create a transaction object, and add it to the given container.
Definition: transaction.c:232
void aeap_transaction_end(struct aeap_transaction *tsx, int result)
End a transaction, and remove it from the given container.
Definition: transaction.c:217
int aeap_transaction_start(struct aeap_transaction *tsx)
Start the transaction.
Definition: transaction.c:198
void aeap_transaction_params_cleanup(struct ast_aeap_tsx_params *params)
Clean up parameter references, and possibly call optional user object cleanup.
Definition: transaction.c:67

References aeap_transaction::aeap, aeap_error, aeap_transaction_create_and_add(), aeap_transaction_end(), aeap_transaction_params_cleanup(), aeap_transaction_result(), aeap_transaction_start(), ao2_bump, ao2_ref, ast_aeap_message_id(), ast_aeap_send_msg(), ast_aeap_tsx_params::msg, NULL, aeap_transaction::params, and ast_aeap::transactions.

Referenced by AST_TEST_DEFINE(), and speech_aeap_send_request().

◆ ast_aeap_user_data_object_by_id()

void * ast_aeap_user_data_object_by_id ( struct ast_aeap aeap,
const char *  id 
)

Retrieve a registered user data object by its id.

Note
Depending on how it was registered the returned user data object's lifetime may be managed by the given "aeap" object. If it was registered with a cleanup handler that [potentially] frees it the caller of this function must ensure it's done using the returned object before it's unregistered.
Parameters
aeapAn Asterisk external application object
idThe look up id for the object
Returns
A user data object

Definition at line 174 of file aeap.c.

175{
176 struct aeap_user_data *data;
177 void *obj;
178
179 data = ao2_find(aeap->user_data, id, OBJ_SEARCH_KEY);
180 if (!data) {
181 return NULL;
182 }
183
184 obj = data->obj;
185 ao2_ref(data, -1);
186
187 /*
188 * Returned object's lifetime is based on how it was registered.
189 * See public function docs for more info
190 */
191 return obj;
192}
#define ao2_find(container, arg, flags)
Definition: astobj2.h:1736
@ OBJ_SEARCH_KEY
The arg parameter is a search key, but is not an object.
Definition: astobj2.h:1101

References ao2_find, ao2_ref, NULL, aeap_user_data::obj, OBJ_SEARCH_KEY, and ast_aeap::user_data.

Referenced by ast_aeap_speech_on_error(), handle_msg(), handle_request_set(), handle_string(), and handle_timeout().

◆ ast_aeap_user_data_register()

int ast_aeap_user_data_register ( struct ast_aeap aeap,
const char *  id,
void *  obj,
ast_aeap_user_obj_cleanup  cleanup 
)

Register a user data object.

Note
The "cleanup" is called on un-register, if one is specified
Parameters
aeapAn Asterisk external application object
idThe look up id for the object
objThe user object to register
cleanupOptional user object clean up callback
Returns
0 on success, -1 on error

Definition at line 150 of file aeap.c.

152{
153 struct aeap_user_data *data;
154
155 data = aeap_user_data_create(id, obj, cleanup);
156 if (!data) {
157 return -1;
158 }
159
160 if (!ao2_link(aeap->user_data, data)) {
161 ao2_ref(data, -1);
162 return -1;
163 }
164
165 ao2_ref(data, -1);
166 return 0;
167}
static struct aeap_user_data * aeap_user_data_create(const char *id, void *obj, ast_aeap_user_obj_cleanup cleanup)
Definition: aeap.c:127
#define ao2_link(container, obj)
Add an object to a container.
Definition: astobj2.h:1532

References aeap_user_data_create(), ao2_link, ao2_ref, cleanup(), aeap_user_data::obj, and ast_aeap::user_data.

Referenced by AST_TEST_DEFINE(), and speech_aeap_engine_create().

◆ ast_aeap_user_data_unregister()

void ast_aeap_user_data_unregister ( struct ast_aeap aeap,
const char *  id 
)

Un-register a user data object.

Note
If specified on register, the "cleanup" callback is called during unregister.
Parameters
aeapAn Asterisk external application object
idThe look up id for the object

Definition at line 169 of file aeap.c.

170{
172}

References ao2_find, OBJ_NODATA, OBJ_SEARCH_KEY, OBJ_UNLINK, and ast_aeap::user_data.

Referenced by AST_TEST_DEFINE().

◆ raise_msg()

static void raise_msg ( struct ast_aeap aeap,
const void *  buf,
intmax_t  size,
enum AST_AEAP_DATA_TYPE  serial_type 
)
static

Definition at line 236 of file aeap.c.

238{
239 struct ast_aeap_message *msg;
240 struct aeap_transaction *tsx;
241 int res = 0;
242
243 if (!aeap->params || !aeap->params->msg_type ||
246 return;
247 }
248
249 /* See if this msg is involved in a transaction */
251
252 /* If so go ahead and cancel the timeout timer */
254
257 msg, tsx ? aeap_transaction_user_obj(tsx) : NULL);
260 msg, tsx ? aeap_transaction_user_obj(tsx) : NULL);
261 }
262
263 /* Complete transaction (Note, removes tsx ref) */
264 aeap_transaction_end(tsx, res);
265
266 ao2_ref(msg, -1);
267}
static int raise_msg_handler(struct ast_aeap *aeap, const struct ast_aeap_message_handler *handlers, size_t size, struct ast_aeap_message *msg, void *data)
Definition: aeap.c:194
int ast_aeap_message_is_request(const struct ast_aeap_message *message)
Retrieve whether or not this is a request message.
int ast_aeap_message_is_response(const struct ast_aeap_message *message)
Retrieve whether or not this is a response message.
struct ast_aeap_message * ast_aeap_message_deserialize(const struct ast_aeap_message_type *type, const void *buf, intmax_t size)
Deserialize the given buffer into an Asterisk external application message object.
enum AST_AEAP_DATA_TYPE ast_aeap_message_serial_type(const struct ast_aeap_message_type *type)
Retrieve the serial type a message type.
Asterisk external application base message.
const struct ast_aeap_message_type * msg_type
Definition: res_aeap.h:152
uintmax_t response_handlers_size
Definition: res_aeap.h:157
uintmax_t request_handlers_size
Definition: res_aeap.h:162
const struct ast_aeap_message_handler * response_handlers
Definition: res_aeap.h:155
const struct ast_aeap_message_handler * request_handlers
Definition: res_aeap.h:160
void * aeap_transaction_user_obj(struct aeap_transaction *tsx)
Retrieve the user object associated with the transaction.
Definition: transaction.c:227
int aeap_transaction_cancel_timer(struct aeap_transaction *tsx)
Cancel the transaction timer.
Definition: transaction.c:57
struct aeap_transaction * aeap_transaction_get(struct ao2_container *transactions, const char *id)
Retrieve a transaction for the id from the container.
Definition: transaction.c:212

References aeap_transaction::aeap, aeap_transaction_cancel_timer(), aeap_transaction_end(), aeap_transaction_get(), aeap_transaction_user_obj(), ao2_ref, ast_aeap_message_deserialize(), ast_aeap_message_id(), ast_aeap_message_is_request(), ast_aeap_message_is_response(), ast_aeap_message_serial_type(), buf, ast_aeap_params::msg_type, NULL, ast_aeap::params, raise_msg_handler(), ast_aeap_params::request_handlers, ast_aeap_params::request_handlers_size, ast_aeap_params::response_handlers, ast_aeap_params::response_handlers_size, and ast_aeap::transactions.

Referenced by aeap_receive().

◆ raise_msg_handler()

static int raise_msg_handler ( struct ast_aeap aeap,
const struct ast_aeap_message_handler handlers,
size_t  size,
struct ast_aeap_message msg,
void *  data 
)
static

Definition at line 194 of file aeap.c.

196{
197 ast_aeap_on_message on_message = NULL;
198 size_t i;
199
200 if (!aeap->params->emit_error) {
201 const char *error_msg = ast_aeap_message_error_msg(msg);
202
203 if (error_msg) {
204 aeap_error(aeap, NULL, "%s", error_msg);
205 return -1;
206 }
207
208 /* If no error_msg then it's assumed this is not an error message */
209 }
210
211 for (i = 0; i < size; ++i) {
212 if (ast_strlen_zero(handlers[i].name)) {
213 /* A default handler is specified. Use it if no other match is found */
214 on_message = handlers[i].on_message;
215 continue;
216 }
217
219 on_message = handlers[i].on_message;
220 break;
221 }
222 }
223
224 if (on_message) {
225 return on_message(aeap, msg, data);
226 }
227
228 /* Respond with un-handled error */
231 "Unsupported and/or un-handled message"));
232
233 return 0;
234}
static const char name[]
Definition: format_mp3.c:68
int(* ast_aeap_on_message)(struct ast_aeap *aeap, struct ast_aeap_message *message, void *obj)
Event raised when a message is received.
Definition: res_aeap.h:101
struct ast_aeap_message * ast_aeap_message_create_error(const struct ast_aeap_message_type *type, const char *name, const char *id, const char *error_msg)
Create an Asterisk external application error response object.
const char * ast_aeap_message_name(const struct ast_aeap_message *message)
Retrieve a message name.
const char * ast_aeap_message_error_msg(const struct ast_aeap_message *message)
Retrieve the error message if it has one.
int ast_aeap_message_is_named(const struct ast_aeap_message *message, const char *name)
Check whether or not a message's name matches the given one.
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65
ast_aeap_on_message on_message
Definition: res_aeap.h:112
unsigned int emit_error
Definition: res_aeap.h:149
static const struct ast_aeap_message_handler handlers[]
Definition: test_aeap.c:135

References aeap_error, ast_aeap_message_create_error(), ast_aeap_message_error_msg(), ast_aeap_message_id(), ast_aeap_message_is_named(), ast_aeap_message_name(), ast_aeap_send_msg(), ast_strlen_zero(), ast_aeap_params::emit_error, handlers, ast_aeap_params::msg_type, name, NULL, ast_aeap_message_handler::on_message, and ast_aeap::params.

Referenced by raise_msg().

◆ tsx_end()

static int tsx_end ( void *  obj,
void *  arg,
int  flags 
)
static

Definition at line 60 of file aeap.c.

61{
62 aeap_transaction_end(obj, -1);
63
64 return 0;
65}

References aeap_transaction_end().

Referenced by aeap_destructor().