op_apptrack_pk_tag()
Abstract
Tags a packet for application delay tracking.
Syntax
op_apptrack_pk_tag (apptrack_hndl, pkptr, app_instance_id)
| Argument | Type | Description |
|---|---|---|
apptrack_hndl |
Apptrackhandle |
ADT state of interest. |
pkptr |
SimT_Packet * |
Packet of interest. |
app_instance_id |
OpT_uInt32 |
Instance being tracked (must not be completed). |
Return Type
Compcode
OPC_COMPCODE_SUCCESS if the KP completes successfully; OPC_COMPCODE_FAILURE otherwise.
Details
None.
Purpose
This KP registers an application message and tags a packet with the message so that the packet can be tracked through the network during simulation.
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: Application instance (
<instance_id>) is invalid or has been completed.
Reference
- Use the KP op_apptrack_instance_create() to get the ID for tracking.
- Use the KP op_apptrack_pk_tag_clear() to remove the tag, if necessary.