UniMRCP  1.7.0
Typedefs | Functions
mrcp_sofiasip_task.h File Reference

Sofia-SIP Task. More...

#include "apt_task.h"
Include dependency graph for mrcp_sofiasip_task.h:

Go to the source code of this file.

Typedefs

typedef typedefAPT_BEGIN_EXTERN_C struct mrcp_sofia_task_t mrcp_sofia_task_t
 
typedef nua_t *(* create_nua_f) (void *obj, su_root_t *root)
 

Functions

mrcp_sofia_task_tmrcp_sofia_task_create (create_nua_f nua_creator, void *obj, apt_task_msg_pool_t *msg_pool, apr_pool_t *pool)
 
apt_bool_t mrcp_sofia_task_destroy (mrcp_sofia_task_t *task)
 
apt_bool_t mrcp_sofia_task_start (mrcp_sofia_task_t *task)
 
apt_bool_t mrcp_sofia_task_terminate (mrcp_sofia_task_t *task)
 
void mrcp_sofia_task_break (mrcp_sofia_task_t *task)
 
apt_task_tmrcp_sofia_task_base_get (const mrcp_sofia_task_t *task)
 
apt_task_vtable_tmrcp_sofia_task_vtable_get (const mrcp_sofia_task_t *task)
 
void * mrcp_sofia_task_object_get (const mrcp_sofia_task_t *task)
 
su_root_t * mrcp_sofia_task_su_root_get (const mrcp_sofia_task_t *task)
 
nua_t * mrcp_sofia_task_nua_get (const mrcp_sofia_task_t *task)
 

Detailed Description

Sofia-SIP Task.

Typedef Documentation

◆ create_nua_f

typedef nua_t*(* create_nua_f) (void *obj, su_root_t *root)

Function prototype to create a nua instance

◆ mrcp_sofia_task_t

typedef typedefAPT_BEGIN_EXTERN_C struct mrcp_sofia_task_t mrcp_sofia_task_t

Opaque Sofia-SIP task declaration

Function Documentation

◆ mrcp_sofia_task_base_get()

apt_task_t* mrcp_sofia_task_base_get ( const mrcp_sofia_task_t task)

Get task base.

Parameters
taskthe Sofia-SIP task to get task base from

◆ mrcp_sofia_task_break()

void mrcp_sofia_task_break ( mrcp_sofia_task_t task)

Break main loop of Sofia-SIP task.

Parameters
taskthe task to break

◆ mrcp_sofia_task_create()

mrcp_sofia_task_t* mrcp_sofia_task_create ( create_nua_f  nua_creator,
void *  obj,
apt_task_msg_pool_t msg_pool,
apr_pool_t *  pool 
)

Create Sofia-SIP task.

Parameters
nua_creatorthe nua creator method
objthe external object to pass to nua creator method
msg_poolthe pool of task messages
poolthe pool to allocate memory from

◆ mrcp_sofia_task_destroy()

apt_bool_t mrcp_sofia_task_destroy ( mrcp_sofia_task_t task)

Destroy Sofia-SIP task.

Parameters
taskthe task to destroy

◆ mrcp_sofia_task_nua_get()

nua_t* mrcp_sofia_task_nua_get ( const mrcp_sofia_task_t task)

Get nua object.

Parameters
taskthe Sofia-SIP task to get nua object from

◆ mrcp_sofia_task_object_get()

void* mrcp_sofia_task_object_get ( const mrcp_sofia_task_t task)

Get external object.

Parameters
taskthe Sofia-SIP task to get object from

◆ mrcp_sofia_task_start()

apt_bool_t mrcp_sofia_task_start ( mrcp_sofia_task_t task)

Start Sofia-SIP task.

Parameters
taskthe task to start

◆ mrcp_sofia_task_su_root_get()

su_root_t* mrcp_sofia_task_su_root_get ( const mrcp_sofia_task_t task)

Get su_root object.

Parameters
taskthe Sofia-SIP task to get su_root object from

◆ mrcp_sofia_task_terminate()

apt_bool_t mrcp_sofia_task_terminate ( mrcp_sofia_task_t task)

Terminate Sofia-SIP task.

Parameters
taskthe task to terminate

◆ mrcp_sofia_task_vtable_get()

apt_task_vtable_t* mrcp_sofia_task_vtable_get ( const mrcp_sofia_task_t task)

Get task vtable.

Parameters
taskthe Sofia-SIP task to get vtable from