UniMRCP  1.7.0
Functions
mrcp_server_connection.h File Reference

MRCPv2 Server Connection. More...

#include "apt_task.h"
#include "mrcp_connection_types.h"
Include dependency graph for mrcp_server_connection.h:

Go to the source code of this file.

Functions

APT_BEGIN_EXTERN_C mrcp_connection_agent_tmrcp_server_connection_agent_create (const char *id, const char *listen_ip, apr_port_t listen_port, apr_size_t max_connection_count, apt_bool_t force_new_connection, apr_pool_t *pool)
 
apt_bool_t mrcp_server_connection_agent_destroy (mrcp_connection_agent_t *agent)
 
apt_bool_t mrcp_server_connection_agent_start (mrcp_connection_agent_t *agent)
 
apt_bool_t mrcp_server_connection_agent_terminate (mrcp_connection_agent_t *agent)
 
void mrcp_server_connection_agent_handler_set (mrcp_connection_agent_t *agent, void *obj, const mrcp_connection_event_vtable_t *vtable)
 
void mrcp_server_connection_resource_factory_set (mrcp_connection_agent_t *agent, const mrcp_resource_factory_t *resource_factory)
 
void mrcp_server_connection_rx_size_set (mrcp_connection_agent_t *agent, apr_size_t size)
 
void mrcp_server_connection_tx_size_set (mrcp_connection_agent_t *agent, apr_size_t size)
 
void mrcp_server_connection_max_shared_use_set (mrcp_connection_agent_t *agent, apr_size_t max_shared_use_count)
 
void mrcp_server_connection_timeout_set (mrcp_connection_agent_t *agent, apr_size_t timeout)
 
void mrcp_server_connection_term_timeout_set (mrcp_connection_agent_t *agent, apr_size_t timeout)
 
apt_task_tmrcp_server_connection_agent_task_get (const mrcp_connection_agent_t *agent)
 
void * mrcp_server_connection_agent_object_get (const mrcp_connection_agent_t *agent)
 
const char * mrcp_server_connection_agent_id_get (const mrcp_connection_agent_t *agent)
 
mrcp_control_channel_tmrcp_server_control_channel_create (mrcp_connection_agent_t *agent, void *obj, apr_pool_t *pool)
 
apt_bool_t mrcp_server_control_channel_add (mrcp_control_channel_t *channel, mrcp_control_descriptor_t *descriptor)
 
apt_bool_t mrcp_server_control_channel_modify (mrcp_control_channel_t *channel, mrcp_control_descriptor_t *descriptor)
 
apt_bool_t mrcp_server_control_channel_remove (mrcp_control_channel_t *channel)
 
apt_bool_t mrcp_server_control_channel_destroy (mrcp_control_channel_t *channel)
 
apt_bool_t mrcp_server_control_message_send (mrcp_control_channel_t *channel, mrcp_message_t *message)
 

Detailed Description

MRCPv2 Server Connection.

Function Documentation

◆ mrcp_server_connection_agent_create()

APT_BEGIN_EXTERN_C mrcp_connection_agent_t* mrcp_server_connection_agent_create ( const char *  id,
const char *  listen_ip,
apr_port_t  listen_port,
apr_size_t  max_connection_count,
apt_bool_t  force_new_connection,
apr_pool_t *  pool 
)

Create connection agent.

Parameters
idthe identifier of the engine
listen_ipthe IP address to listen on
listen_portthe port to listen on
max_connection_countthe number of max MRCPv2 connections
force_new_connectionthe policy used in o/a for connection establishment
poolthe pool to allocate memory from

◆ mrcp_server_connection_agent_destroy()

apt_bool_t mrcp_server_connection_agent_destroy ( mrcp_connection_agent_t agent)

Destroy connection agent.

Parameters
agentthe agent to destroy

◆ mrcp_server_connection_agent_handler_set()

void mrcp_server_connection_agent_handler_set ( mrcp_connection_agent_t agent,
void *  obj,
const mrcp_connection_event_vtable_t vtable 
)

Set connection event handler.

Parameters
agentthe agent to set event hadler for
objthe external object to associate with the agent
vtablethe event handler virtual methods

◆ mrcp_server_connection_agent_id_get()

const char* mrcp_server_connection_agent_id_get ( const mrcp_connection_agent_t agent)

Get string identifier.

Parameters
agentthe agent to get identifier of

◆ mrcp_server_connection_agent_object_get()

void* mrcp_server_connection_agent_object_get ( const mrcp_connection_agent_t agent)

Get external object.

Parameters
agentthe agent to get object from

◆ mrcp_server_connection_agent_start()

apt_bool_t mrcp_server_connection_agent_start ( mrcp_connection_agent_t agent)

Start connection agent and wait for incoming requests.

Parameters
agentthe agent to start

◆ mrcp_server_connection_agent_task_get()

apt_task_t* mrcp_server_connection_agent_task_get ( const mrcp_connection_agent_t agent)

Get task.

Parameters
agentthe agent to get task from

◆ mrcp_server_connection_agent_terminate()

apt_bool_t mrcp_server_connection_agent_terminate ( mrcp_connection_agent_t agent)

Terminate connection agent.

Parameters
agentthe agent to terminate

◆ mrcp_server_connection_max_shared_use_set()

void mrcp_server_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
agentthe agent to set the parameter for
max_shared_use_countthe number of max shared use count of an MRCPv2 connection

◆ mrcp_server_connection_resource_factory_set()

void mrcp_server_connection_resource_factory_set ( mrcp_connection_agent_t agent,
const mrcp_resource_factory_t resource_factory 
)

Set MRCP resource factory.

Parameters
agentthe agent to set resource factory for
resource_factorythe MRCP resource factory to set

◆ mrcp_server_connection_rx_size_set()

void mrcp_server_connection_rx_size_set ( mrcp_connection_agent_t agent,
apr_size_t  size 
)

Set rx buffer size.

Parameters
agentthe agent to set buffer size for
sizethe size of rx buffer to set

◆ mrcp_server_connection_term_timeout_set()

void mrcp_server_connection_term_timeout_set ( mrcp_connection_agent_t agent,
apr_size_t  timeout 
)

Set termination timeout for an MRCPv2 connection.

Parameters
agentthe agent to set the parameter for
timeoutthe termination timeout to set in seconds

◆ mrcp_server_connection_timeout_set()

void mrcp_server_connection_timeout_set ( mrcp_connection_agent_t agent,
apr_size_t  timeout 
)

Set inactivity timeout for an MRCPv2 connection.

Parameters
agentthe agent to set the parameter for
timeoutthe inactivity timeout to set in seconds

◆ mrcp_server_connection_tx_size_set()

void mrcp_server_connection_tx_size_set ( mrcp_connection_agent_t agent,
apr_size_t  size 
)

Set tx buffer size.

Parameters
agentthe agent to set buffer size for
sizethe size of the rx buffer to set

◆ mrcp_server_control_channel_add()

apt_bool_t mrcp_server_control_channel_add ( mrcp_control_channel_t channel,
mrcp_control_descriptor_t descriptor 
)

Add MRCPv2 control channel.

Parameters
channelthe control channel to add
descriptorthe control descriptor

◆ mrcp_server_control_channel_create()

mrcp_control_channel_t* mrcp_server_control_channel_create ( mrcp_connection_agent_t agent,
void *  obj,
apr_pool_t *  pool 
)

Create control channel.

Parameters
agentthe agent to create channel for
objthe external object to associate with the control channel
poolthe pool to allocate memory from

◆ mrcp_server_control_channel_destroy()

apt_bool_t mrcp_server_control_channel_destroy ( mrcp_control_channel_t channel)

Destroy MRCPv2 control channel.

Parameters
channelthe control channel to destroy

◆ mrcp_server_control_channel_modify()

apt_bool_t mrcp_server_control_channel_modify ( mrcp_control_channel_t channel,
mrcp_control_descriptor_t descriptor 
)

Modify MRCPv2 control channel.

Parameters
channelthe control channel to modify
descriptorthe control descriptor

◆ mrcp_server_control_channel_remove()

apt_bool_t mrcp_server_control_channel_remove ( mrcp_control_channel_t channel)

Remove MRCPv2 control channel.

Parameters
channelthe control channel to remove

◆ mrcp_server_control_message_send()

apt_bool_t mrcp_server_control_message_send ( mrcp_control_channel_t channel,
mrcp_message_t message 
)

Send MRCPv2 message.

Parameters
channelthe control channel to send message through
messagethe message to send