Publication 1756-RM004B-EN-P - October 2000
CIP Messaging API 4-15
connHandle
is used to identify this connection. This value must be
passed to the MVIcip_SendConnected and MVIcip_ReadConnected
functions.
reg_param
is the value that was passed to
MVIcip_RegisterAssemblyObj. The application may use this to store an
index or pointer. It is not used by the CIP API.
reason
specifies whether the connection is being opened or closed. A
value of MVI_CIP_CONN_OPEN indicates the connection is being
opened, MVI_CIP_CONN_OPEN_COMPLETE indicates the connection
has been successfully opened, and MVI_CIP_CONN_CLOSE indicates
the connection is being closed. If
reason
is MVI_CIP_CONN_CLOSE, the
following parameters are unused:
producerCP
,
consumerCP
,
api,
rxDataSize
, and
txDataSize
.
instance
is the instance number that is passed in the forward open.
(
Note:
This corresponds to the Configuration Instance on the RSLogix
5000 generic profile.)
producerCP
is the producer connection point from the open request.
(
Note:
This corresponds to the Input Instance on the RSLogix 5000
generic profile.)
consumerCP
is the consumer connection point from the open request.
(
Note:
This corresponds to the Output Instance on the RSLogix 5000
generic profile.)
lOTApi
is a pointer to the originator-to-target actual packet interval for
this connection, expressed in microseconds. This is the rate at which
connection data packets will be received from the originator. This value
is initialized according to the requested packet interval from the open
request. The application may choose to reject the connection if the
value is not within a predetermined range. If the connection is rejected,
return MVI_CIP_FAILURE and set
extendederr
to
MVI_CIP_EX_BAD_RPI.
Note:
The minimum RPI value supported by
the 1756-MVI module is 600us.
lTOApi
is a pointer to the target-to-originator actual packet interval for
this connection, expressed in microseconds. This is the rate at which
connection data packets will be transmitted by the module. This value
is initialized according to the requested packet interval from the open
request. The application may choose to increase this value if necessary.
connect_proc