op_apptrack_pk_reception_record()
Abstract
Records that a tagged packet has been received.
Syntax
op_apptrack_pk_reception_record (apptrack_hndl, pkptr)
| Argument | Type | Description |
|---|---|---|
apptrack_hndl |
Apptrackhandle |
ADT state of interest. |
pkptr |
SimT_Packet * |
Packet of interest. |
Return Type
Compcode
OPC_COMPCODE_SUCCESS if the KP completes successfully; OPC_COMPCODE_FAILURE otherwise.
Details
None.
Purpose
This procedure records that a tagged packet has been received. It timestamps each message carried in the packet with the packet's end time and the object ID of its destination, then writes the messages to the message file.
Errors
- Recoverable Error: Argument (
apptrack_hndl) is NIL. - Program Abort: Packet pointer is NIL.
- Program Abort: Packet pointer references destroyed packet.
- Program Abort: Packet pointer references unowned packet (
<packet ID>). - Program Abort: Packet pointer references static packet (
<packet ID>). - Recoverable Error: Message (
<message ID>) of application instance (<instance ID>) has been completed.
Reference
- Use the KP op_apptrack_pk_tag() to tag a packet for application delay tracking.