General Sub-Package

The General sub-package contains the following KPs.

  • op_pk_bcast_general() Assigns the broadcast property of the specified packet to permit its broadcast to eligible receivers in all network nodes.
  • op_pk_bcast_get() Gets the value of broadcast information.
  • op_pk_bcast_unique() Assigns the broadcast property of the specified packet to restrict its broadcast to eligible receivers within a single specified node.
  • op_pk_bulk_size_get() Obtains the bulk data size of the specified packet.
  • op_pk_bulk_size_set() Sets the bulk data size of the specified packet to the specified value.
  • op_pk_copy() Creates a new packet that is a duplicate of a specified original packet.
  • op_pk_create() Creates a new unformatted packet with the specified bulk data size; the packet does not have any of its fields set.
  • op_pk_create_fmt() Creates a new formatted packet with a predefined structure described by the specified packet format.
  • op_pk_create_vvec() Creates a new value vector packet.
  • op_pk_creation_mod_get() Obtains the object ID of the module in which the specified packet was created.
  • op_pk_creation_mod_set() Changes the object ID that specifies the creation module of a packet.
  • op_pk_creation_time_get() Obtains the simulation time when the specified packet was created.
  • op_pk_creation_time_set() Changes the creation time of a packet.
  • op_pk_deliver() Forwards the specified packet to a remote module, schedules the packet’s arrival at the module for the current simulation time, and releases ownership of the packet by the invoking process.
  • op_pk_deliver_delayed() Forwards the specified packet to a remote module, schedules the packet’s arrival at the module for a delayed simulation time, and releases ownership of the packet by the invoking process.
  • op_pk_deliver_forced() Forwards the specified packet to a remote module, forces an immediate arrival at the module which causes an invocation of the corresponding process, and releases ownership of the packet by the invoking process.
  • op_pk_deliver_quiet() Forwards the specified packet to a remote module without scheduling an interrupt or invoking the process running at the module, and releases ownership of the packet by the invoking process.
  • op_pk_destroy() Deallocates the specified packet, releasing associated memory resources for other purposes.
  • op_pk_encap_flag_is_set() Checks a flag on a packet to see if it has been set.
  • op_pk_encap_flag_set() Sets a flag on a packet that becomes visible on any packet that encapsulates the original packet.
  • op_pk_encap_pk_access() Gets a reference to an encapsulated packet from a specified encapsulating packet.
  • op_pk_encap_pk_get() Retrieves a copy of an encapsulated packet from a specified encapsulating packet.
  • op_pk_format() Obtains the name of the packet format associated with the specified packet.
  • op_pk_format_info_get() Retrieve information about a packet’s format and its properties.
  • op_pk_format_print_proc_set() Associates a custom print procedure with the specified field for any formatted packet of the format specified (field type must be structure).
  • op_pk_get() Obtains a pointer to a packet that has arrived on an input packet stream, and removes the packet from the stream.
  • op_pk_ici_get() Obtains the pointer to the ICI that has been previously associated with the packet via the KP op_pk_ici_set().
  • op_pk_ici_set() Creates an association between a packet and an ICI by storing the specified ICI pointer in the packet. This implicitly replaces any previous associations the packet may have had with other ICIs.
  • op_pk_id() Obtains the unique Simulation Kernel-assigned ID of the specified packet.
  • op_pk_id_str_get() Obtains the string representation of a packet ID.
  • op_pk_interfering_pk_get() Obtains a reference to the interfering packet that prompted a pipeline stage invocation for another packet.
  • op_pk_is_format() Tests the name of a packet format.
  • op_pk_name_to_index() Converts a field name into the corresponding numeric field index, based on a specified packet format.
  • op_pk_num_fds() Obtains the number of fields in a packet.
  • op_pk_num_fields_get() Obtains the number of formatted and unformatted fields in a packet.
  • op_pk_print() Prints information about a packet to an output device.
  • op_pk_print_options() Prints information about a packet to an output device, optionally including TDA and VVEC values.
  • op_pk_priority_get() Obtains the value of the specified packet’s priority property.
  • op_pk_priority_set() Assigns the specified priority value to the priority property of the specified packet.
  • op_pk_send() Forwards the specified packet through an output packet stream, schedules the packet’s arrival at a destination module for the current simulation time, and releases ownership of the packet by the invoking process.
  • op_pk_send_delayed() Forwards the specified packet through an output packet stream, schedules the packet’s arrival at a destination module for a delayed simulation time, and releases ownership of the packet by the invoking process.
  • op_pk_send_forced() Forwards the specified packet through an output packet stream, forces an immediate arrival at the destination module which causes an invocation of the corresponding process, and releases ownership of the packet by the invoking process.
  • op_pk_send_quiet() Forwards the specified packet through an output packet stream (does not schedule an interrupt or invoke the process running at the destination module), then releases ownership of the packet.
  • op_pk_stamp() Stores information in the specified packet which records the current location (i.e., module) and simulation time, for later reference.
  • op_pk_stamp_mod_get() Obtains the object ID of the module where the specified packet was last stamped.
  • op_pk_stamp_mod_set() Sets the object ID of the module where the specified packet was last stamped.
  • op_pk_stamp_time_get() Obtains the simulation time when the specified packet was last stamped.
  • op_pk_stamp_time_set() Sets the simulation time when the specified packet was last stamped.
  • op_pk_total_size_get() Obtains the total size of the specified packet.
  • op_pk_total_size_set() Sets the total size of the specified packet to the specified value (if this value is valid).
  • op_pk_transfer() Replaces the contents of a packet with those of another packet.
  • op_pk_transmission_phase_get() Obtains the transmission phase of the interfering packet that prompted a pipeline stage invocation for another packet.
  • op_pk_tree_id() Obtains the identifier for the “tree” of packets that the specified packet belongs to. A tree of packets is the set of packets that result from duplication of the same original packet.
  • op_pk_type() Determines the type of a specified packet.

See General Sub-Package for an overview of this sub-package.