The following functions are provided by the Prosody generic API:
| API call | W | Description |
|---|---|---|
| sm_get_modules() | 5 | Return count of modules installed in system |
| sm_reset_module() | Hardware reset a module | |
| sm_download_fmw() | R | Download firmware to module |
| sm_get_module_info() | Determine if firmware running, obtain module workload | |
| sm_get_firmware_caps() | 1 | Determine capabilities of downloaded firmware |
| sm_get_firmware_info() | T | Determine what firmware has been downloaded. |
| sm_config_module_switching() | Control assignment of channels to external bus timeslots | |
| sm_get_module_card_ix() | 5 | Determine card that module is hosted on |
| sm_get_card_switch_ix() | 5 | Determine switch driver associated with card |
| sm_channel_alloc_placed() | Allocate a channel on a specific module | |
| sm_channel_alloc() | R | Allocate a channel to generate or receive data |
| sm_switch_channel_output() | Switch channel data to non-default external bus timeslot | |
| sm_switch_channel_input() | Switch data from non-default external bus timeslot to channel | |
| sm_switch_channel_ix() | 1 | Switch data by reference to channel index (not channel id) |
| sm_find_channel() | 1 | Determine channel from switching location |
| sm_channel_release() | Release a previously allocated channel | |
| sm_channel_info() | Get channel information so data can be switched through to it | |
| sm_channel_ix_info() | 1 | Get channel information so data can be switched through to it |
| sm_get_channel_ix() | Map channel identifier to integer | |
| sm_get_channel_module_ix() | 5 | Determine module that channel is allocated to |
| sm_get_channel_ix_module_ix() | 1 | Determine module that channel is allocated to |
| sm_get_channel_type() | Determine channel type | |
| sm_reset_channel() | 1 | Reset an input channel or an output channel |
| sm_channel_set_event() | Associate event with specific/any channel | |
| sm_get_cards() | 5 | Return count of cards hosting modules installed in system |
| sm_get_card_info() | Return information about card hosting one or more modules | |
| sm_get_card_rev() | Return information about card hardware revision | |
| sm_get_driver_info() | Return driver version information | |
| smd_ev_create() | Create operating system event for channel | |
| smd_ev_wait() | Wait for notification of operating system event | |
| smd_ev_free() | Free previously created operating system event | |
| sm_close_prosody() | T | Closes a card, finishing potential use with Prosody. |
| sm_open_module() | T | Open a Prosody module |
| sm_module_get_event() | P | Obtain an event for a module |
| sm_module_status() | P | Report the status of a Prosody module connection |
| sm_shutdown_module() | P | Initiate the closing of a Prosody module |
| sm_close_module() | T | Close a Prosody module |
| sm_get_channel_module_id() | T | Return the module on which a channel is located. |
| sm_get_module_card_id() | T | Return the card on which a module is located. |
| sm_get_card_switch_id() | T | Determine switch driver associated with card |
| sm_tdmrx_create() | T | Create a TDM[rx] endpoint |
| sm_tdmtx_create() | T | Create a TDM[tx] endpoint |
| sm_tdmrx_destroy() | T | Destroy a previously allocated TDM[rx] |
| sm_tdmtx_destroy() | T | Destroy a previously allocated TDM[tx] |
| sm_tdmrx_get_datafeed() | T | Obtain a datafeed from a TDM[rx] |
| sm_tdmtx_datafeed_connect() | T | Connect a TDM[tx] to a datafeed |
| sm_channel_get_datafeed() | T | Obtain a datafeed from an output channel |
| sm_channel_datafeed_connect() | T | Connect a channel to a datafeed |
| sm_udp_collector_create() | P | Create a UDP data collector |
| sm_collector_get_event() | P | Obtain an event for a collector |
| sm_collector_status() | P | Determine collector status |
| sm_channel_collector_connect() | P | Connect a channel to a collector |
| sm_collector_destroy() | P | Destroy a data collector |
| sm_udp_dispatcher_create() | P | Create a UDP data dispatcher |
| sm_channel_dispatcher_connect() | P | Connect a channel to a dispatcher |
| sm_dispatcher_destroy() | P | Destroy a data dispatcher |
| sm_error_name() | T | Generate a name from an error code |
Key to W column:
| P | Preliminary documentation - this functionality is under development. It could be changed or withdrawn, and may not be implemented in this release |
|---|---|
| 1 | Only in Prosody version 1 |
| R | In Prosody version 1, but only available in Prosody version 2 (TiNG) using the Resource manager |
| 5 | Only in Prosody before the V6 API |
| T | Only in Prosody version 2 (TiNG) |
This document is also available as a single file.