Main Page | Modules | Class Hierarchy | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

switch_module_interfaces.h File Reference


Detailed Description

Module Interface Definitions.

This module holds the definition of data abstractions used to implement various pluggable interfaces and pluggable event handlers.


Data Structures

struct  switch_state_handler_table
struct  switch_stream_handle
struct  switch_io_routines
 A table of i/o routines that an endpoint interface can implement. More...
struct  switch_endpoint_interface
 Abstraction of an module endpoint interface This is the glue between the abstract idea of a "channel" and what is really going on under the hood. Each endpoint module fills out one of these tables and makes it available when a channel is created of it's paticular type. More...
struct  switch_timer
 Abstract handler to a timer module. More...
struct  switch_timer_interface
 A table of functions that a timer module implements. More...
struct  switch_dialplan_interface
 Abstract interface to a dialplan module. More...
struct  switch_file_interface
 Abstract interface to a file format module. More...
struct  switch_file_handle
struct  switch_asr_interface
 Abstract interface to an asr module. More...
struct  switch_asr_handle
struct  switch_speech_interface
 Abstract interface to a speech module. More...
struct  switch_speech_handle
struct  switch_say_interface
 Abstract interface to a say module. More...
struct  switch_chat_interface
 Abstract interface to a chat module. More...
struct  switch_management_interface
 Abstract interface to a management module. More...
struct  switch_directory_interface
 Abstract interface to a directory module. More...
struct  switch_directory_handle
struct  switch_codec_settings
 Various codec settings (currently only relevant to speex). More...
struct  switch_codec
struct  switch_codec_implementation
 A table of settings and callbacks that define a paticular implementation of a codec. More...
struct  switch_codec_interface
 Top level module interface to implement a series of codec implementations. More...
struct  switch_application_interface
 A module interface to implement an application. More...
struct  switch_api_interface
 A module interface to implement an api function. More...

Typedefs

typedef switch_call_cause_t(* switch_io_outgoing_channel_t )(switch_core_session_t *, switch_event_t *, switch_caller_profile_t *, switch_core_session_t **, switch_memory_pool_t **, switch_originate_flag_t)
typedef switch_status_t(* switch_io_read_frame_t )(switch_core_session_t *, switch_frame_t **, switch_io_flag_t, int)
typedef switch_status_t(* switch_io_write_frame_t )(switch_core_session_t *, switch_frame_t *, switch_io_flag_t, int)
typedef switch_status_t(* switch_io_kill_channel_t )(switch_core_session_t *, int)
typedef switch_status_t(* switch_io_send_dtmf_t )(switch_core_session_t *, const switch_dtmf_t *)
typedef switch_status_t(* switch_io_receive_message_t )(switch_core_session_t *, switch_core_session_message_t *)
typedef switch_status_t(* switch_io_receive_event_t )(switch_core_session_t *, switch_event_t *)
typedef switch_status_t(* switch_io_state_change_t )(switch_core_session_t *)
typedef switch_status_t(* switch_io_read_video_frame_t )(switch_core_session_t *, switch_frame_t **, switch_io_flag_t, int)
typedef switch_status_t(* switch_io_write_video_frame_t )(switch_core_session_t *, switch_frame_t *, switch_io_flag_t, int)
typedef switch_call_cause_t(* switch_io_resurrect_session_t )(switch_core_session_t **, switch_memory_pool_t **, void *)

Enumerations

enum  switch_state_handler_name_t {
  SWITCH_SHN_ON_INIT, SWITCH_SHN_ON_ROUTING, SWITCH_SHN_ON_EXECUTE, SWITCH_SHN_ON_HANGUP,
  SWITCH_SHN_ON_EXCHANGE_MEDIA, SWITCH_SHN_ON_SOFT_EXECUTE, SWITCH_SHN_ON_CONSUME_MEDIA, SWITCH_SHN_ON_HIBERNATE,
  SWITCH_SHN_ON_RESET, SWITCH_SHN_ON_PARK
}
 A table of functions to execute at various states. More...
enum  switch_io_routine_name_t {
  SWITCH_IO_OUTGOING_CHANNEL, SWITCH_IO_READ_FRAME, SWITCH_IO_WRITE_FRAME, SWITCH_IO_KILL_CHANNEL,
  SWITCH_IO_SEND_DTMF, SWITCH_IO_RECEIVE_MESSAGE, SWITCH_IO_RECEIVE_EVENT, SWITCH_IO_STATE_CHANGE,
  SWITCH_IO_READ_VIDEO_FRAME, SWITCH_IO_WRITE_VIDEO_FRAME, SWITCH_IO_RESURRECT_SESSION
}
enum  switch_timer_func_name_t {
  SWITCH_TIMER_FUNC_TIMER_INIT, SWITCH_TIMER_FUNC_TIMER_NEXT, SWITCH_TIMER_FUNC_TIMER_STEP, SWITCH_TIMER_FUNC_TIMER_SYNC,
  SWITCH_TIMER_FUNC_TIMER_CHECK, SWITCH_TIMER_FUNC_TIMER_DESTROY
}


Typedef Documentation

typedef switch_status_t(* switch_io_kill_channel_t)(switch_core_session_t *, int)
 

typedef switch_call_cause_t(* switch_io_outgoing_channel_t)(switch_core_session_t *, switch_event_t *, switch_caller_profile_t *, switch_core_session_t **, switch_memory_pool_t **, switch_originate_flag_t)
 

typedef switch_status_t(* switch_io_read_frame_t)(switch_core_session_t *, switch_frame_t **, switch_io_flag_t, int)
 

typedef switch_status_t(* switch_io_read_video_frame_t)(switch_core_session_t *, switch_frame_t **, switch_io_flag_t, int)
 

typedef switch_status_t(* switch_io_receive_event_t)(switch_core_session_t *, switch_event_t *)
 

typedef switch_status_t(* switch_io_receive_message_t)(switch_core_session_t *, switch_core_session_message_t *)
 

typedef switch_call_cause_t(* switch_io_resurrect_session_t)(switch_core_session_t **, switch_memory_pool_t **, void *)
 

typedef switch_status_t(* switch_io_send_dtmf_t)(switch_core_session_t *, const switch_dtmf_t *)
 

typedef switch_status_t(* switch_io_state_change_t)(switch_core_session_t *)
 

typedef switch_status_t(* switch_io_write_frame_t)(switch_core_session_t *, switch_frame_t *, switch_io_flag_t, int)
 

typedef switch_status_t(* switch_io_write_video_frame_t)(switch_core_session_t *, switch_frame_t *, switch_io_flag_t, int)
 


Enumeration Type Documentation

enum switch_io_routine_name_t
 

Enumeration values:
SWITCH_IO_OUTGOING_CHANNEL 
SWITCH_IO_READ_FRAME 
SWITCH_IO_WRITE_FRAME 
SWITCH_IO_KILL_CHANNEL 
SWITCH_IO_SEND_DTMF 
SWITCH_IO_RECEIVE_MESSAGE 
SWITCH_IO_RECEIVE_EVENT 
SWITCH_IO_STATE_CHANGE 
SWITCH_IO_READ_VIDEO_FRAME 
SWITCH_IO_WRITE_VIDEO_FRAME 
SWITCH_IO_RESURRECT_SESSION 
00115              {
00116         SWITCH_IO_OUTGOING_CHANNEL,
00117         SWITCH_IO_READ_FRAME,
00118         SWITCH_IO_WRITE_FRAME,
00119         SWITCH_IO_KILL_CHANNEL,
00120         SWITCH_IO_SEND_DTMF,
00121         SWITCH_IO_RECEIVE_MESSAGE,
00122         SWITCH_IO_RECEIVE_EVENT,
00123         SWITCH_IO_STATE_CHANGE,
00124         SWITCH_IO_READ_VIDEO_FRAME,
00125         SWITCH_IO_WRITE_VIDEO_FRAME,
00126         SWITCH_IO_RESURRECT_SESSION
00127 } switch_io_routine_name_t;

enum switch_state_handler_name_t
 

A table of functions to execute at various states.

Enumeration values:
SWITCH_SHN_ON_INIT 
SWITCH_SHN_ON_ROUTING 
SWITCH_SHN_ON_EXECUTE 
SWITCH_SHN_ON_HANGUP 
SWITCH_SHN_ON_EXCHANGE_MEDIA 
SWITCH_SHN_ON_SOFT_EXECUTE 
SWITCH_SHN_ON_CONSUME_MEDIA 
SWITCH_SHN_ON_HIBERNATE 
SWITCH_SHN_ON_RESET 
SWITCH_SHN_ON_PARK 
00049              {
00050         SWITCH_SHN_ON_INIT,
00051         SWITCH_SHN_ON_ROUTING,
00052         SWITCH_SHN_ON_EXECUTE,
00053         SWITCH_SHN_ON_HANGUP,
00054         SWITCH_SHN_ON_EXCHANGE_MEDIA,
00055         SWITCH_SHN_ON_SOFT_EXECUTE,
00056         SWITCH_SHN_ON_CONSUME_MEDIA,
00057         SWITCH_SHN_ON_HIBERNATE,
00058         SWITCH_SHN_ON_RESET,
00059         SWITCH_SHN_ON_PARK
00060 } switch_state_handler_name_t;

enum switch_timer_func_name_t
 

Enumeration values:
SWITCH_TIMER_FUNC_TIMER_INIT 
SWITCH_TIMER_FUNC_TIMER_NEXT 
SWITCH_TIMER_FUNC_TIMER_STEP 
SWITCH_TIMER_FUNC_TIMER_SYNC 
SWITCH_TIMER_FUNC_TIMER_CHECK 
SWITCH_TIMER_FUNC_TIMER_DESTROY 
00200              {
00201         SWITCH_TIMER_FUNC_TIMER_INIT,
00202         SWITCH_TIMER_FUNC_TIMER_NEXT,
00203         SWITCH_TIMER_FUNC_TIMER_STEP,
00204         SWITCH_TIMER_FUNC_TIMER_SYNC,
00205         SWITCH_TIMER_FUNC_TIMER_CHECK,
00206         SWITCH_TIMER_FUNC_TIMER_DESTROY
00207 } switch_timer_func_name_t;


Generated on Mon May 26 22:06:52 2008 for FreeSWITCH by  doxygen 1.3.9.1