oms_tan_destination_info_obtain()
Abstract
Determines the destination module and packet stream index over which an outgoing packet on a stream will be delivered to the destination node.
Syntax
oms_tan_destination_info_obtain (module_objid, src_strm_index, dest_objid_ptr, dest_strm_index_ptr)
| Argument | Type | Description |
|---|---|---|
module_objid |
Objid |
object identifier of the source module |
src_strm_index |
int |
index of the output packet stream over which the packet is to be sent (i.e., “src stream” attribute of the outgoing packet stream.) |
dest_objid_ptr |
Objid * |
pointer to a variable to be filled in with the object identifier of the destination module |
dest_strm_index_ptr |
int * |
pointer to a variable to be filled in with the “dest stream” attribute of the associated packet stream at the destination module |
Return Type
Compcode
Completion code indicating the return status of this procedure. You can compare this return code to the constants OPC_COMPCODE_SUCCESS and OPC_COMPCODE_FAILURE to determine the outcome.
Details
Given a source module and the outgoing stream over which the packet is to be sent, this function determines the object identifier of the destination module and the associated packet stream over which the packet will be delivered in the destination node.
This function can be used in modeling scenarios that use a packet delivery mechanism such as op_pk_deliver() (which requires knowledge of the destination module and packet stream index) instead of a regular packet send mechanism such as op_pk_send ().