switch_loadable_module.h File Reference

---

Detailed Description

Loadable Module Routines.

This module is the gateway between external modules and the core of the application. it contains all the access points to the various pluggable interfaces including the codecs and API modules.

Data Structures
struct	switch_loadable_module_interface
	The abstraction of a loadable module. More...
Defines
#define	SWITCH_ADD_API(api_int, int_name, descript, funcptr, syntax_string)
#define	SWITCH_ADD_CHAT(chat_int, int_name, funcptr)
#define	SWITCH_ADD_APP(app_int, int_name, short_descript, long_descript, funcptr, syntax_string, app_flags)
#define	SWITCH_ADD_DIALPLAN(dp_int, int_name, funcptr)
#define	SWITCH_ADD_CODEC(codec_int, int_name)
#define	SWITCH_DECLARE_STATIC_MODULE(init, load, run, shut)
Functions
switch_status_t	switch_loadable_module_init (void)
	Initilize the module backend and load all the modules.
void	switch_loadable_module_shutdown (void)
	Shutdown the module backend and call the shutdown routine in all loaded modules.
switch_endpoint_interface_t *	switch_loadable_module_get_endpoint_interface (const char *name)
	Retrieve the endpoint interface by it's registered name.
switch_codec_interface_t *	switch_loadable_module_get_codec_interface (const char *name)
	Retrieve the codec interface by it's registered name.
switch_dialplan_interface_t *	switch_loadable_module_get_dialplan_interface (const char *name)
	Retrieve the dialplan interface by it's registered name.
switch_status_t	switch_loadable_module_build_dynamic (char *filename, switch_module_load_t switch_module_load, switch_module_runtime_t switch_module_runtime, switch_module_shutdown_t switch_module_shutdown, switch_bool_t runtime)
	build a dynamic module object and register it (for use in double embeded modules)
switch_timer_interface_t *	switch_loadable_module_get_timer_interface (const char *name)
	Retrieve the timer interface by it's registered name.
switch_application_interface_t *	switch_loadable_module_get_application_interface (const char *name)
	Retrieve the application interface by it's registered name.
switch_api_interface_t *	switch_loadable_module_get_api_interface (const char *name)
	Retrieve the API interface by it's registered name.
switch_file_interface_t *	switch_loadable_module_get_file_interface (const char *name)
	Retrieve the file format interface by it's registered name.
switch_speech_interface_t *	switch_loadable_module_get_speech_interface (const char *name)
	Retrieve the speech interface by it's registered name.
switch_asr_interface_t *	switch_loadable_module_get_asr_interface (const char *name)
	Retrieve the asr interface by it's registered name.
switch_directory_interface_t *	switch_loadable_module_get_directory_interface (const char *name)
	Retrieve the directory interface by it's registered name.
switch_chat_interface_t *	switch_loadable_module_get_chat_interface (const char *name)
	Retrieve the chat interface by it's registered name.
switch_say_interface_t *	switch_loadable_module_get_say_interface (const char *name)
	Retrieve the say interface by it's registered name.
switch_management_interface_t *	switch_loadable_module_get_management_interface (const char *relative_oid)
	Retrieve the management interface by it's registered name.
int	switch_loadable_module_get_codecs (const switch_codec_implementation_t **array, int arraylen)
	Retrieve the list of loaded codecs into an array.
int	switch_loadable_module_get_codecs_sorted (const switch_codec_implementation_t **array, int arraylen, char **prefs, int preflen)
	Retrieve the list of loaded codecs into an array based on another array showing the sorted order.
switch_status_t	switch_api_execute (const char *cmd, const char *arg, switch_core_session_t *session, switch_stream_handle_t *stream)
	Execute a registered API command.
switch_status_t	switch_loadable_module_load_module (char *dir, char *fname, switch_bool_t runtime, const char **err)
	Load a module.
switch_status_t	switch_loadable_module_unload_module (char *dir, char *fname, const char **err)
	Unoad a module.
switch_status_t	switch_module_load (switch_loadable_module_interface_t **module_interface, char *filename)
	Load a module.
switch_status_t	switch_module_runtime (void)
switch_status_t	switch_module_shutdown (void)
	Shutdown a module.
uint32_t	switch_core_codec_next_id (void)

---

Define Documentation

#define SWITCH_DECLARE_STATIC_MODULE (  init, load, run, shut   )

Value: void init(void) { \ switch_loadable_module_build_dynamic(__FILE__, load, run, shut, SWITCH_FALSE); \ }

---