RTS API Documentation  1.10.11
Data Structures | Macros | Typedefs | Functions
switch_core_event_hook.h File Reference
#include <switch.h>
+ Include dependency graph for switch_core_event_hook.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  switch_io_event_hook_outgoing_channel
 Node in which to store custom receive message callback hooks. More...
 
struct  switch_io_event_hook_receive_message
 Node in which to store custom receive message callback hooks. More...
 
struct  switch_io_event_hook_receive_event
 Node in which to store custom receive message callback hooks. More...
 
struct  switch_io_event_hook_read_frame
 Node in which to store custom read frame channel callback hooks. More...
 
struct  switch_io_event_hook_video_read_frame
 Node in which to store custom read frame channel callback hooks. More...
 
struct  switch_io_event_hook_write_frame
 Node in which to store custom write_frame channel callback hooks. More...
 
struct  switch_io_event_hook_video_write_frame
 Node in which to store custom video_write_frame channel callback hooks. More...
 
struct  switch_io_event_hook_text_read_frame
 Node in which to store custom read frame channel callback hooks. More...
 
struct  switch_io_event_hook_text_write_frame
 Node in which to store custom video_write_frame channel callback hooks. More...
 
struct  switch_io_event_hook_kill_channel
 Node in which to store custom kill channel callback hooks. More...
 
struct  switch_io_event_hook_send_dtmf
 Node in which to store custom send dtmf channel callback hooks. More...
 
struct  switch_io_event_hook_recv_dtmf
 Node in which to store custom recv dtmf channel callback hooks. More...
 
struct  switch_io_event_hook_state_change
 Node in which to store state change callback hooks. More...
 
struct  switch_io_event_hook_state_run
 Node in which to store state run callback hooks. More...
 
struct  switch_io_event_hooks
 A table of lists of io_event_hooks to store the event hooks associated with a session. More...
 

Macros

#define NEW_HOOK_DECL_ADD_P(_NAME)
 
#define NEW_HOOK_DECL_REM_P(_NAME)
 
#define NEW_HOOK_DECL(_NAME)
 

Typedefs

typedef typedefSWITCH_BEGIN_EXTERN_C struct switch_io_event_hooks switch_io_event_hooks_t
 
typedef struct switch_io_event_hook_outgoing_channel switch_io_event_hook_outgoing_channel_t
 
typedef struct switch_io_event_hook_receive_message switch_io_event_hook_receive_message_t
 
typedef struct switch_io_event_hook_receive_event switch_io_event_hook_receive_event_t
 
typedef struct switch_io_event_hook_read_frame switch_io_event_hook_read_frame_t
 
typedef struct switch_io_event_hook_video_read_frame switch_io_event_hook_video_read_frame_t
 
typedef struct switch_io_event_hook_write_frame switch_io_event_hook_write_frame_t
 
typedef struct switch_io_event_hook_video_write_frame switch_io_event_hook_video_write_frame_t
 
typedef struct switch_io_event_hook_text_read_frame switch_io_event_hook_text_read_frame_t
 
typedef struct switch_io_event_hook_text_write_frame switch_io_event_hook_text_write_frame_t
 
typedef struct switch_io_event_hook_kill_channel switch_io_event_hook_kill_channel_t
 
typedef struct switch_io_event_hook_send_dtmf switch_io_event_hook_send_dtmf_t
 
typedef struct switch_io_event_hook_recv_dtmf switch_io_event_hook_recv_dtmf_t
 
typedef struct switch_io_event_hook_state_change switch_io_event_hook_state_change_t
 
typedef struct switch_io_event_hook_state_run switch_io_event_hook_state_run_t
 
typedef switch_status_t(* switch_outgoing_channel_hook_t) (switch_core_session_t *, switch_event_t *, switch_caller_profile_t *, switch_core_session_t *, switch_originate_flag_t)
 
typedef switch_status_t(* switch_receive_message_hook_t) (switch_core_session_t *, switch_core_session_message_t *)
 
typedef switch_status_t(* switch_receive_event_hook_t) (switch_core_session_t *, switch_event_t *)
 
typedef switch_status_t(* switch_read_frame_hook_t) (switch_core_session_t *, switch_frame_t **, switch_io_flag_t, int)
 
typedef switch_status_t(* switch_video_read_frame_hook_t) (switch_core_session_t *, switch_frame_t **, switch_io_flag_t, int)
 
typedef switch_status_t(* switch_write_frame_hook_t) (switch_core_session_t *, switch_frame_t *, switch_io_flag_t, int)
 
typedef switch_status_t(* switch_video_write_frame_hook_t) (switch_core_session_t *, switch_frame_t *, switch_io_flag_t, int)
 
typedef switch_status_t(* switch_text_read_frame_hook_t) (switch_core_session_t *, switch_frame_t **, switch_io_flag_t, int)
 
typedef switch_status_t(* switch_text_write_frame_hook_t) (switch_core_session_t *, switch_frame_t *, switch_io_flag_t, int)
 
typedef switch_status_t(* switch_kill_channel_hook_t) (switch_core_session_t *, int)
 
typedef switch_status_t(* switch_send_dtmf_hook_t) (switch_core_session_t *, const switch_dtmf_t *, switch_dtmf_direction_t direction)
 
typedef switch_status_t(* switch_recv_dtmf_hook_t) (switch_core_session_t *, const switch_dtmf_t *, switch_dtmf_direction_t direction)
 
typedef switch_status_t(* switch_state_change_hook_t) (switch_core_session_t *)
 
typedef switch_status_t(* switch_state_run_hook_t) (switch_core_session_t *)
 

Functions

switch_io_event_hooks_t switch_core_session_get_event_hooks (switch_core_session_t *session)
 
 NEW_HOOK_DECL_ADD_P (outgoing_channel)
 
 NEW_HOOK_DECL_ADD_P (receive_message)
 
 NEW_HOOK_DECL_ADD_P (receive_event)
 
 NEW_HOOK_DECL_ADD_P (state_change)
 
 NEW_HOOK_DECL_ADD_P (state_run)
 
 NEW_HOOK_DECL_ADD_P (read_frame)
 
 NEW_HOOK_DECL_ADD_P (write_frame)
 
 NEW_HOOK_DECL_ADD_P (video_read_frame)
 
 NEW_HOOK_DECL_ADD_P (video_write_frame)
 
 NEW_HOOK_DECL_ADD_P (text_read_frame)
 
 NEW_HOOK_DECL_ADD_P (text_write_frame)
 
 NEW_HOOK_DECL_ADD_P (kill_channel)
 
 NEW_HOOK_DECL_ADD_P (send_dtmf)
 
 NEW_HOOK_DECL_ADD_P (recv_dtmf)
 
 NEW_HOOK_DECL_REM_P (outgoing_channel)
 
 NEW_HOOK_DECL_REM_P (receive_message)
 
 NEW_HOOK_DECL_REM_P (receive_event)
 
 NEW_HOOK_DECL_REM_P (state_change)
 
 NEW_HOOK_DECL_REM_P (state_run)
 
 NEW_HOOK_DECL_REM_P (read_frame)
 
 NEW_HOOK_DECL_REM_P (write_frame)
 
 NEW_HOOK_DECL_REM_P (video_read_frame)
 
 NEW_HOOK_DECL_REM_P (video_write_frame)
 
 NEW_HOOK_DECL_REM_P (text_read_frame)
 
 NEW_HOOK_DECL_REM_P (text_write_frame)
 
 NEW_HOOK_DECL_REM_P (kill_channel)
 
 NEW_HOOK_DECL_REM_P (send_dtmf)
 
 NEW_HOOK_DECL_REM_P (recv_dtmf)
 

Macro Definition Documentation

◆ NEW_HOOK_DECL

#define NEW_HOOK_DECL (   _NAME)

Definition at line 204 of file switch_core_event_hook.h.

◆ NEW_HOOK_DECL_ADD_P

#define NEW_HOOK_DECL_ADD_P (   _NAME)
Value:
SWITCH_DECLARE(switch_status_t) switch_core_event_hook_add_##_NAME \
(switch_core_session_t *session, switch_##_NAME##_hook_t _NAME)
switch_status_t
Common return values.
#define SWITCH_DECLARE(type)

Definition at line 198 of file switch_core_event_hook.h.

◆ NEW_HOOK_DECL_REM_P

#define NEW_HOOK_DECL_REM_P (   _NAME)
Value:
SWITCH_DECLARE(switch_status_t) switch_core_event_hook_remove_##_NAME \
(switch_core_session_t *session, switch_##_NAME##_hook_t _NAME)
switch_status_t
Common return values.
#define SWITCH_DECLARE(type)

Definition at line 201 of file switch_core_event_hook.h.

Typedef Documentation

◆ switch_io_event_hook_kill_channel_t

Definition at line 46 of file switch_core_event_hook.h.

◆ switch_io_event_hook_outgoing_channel_t

Definition at line 37 of file switch_core_event_hook.h.

◆ switch_io_event_hook_read_frame_t

Definition at line 40 of file switch_core_event_hook.h.

◆ switch_io_event_hook_receive_event_t

Definition at line 39 of file switch_core_event_hook.h.

◆ switch_io_event_hook_receive_message_t

Definition at line 38 of file switch_core_event_hook.h.

◆ switch_io_event_hook_recv_dtmf_t

Definition at line 48 of file switch_core_event_hook.h.

◆ switch_io_event_hook_send_dtmf_t

Definition at line 47 of file switch_core_event_hook.h.

◆ switch_io_event_hook_state_change_t

Definition at line 49 of file switch_core_event_hook.h.

◆ switch_io_event_hook_state_run_t

Definition at line 50 of file switch_core_event_hook.h.

◆ switch_io_event_hook_text_read_frame_t

Definition at line 44 of file switch_core_event_hook.h.

◆ switch_io_event_hook_text_write_frame_t

Definition at line 45 of file switch_core_event_hook.h.

◆ switch_io_event_hook_video_read_frame_t

Definition at line 41 of file switch_core_event_hook.h.

◆ switch_io_event_hook_video_write_frame_t

Definition at line 43 of file switch_core_event_hook.h.

◆ switch_io_event_hook_write_frame_t

Definition at line 42 of file switch_core_event_hook.h.

◆ switch_io_event_hooks_t

typedef typedefSWITCH_BEGIN_EXTERN_C struct switch_io_event_hooks switch_io_event_hooks_t

Definition at line 35 of file switch_core_event_hook.h.

◆ switch_kill_channel_hook_t

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

Definition at line 61 of file switch_core_event_hook.h.

◆ switch_outgoing_channel_hook_t

Definition at line 52 of file switch_core_event_hook.h.

◆ switch_read_frame_hook_t

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

Definition at line 55 of file switch_core_event_hook.h.

◆ switch_receive_event_hook_t

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

Definition at line 54 of file switch_core_event_hook.h.

◆ switch_receive_message_hook_t

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

Definition at line 53 of file switch_core_event_hook.h.

◆ switch_recv_dtmf_hook_t

typedef switch_status_t(* switch_recv_dtmf_hook_t) (switch_core_session_t *, const switch_dtmf_t *, switch_dtmf_direction_t direction)

Definition at line 63 of file switch_core_event_hook.h.

◆ switch_send_dtmf_hook_t

typedef switch_status_t(* switch_send_dtmf_hook_t) (switch_core_session_t *, const switch_dtmf_t *, switch_dtmf_direction_t direction)

Definition at line 62 of file switch_core_event_hook.h.

◆ switch_state_change_hook_t

typedef switch_status_t(* switch_state_change_hook_t) (switch_core_session_t *)

Definition at line 64 of file switch_core_event_hook.h.

◆ switch_state_run_hook_t

typedef switch_status_t(* switch_state_run_hook_t) (switch_core_session_t *)

Definition at line 65 of file switch_core_event_hook.h.

◆ switch_text_read_frame_hook_t

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

Definition at line 59 of file switch_core_event_hook.h.

◆ switch_text_write_frame_hook_t

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

Definition at line 60 of file switch_core_event_hook.h.

◆ switch_video_read_frame_hook_t

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

Definition at line 56 of file switch_core_event_hook.h.

◆ switch_video_write_frame_hook_t

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

Definition at line 58 of file switch_core_event_hook.h.

◆ switch_write_frame_hook_t

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

Definition at line 57 of file switch_core_event_hook.h.

Function Documentation

◆ NEW_HOOK_DECL_ADD_P() [1/14]

NEW_HOOK_DECL_ADD_P ( outgoing_channel  )

◆ NEW_HOOK_DECL_ADD_P() [2/14]

NEW_HOOK_DECL_ADD_P ( receive_message  )

◆ NEW_HOOK_DECL_ADD_P() [3/14]

NEW_HOOK_DECL_ADD_P ( receive_event  )

◆ NEW_HOOK_DECL_ADD_P() [4/14]

NEW_HOOK_DECL_ADD_P ( state_change  )

◆ NEW_HOOK_DECL_ADD_P() [5/14]

NEW_HOOK_DECL_ADD_P ( state_run  )

◆ NEW_HOOK_DECL_ADD_P() [6/14]

NEW_HOOK_DECL_ADD_P ( read_frame  )

◆ NEW_HOOK_DECL_ADD_P() [7/14]

NEW_HOOK_DECL_ADD_P ( write_frame  )

◆ NEW_HOOK_DECL_ADD_P() [8/14]

NEW_HOOK_DECL_ADD_P ( video_read_frame  )

◆ NEW_HOOK_DECL_ADD_P() [9/14]

NEW_HOOK_DECL_ADD_P ( video_write_frame  )

◆ NEW_HOOK_DECL_ADD_P() [10/14]

NEW_HOOK_DECL_ADD_P ( text_read_frame  )

◆ NEW_HOOK_DECL_ADD_P() [11/14]

NEW_HOOK_DECL_ADD_P ( text_write_frame  )

◆ NEW_HOOK_DECL_ADD_P() [12/14]

NEW_HOOK_DECL_ADD_P ( kill_channel  )

◆ NEW_HOOK_DECL_ADD_P() [13/14]

NEW_HOOK_DECL_ADD_P ( send_dtmf  )

◆ NEW_HOOK_DECL_ADD_P() [14/14]

NEW_HOOK_DECL_ADD_P ( recv_dtmf  )

◆ NEW_HOOK_DECL_REM_P() [1/14]

NEW_HOOK_DECL_REM_P ( outgoing_channel  )

◆ NEW_HOOK_DECL_REM_P() [2/14]

NEW_HOOK_DECL_REM_P ( receive_message  )

◆ NEW_HOOK_DECL_REM_P() [3/14]

NEW_HOOK_DECL_REM_P ( receive_event  )

◆ NEW_HOOK_DECL_REM_P() [4/14]

NEW_HOOK_DECL_REM_P ( state_change  )

◆ NEW_HOOK_DECL_REM_P() [5/14]

NEW_HOOK_DECL_REM_P ( state_run  )

◆ NEW_HOOK_DECL_REM_P() [6/14]

NEW_HOOK_DECL_REM_P ( read_frame  )

◆ NEW_HOOK_DECL_REM_P() [7/14]

NEW_HOOK_DECL_REM_P ( write_frame  )

◆ NEW_HOOK_DECL_REM_P() [8/14]

NEW_HOOK_DECL_REM_P ( video_read_frame  )

◆ NEW_HOOK_DECL_REM_P() [9/14]

NEW_HOOK_DECL_REM_P ( video_write_frame  )

◆ NEW_HOOK_DECL_REM_P() [10/14]

NEW_HOOK_DECL_REM_P ( text_read_frame  )

◆ NEW_HOOK_DECL_REM_P() [11/14]

NEW_HOOK_DECL_REM_P ( text_write_frame  )

◆ NEW_HOOK_DECL_REM_P() [12/14]

NEW_HOOK_DECL_REM_P ( kill_channel  )

◆ NEW_HOOK_DECL_REM_P() [13/14]

NEW_HOOK_DECL_REM_P ( send_dtmf  )

◆ NEW_HOOK_DECL_REM_P() [14/14]

NEW_HOOK_DECL_REM_P ( recv_dtmf  )

◆ switch_core_session_get_event_hooks()

switch_io_event_hooks_t switch_core_session_get_event_hooks ( switch_core_session_t session)