op_apptrack_tx_enqueue_flag()
Abstract
Timestamps a packet with its enqueue time.
Syntax
op_apptrack_tx_enqueue_flag (pkptr)
| Argument | Type | Description |
|---|---|---|
pkptr |
SimT_Packet * |
Packet of interest. |
Return Type
Compcode
OPC_COMPCODE_SUCCESS if the KP completes successfully; OPC_COMPCODE_FAILURE otherwise.
Details
Every application instance tagged to the packet has its transmit start time set to the current simulation time.
Purpose
This KP timestamps a tagged packet with the time that the packet is enqueued waiting for transmission. This is useful only when higher layers simulate queuing in transmitters, to guarantee that the time spent in queue is considered appropriately in the delay. By default (when this KP is not called), the transmit start time is set to the time before the packet is enqueued in the transmitters by the kernel.
Errors
- 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>).
Reference
- None.