MRCPv2 Client Connection. More...
Include dependency graph for mrcp_client_connection.h:
Go to the source code of this file.
Detailed Description
MRCPv2 Client Connection.
Function Documentation
◆ mrcp_client_connection_agent_create()
| APT_BEGIN_EXTERN_C mrcp_connection_agent_t* mrcp_client_connection_agent_create | ( | const char * | id, |
| apr_size_t | max_connection_count, | ||
| apt_bool_t | offer_new_connection, | ||
| apr_pool_t * | pool | ||
| ) |
Create connection agent.
- Parameters
-
id the identifier of the agent max_connection_count the number of max MRCPv2 connections offer_new_connection the connection establishment policy in o/a pool the pool to allocate memory from
◆ mrcp_client_connection_agent_destroy()
| apt_bool_t mrcp_client_connection_agent_destroy | ( | mrcp_connection_agent_t * | agent | ) |
Destroy connection agent.
- Parameters
-
agent the agent to destroy
◆ mrcp_client_connection_agent_handler_set()
| void mrcp_client_connection_agent_handler_set | ( | mrcp_connection_agent_t * | agent, |
| void * | obj, | ||
| const mrcp_connection_event_vtable_t * | vtable | ||
| ) |
Set connection event handler.
- Parameters
-
agent the agent to set event hadler for obj the external object to associate with the agent vtable the event handler virtual methods
◆ mrcp_client_connection_agent_id_get()
| const char* mrcp_client_connection_agent_id_get | ( | const mrcp_connection_agent_t * | agent | ) |
Get string identifier.
- Parameters
-
agent the agent to get identifier of
◆ mrcp_client_connection_agent_object_get()
| void* mrcp_client_connection_agent_object_get | ( | const mrcp_connection_agent_t * | agent | ) |
Get external object.
- Parameters
-
agent the agent to get object from
◆ mrcp_client_connection_agent_start()
| apt_bool_t mrcp_client_connection_agent_start | ( | mrcp_connection_agent_t * | agent | ) |
Start connection agent and wait for incoming requests.
- Parameters
-
agent the agent to start
◆ mrcp_client_connection_agent_task_get()
| apt_task_t* mrcp_client_connection_agent_task_get | ( | const mrcp_connection_agent_t * | agent | ) |
Get task.
- Parameters
-
agent the agent to get task from
◆ mrcp_client_connection_agent_terminate()
| apt_bool_t mrcp_client_connection_agent_terminate | ( | mrcp_connection_agent_t * | agent | ) |
Terminate connection agent.
- Parameters
-
agent the agent to terminate
◆ mrcp_client_connection_max_shared_use_set()
| void mrcp_client_connection_max_shared_use_set | ( | mrcp_connection_agent_t * | agent, |
| apr_size_t | max_shared_use_count | ||
| ) |
Set max shared use count for an MRCPv2 connection.
- Parameters
-
agent the agent to set the parameter for max_shared_use_count the number of max shared use count of an MRCPv2 connection
◆ mrcp_client_connection_resource_factory_set()
| void mrcp_client_connection_resource_factory_set | ( | mrcp_connection_agent_t * | agent, |
| const mrcp_resource_factory_t * | resource_factory | ||
| ) |
Set MRCP resource factory.
- Parameters
-
agent the agent to set resource factory for resource_factory the MRCP resource factory to set
◆ mrcp_client_connection_rx_size_set()
| void mrcp_client_connection_rx_size_set | ( | mrcp_connection_agent_t * | agent, |
| apr_size_t | size | ||
| ) |
Set rx buffer size.
- Parameters
-
agent the agent to set buffer size for size the size of rx buffer to set
◆ mrcp_client_connection_timeout_set()
| void mrcp_client_connection_timeout_set | ( | mrcp_connection_agent_t * | agent, |
| apr_size_t | timeout | ||
| ) |
Set request timeout.
- Parameters
-
agent the agent to set timeout for timeout the timeout to set
◆ mrcp_client_connection_tx_size_set()
| void mrcp_client_connection_tx_size_set | ( | mrcp_connection_agent_t * | agent, |
| apr_size_t | size | ||
| ) |
Set tx buffer size.
- Parameters
-
agent the agent to set buffer size for size the size of the rx buffer to set
◆ mrcp_client_control_channel_add()
| apt_bool_t mrcp_client_control_channel_add | ( | mrcp_control_channel_t * | channel, |
| mrcp_control_descriptor_t * | descriptor | ||
| ) |
Add MRCPv2 control channel.
- Parameters
-
channel the control channel to add descriptor the control descriptor
◆ mrcp_client_control_channel_create()
| mrcp_control_channel_t* mrcp_client_control_channel_create | ( | mrcp_connection_agent_t * | agent, |
| void * | obj, | ||
| apr_pool_t * | pool | ||
| ) |
Create control channel.
- Parameters
-
agent the agent to create channel for obj the external object to associate with the control channel pool the pool to allocate memory from
◆ mrcp_client_control_channel_destroy()
| apt_bool_t mrcp_client_control_channel_destroy | ( | mrcp_control_channel_t * | channel | ) |
Destroy MRCPv2 control channel.
- Parameters
-
channel the control channel to destroy
◆ mrcp_client_control_channel_log_obj_set()
| void mrcp_client_control_channel_log_obj_set | ( | mrcp_control_channel_t * | channel, |
| void * | log_obj | ||
| ) |
Set the logger object.
- Parameters
-
channel the control channel to set the object for log_obj the object to set
◆ mrcp_client_control_channel_modify()
| apt_bool_t mrcp_client_control_channel_modify | ( | mrcp_control_channel_t * | channel, |
| mrcp_control_descriptor_t * | descriptor | ||
| ) |
Modify MRCPv2 control channel.
- Parameters
-
channel the control channel to modify descriptor the control descriptor
◆ mrcp_client_control_channel_remove()
| apt_bool_t mrcp_client_control_channel_remove | ( | mrcp_control_channel_t * | channel | ) |
Remove MRCPv2 control channel.
- Parameters
-
channel the control channel to remove
◆ mrcp_client_control_message_send()
| apt_bool_t mrcp_client_control_message_send | ( | mrcp_control_channel_t * | channel, |
| mrcp_message_t * | message | ||
| ) |
Send MRCPv2 message.
- Parameters
-
channel the control channel to send message through message the message to send
