Parameters to be used when sending a transaction based message. More...
#include <res_aeap.h>
Data Fields | |
| struct ast_aeap_message * | msg |
| void * | obj |
| ast_aeap_user_obj_cleanup | obj_cleanup |
| ast_aeap_on_timeout | on_timeout |
| int | timeout |
| int | wait |
Detailed Description
Parameters to be used when sending a transaction based message.
Definition at line 331 of file res_aeap.h.
Field Documentation
◆ msg
| struct ast_aeap_message* msg |
The message to send
Definition at line 333 of file res_aeap.h.
Referenced by aeap_transaction_params_cleanup(), ast_aeap_send_msg_tsx(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), speech_aeap_send_request(), and transaction_end().
◆ obj
| void* obj |
Optional user object to pass to handlers. User is responsible for object's lifetime unless an obj_cleanup callback is specified that handles its cleanup (e.g. freeing of memory).
Definition at line 345 of file res_aeap.h.
Referenced by aeap_transaction_params_cleanup(), aeap_transaction_user_obj(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), exec(), and transaction_end().
◆ obj_cleanup
| ast_aeap_user_obj_cleanup obj_cleanup |
Optional user object cleanup callback. If specified, called upon "this" param's destruction (including on error).
Definition at line 350 of file res_aeap.h.
Referenced by aeap_transaction_params_cleanup().
◆ on_timeout
| ast_aeap_on_timeout on_timeout |
Optional callback raised when no message is received in an allotted time
Definition at line 337 of file res_aeap.h.
Referenced by AST_TEST_DEFINE(), and transaction_end().
◆ timeout
| int timeout |
The amount of time (in milliseconds) to wait for a received message
Definition at line 335 of file res_aeap.h.
Referenced by AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), speech_aeap_send_request(), and transaction_sched_timer().
◆ wait
| int wait |
Whether or not to block the current thread, and wait for a received message
Definition at line 339 of file res_aeap.h.
Referenced by aeap_transaction_start(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), and exec().
The documentation for this struct was generated from the following file:
