ProSoft Technology MVI56E-LDM - Manual (Page 95)

ControlLogix Platform ♦ "C" Programmable CIP API Functions
Linux Application Development Module Developer's Manual
ProSoft Technology, Inc. Page 89 of 264
March 12, 2014
connHandle
identifies this connection. This value must be passed to the
OCXcip_SendConnected
and
OCXcip_ReadConnected
functions.
reg_param
is the value that was passed to
OCXcip_RegisterAssemblyObj
. The
application may use this to store an index or pointer. It is not used by the API.
reason specifies whether the connection is being opened or closed. A value of
OCX_CIP_CONN_OPEN
indicates the connection is being opened,
OCX_CIP_CONN_OPEN_COMPLETE
indicates the connection has been successfully
opened,
OCX_CIP_NULL_OPEN
indicates there is new configuration data for a
currently open connection, and
OCX_CIP_CONN_CLOSE
indicates the connection is
being closed. If reason is
OCX_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
OCX_CIP_FAILURE
and set
extendederr
to
OCX_CIP_EX_BAD_RPI
. Note: The minimum RPI value supported by the 56SAM
module is 200us.
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.
lODeviceSn
is the serial number of the originating device, and
iOVendorId
is the
vendor ID. The combination of vendor ID and serial number is guaranteed to be
unique, and may be used to identify the source of the connection request. This is
important when connection requests may be originated by multiple devices.
rxDataSize
is the size in bytes of the data to be received on this connection.
txDataSize
is the size in bytes of the data to be sent on this connection.
configData
is a pointer to a buffer containing any configuration data that was sent
with the open request.
configSize
is the size in bytes of the configuration data.
extendederr
is a pointer to a word which may be set by the callback function to
an extended error code if the connection open request is refused.