mrcp_server_session.h File Reference

MRCP Server Session. More...

#include <apr_hash.h>
#include "mrcp_session.h"
#include "mpf_engine.h"
#include "apt_task.h"
#include "apt_obj_list.h"

Go to the source code of this file.

Data Structures
struct	mrcp_signaling_message_t
struct	mrcp_server_session_t
struct	mrcp_profile_t
Typedefs
typedef typedefAPT_BEGIN_EXTERN_C struct mrcp_channel_t	mrcp_channel_t
typedef struct mrcp_server_session_t	mrcp_server_session_t
typedef struct mrcp_signaling_message_t	mrcp_signaling_message_t
Enumerations
enum	mrcp_signaling_message_type_e { SIGNALING_MESSAGE_OFFER, SIGNALING_MESSAGE_CONTROL, SIGNALING_MESSAGE_TERMINATE }
enum	mrcp_server_session_state_e {   SESSION_STATE_NONE, SESSION_STATE_GENERATING_ANSWER, SESSION_STATE_INITIALIZING, SESSION_STATE_DEACTIVATING,   SESSION_STATE_TERMINATING }
Functions
mrcp_server_session_t *	mrcp_server_session_create (void)
apt_bool_t	mrcp_server_signaling_message_process (mrcp_signaling_message_t *signaling_message)
apt_bool_t	mrcp_server_mpf_message_process (mpf_message_container_t *mpf_message_container)
apt_bool_t	mrcp_server_on_channel_modify (mrcp_channel_t *channel, mrcp_control_descriptor_t *answer, apt_bool_t status)
apt_bool_t	mrcp_server_on_channel_remove (mrcp_channel_t *channel, apt_bool_t status)
apt_bool_t	mrcp_server_on_channel_message (mrcp_channel_t *channel, mrcp_message_t *message)
apt_bool_t	mrcp_server_on_disconnect (mrcp_channel_t *channel)
apt_bool_t	mrcp_server_on_engine_channel_open (mrcp_channel_t *channel, apt_bool_t status)
apt_bool_t	mrcp_server_on_engine_channel_close (mrcp_channel_t *channel)
apt_bool_t	mrcp_server_on_engine_channel_message (mrcp_channel_t *channel, mrcp_message_t *message)
mrcp_session_t *	mrcp_server_channel_session_get (mrcp_channel_t *channel)

---

Detailed Description

MRCP Server Session.

---

Typedef Documentation

typedef typedefAPT_BEGIN_EXTERN_C struct mrcp_channel_t mrcp_channel_t

Opaque MRCP channel declaration

typedef struct mrcp_server_session_t mrcp_server_session_t

MRCP server session declaration

typedef struct mrcp_signaling_message_t mrcp_signaling_message_t

MRCP signaling message declaration

---

Enumeration Type Documentation

enum mrcp_server_session_state_e

Server session states

Enumerator:

SESSION_STATE_NONE	initial state
SESSION_STATE_GENERATING_ANSWER	received offer, generating answer now
SESSION_STATE_INITIALIZING	answer is ready, finally initializing channels now
SESSION_STATE_DEACTIVATING	received session termination request, deinitializing channels now
SESSION_STATE_TERMINATING	finally terminating session

enum mrcp_signaling_message_type_e

Enumeration of signaling task messages

---

Function Documentation

mrcp_session_t* mrcp_server_channel_session_get

(

mrcp_channel_t *

channel

)

Get session by channel

apt_bool_t mrcp_server_mpf_message_process

(

mpf_message_container_t *

mpf_message_container

)

Process MPF message

apt_bool_t mrcp_server_on_channel_message	(	mrcp_channel_t *	channel,
		mrcp_message_t *	message
	)

Process channel message receive

apt_bool_t mrcp_server_on_channel_modify	(	mrcp_channel_t *	channel,
		mrcp_control_descriptor_t *	answer,
		apt_bool_t	status
	)

Process channel modify event

apt_bool_t mrcp_server_on_channel_remove	(	mrcp_channel_t *	channel,
		apt_bool_t	status
	)

Process channel remove event

apt_bool_t mrcp_server_on_disconnect

(

mrcp_channel_t *

channel

)

Process connection disconnect event

apt_bool_t mrcp_server_on_engine_channel_close

(

mrcp_channel_t *

channel

)

Process channel close event

apt_bool_t mrcp_server_on_engine_channel_message	(	mrcp_channel_t *	channel,
		mrcp_message_t *	message
	)

Process message receive event

apt_bool_t mrcp_server_on_engine_channel_open	(	mrcp_channel_t *	channel,
		apt_bool_t	status
	)

Process channel open event

mrcp_server_session_t* mrcp_server_session_create

(

void

)

Create server session

apt_bool_t mrcp_server_signaling_message_process

(

mrcp_signaling_message_t *

signaling_message

)

Process signaling message