Prosody data communications Protocols: heapmon

This is a receive-only protocol which reads the heap usage data from a Prosody processor. It has no configuration options. It is only applicable for Prosody X.

API function behaviour

This should be read in conjunction with the generic data communications documentation.

smdc_channel_config()

You must use #include "smdc_heap.h" to get the appropriate declarations.

The protocol value is kSMDCProtocolHeap.

There is no configuration for this protocol, so the config_data pointer should be null (0) and the config_length should be zero.

This protocol does not use encodings, so the 'encoding' field must be set to the value kSMDCConfigEncodingNone.

The firmware module heapmon must have been downloaded.

smdc_line_control()

[note] not useful - receiver is always connected.

smdc_line_status()

smdc_tx_status()

This function is not applicable since it only applies to the output half of a channel.

smdc_tx_control()

This function is not applicable since it only applies to the output half of a channel.

smdc_rx_status()

Overrun is not monitored.

smdc_rx_control()

smdc_rx_data()

The received data consists of pairs of 32-bit words, least significant byte first, in each pair the first word indicating remaining space in SDRAM heap and the second word indicating remaining space in M2 heap.

smdc_tx_data()

This function is not applicable since it only applies to the output half of a channel.