oms_tan_neighbor_streams_find()
Abstract
Determines whether any packet stream connection exists between two modules; if yes, then obtains the indices for in and out stream association from the point of view of the first module.
Syntax
oms_tan_neighbor_streams_find (module_objid, neighbor_objid, in_strm_ptr, out_strm_ptr)
| Argument | Type | Description |
|---|---|---|
module_objid |
Objid |
object identifier of the source module (the input and output stream indices will be determined relative to this module.) |
neighbor_objid |
Objid |
object identifier of the neighbor module. |
in_strm_ptr |
int * |
pointer to the variable to be filled in with the specified input stream index (i.e., “dest stream” attribute of the incoming packet stream object.) |
out_strm_ptr |
int * |
pointer to the variable to be filled in with the specified output stream index (i.e., “src stream” attribute of the outgoing packet stream object.) |
Return Type
Compcode
Completion code indicating whether any streams were found in either direction.
[This return code can be compared to constants OPC_COMPCODE_SUCCESS and OPC_COMPCODE_FAILURE to determine the outcome.]
Details
This function determines if any packet stream connections exist between two given modules or not. It also obtains information on the values of the input and/or output stream indices, which ever applicable, from the point of view of the module specified as the first argument to this procedure.