op_pk_stamp_time_get()
Abstract
Obtains the simulation time when the specified packet was last stamped.
Syntax
op_pk_stamp_time_get (pkptr)
| Argument | Type | Description |
|---|---|---|
pkptr |
Packet* |
pointer to the packet-of-interest [A pointer to a packet can be obtained from many KPs, including op_pk_create(), op_pk_create_fmt(), op_pk_copy(), op_pk_get(), op_subq_pk_access(), and op_subq_pk_remove().] |
Return Type
double
Simulation time when the specified packet was last stamped.
Example
/* obtain a pointer to the arriving packet */
pkptr = op_pk_get (INPUT_STRM);
/* determine the packet's stamp time */
stamp_time = op_pk_stamp_time_get (pkptr);
/* compute the gateway-to-gateway transmission delay */
gtg_delay = op_sim_time() - stamp_time;
/* write out the new delay value */
op_stat_write (GTG_DELAY, gtg_delay);
Details
Packets that have not ever been stamped via the KP op_pk_stamp() will have their stamp time defined to be the time when they were originally created.
Most operations performed on packets will not affect their stamp information. Transmission over bus and radio links may create multiple copies of a packet, but each copy retains the original packet's stamp information. Explicitly copying a packet via the KP op_pk_copy() will produce a duplicate packet with the same stamp information as the original packet.
Both unformatted and formatted packets can be operated on via this KP.
Purpose
Provides a mechanism for determining the simulation time when a packet was last stamped. Typically this KP is used to compute end-to-end (or localized) transmission and processing delays, and can be used in conjunction with the KP op_pk_stamp_mod_get() to compare end-to-end delays with reference to different source locations.
Errors
- Program Abort: Segmentation violation. (due to an invalid packet pointer or malformed packet)
- Program Abort: Packet pointer is NIL.
- Program Abort: Packet pointer references destroyed packet.
Reference
- Use the KP op_pk_stamp() to set a packet's stamp
- Use the KP op_pk_stamp_mod_get() to obtain the object ID of the module where a packet was last stamped
- Use the KPs op_pk_creation_mod_get() and op_pk_creation_time_get() to obtain the module object ID and simulation time associated with a packet's creation
- Use the KP op_pk_id() to obtain the unique ID of a packet