mrcp_client_connection.h File Reference

MRCPv2 Client Connection. More...

#include "apt_task.h"
#include "mrcp_connection_types.h"

Go to the source code of this file.

Functions

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)
apt_bool_t mrcp_client_connection_agent_destroy (mrcp_connection_agent_t *agent)
apt_bool_t mrcp_client_connection_agent_start (mrcp_connection_agent_t *agent)
apt_bool_t mrcp_client_connection_agent_terminate (mrcp_connection_agent_t *agent)
void mrcp_client_connection_agent_handler_set (mrcp_connection_agent_t *agent, void *obj, const mrcp_connection_event_vtable_t *vtable)
void mrcp_client_connection_resource_factory_set (mrcp_connection_agent_t *agent, const mrcp_resource_factory_t *resource_factory)
void mrcp_client_connection_rx_size_set (mrcp_connection_agent_t *agent, apr_size_t size)
void mrcp_client_connection_tx_size_set (mrcp_connection_agent_t *agent, apr_size_t size)
void mrcp_client_connection_timeout_set (mrcp_connection_agent_t *agent, apr_size_t timeout)
apt_task_t * mrcp_client_connection_agent_task_get (const mrcp_connection_agent_t *agent)
void * mrcp_client_connection_agent_object_get (const mrcp_connection_agent_t *agent)
const char * mrcp_client_connection_agent_id_get (const mrcp_connection_agent_t *agent)
mrcp_control_channel_t * mrcp_client_control_channel_create (mrcp_connection_agent_t *agent, void *obj, apr_pool_t *pool)
apt_bool_t mrcp_client_control_channel_add (mrcp_control_channel_t *channel, mrcp_control_descriptor_t *descriptor)
apt_bool_t mrcp_client_control_channel_modify (mrcp_control_channel_t *channel, mrcp_control_descriptor_t *descriptor)
apt_bool_t mrcp_client_control_channel_remove (mrcp_control_channel_t *channel)
apt_bool_t mrcp_client_control_channel_destroy (mrcp_control_channel_t *channel)
apt_bool_t mrcp_client_control_message_send (mrcp_control_channel_t *channel, mrcp_message_t *message)
void mrcp_client_control_channel_log_obj_set (mrcp_control_channel_t *channel, void *log_obj)

Detailed Description

MRCPv2 Client Connection.

Function Documentation

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
apt_bool_t mrcp_client_connection_agent_destroy ( mrcp_connection_agent_t *  agent  ) 

Destroy connection agent.

Parameters:
agent the agent to destroy
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
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
void* mrcp_client_connection_agent_object_get ( const mrcp_connection_agent_t *  agent  ) 

Get external object.

Parameters:
agent the agent to get object from
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
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
apt_bool_t mrcp_client_connection_agent_terminate ( mrcp_connection_agent_t *  agent  ) 

Terminate connection agent.

Parameters:
agent the agent to terminate
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
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
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
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
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_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
apt_bool_t mrcp_client_control_channel_destroy ( mrcp_control_channel_t *  channel  ) 

Destroy MRCPv2 control channel.

Parameters:
channel the control channel to destroy
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
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
apt_bool_t mrcp_client_control_channel_remove ( mrcp_control_channel_t *  channel  ) 

Remove MRCPv2 control channel.

Parameters:
channel the control channel to remove
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
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines
Generated on 25 Mar 2013 for UniMRCP by  doxygen 1.6.1