op_apptrack_rx_processing_disable()
Abstract
Disables the systematic recording of the receive happening in a receiver or receiver channel.
Syntax
op_apptrack_rx_processing_disable (rx_objid)
| Argument | Type | Description |
|---|---|---|
rx_objid |
Objid |
Receiver or receiver channel of interest (can be point-to-point, bus, or radio). |
Return Type
Compcode
OPC_COMPCODE_SUCCESS if the KP completes successfully; OPC_COMPCODE_FAILURE otherwise.
Details
All receiver channels under the given rx_objid are disabled. You can pass OPC_OBJID_UNIVERSAL for rx_objid to disable all receiver channels (point-to-point, bus, and radio) in a network.
Purpose
This KP disables the default processing of tagged packets received by a receiver or receiver channel (such as recording of reception time). This is typically used when higher layers decide whether the given packet is to be accepted at the given receiver node and is useful when only one receiver is the actual recipient of a packet that might be sent to multiple destinations (broadcast media). The intended receiver can then call op_apptrack_rx_record() to process the packet.
Errors
- Recoverable Error: Object ID (
<rx_objid>) is out-of-range. - Recoverable Error: Object ID (
<rx_objid>) refers to a restricted object. - Recoverable Error: Object (
<rx_objid>) has incorrect type (<rx_obj_type>); receiver or receiver channel objects are expected.
Reference
- Use the KP op_apptrack_rx_record() to record packet reception at the appropriate time.