DTL_CIP_CONNECTION_ACCEPT parameters

conn_id

is the connection handle provided in the DTL_CIP_APPLICATION_CONNECT_PROC call.

conn_param

is a value which will be passed back to the application as a parameter in the

packet_proc

and

status_proc

callback functions whenever they are called for the connection. The application may use this to store an index, pointer, or handle. It is uninterpreted by the RSLinx Classic software.

cip_conn

is a pointer to a structure containing the connection parameters for the connection (see CIP Connection Parameters Structures). If DTL_CIP_CONNECTION_ACCEPT is called from within the DTL_CIP_APPLICATION_CONNECT_PROC procedure, this pointer can be the same as the one provided as the

cip_conn

parameter in the DTL_CIP_APPLICATION_CONNECT_PROC call. Generally, the only connection parameters that are permissible to change are the API (Actual Packet Interval) specifications contained in the

OT.api

and

TO.api

fields of the DTL_CIP_TRANSPORT_CONNECTION structure, or the filter and notification flags specified in the

mode

field of the DTL_CIP_TRANSPORT_CONNECTION structure.

reply_buf

is a pointer to a buffer containing any reply data to be returned in response to a data segment specified by the DTL_CIP_APPLICATION_CONNECT_PROC call's

path

parameter.

reply_size

is the size in bytes of the contents of

reply_buf

.

packet_proc

is a function (of type DTL_CIP_CONNECTION_PACKET_PROC) in the calling application which will be called whenever new data becomes available on the connection.

A DTL_CIP_CONNECTION_PACKET_PROC callback function should only be used for connections for which RSLinx Classic is not expected to perform any request/reply matching. If the application specifies a

packet_proc

, the DTL_CIP_CONNECTION_SEND function must be used for sending data on the connection.

If the application does not specify a callback function (for example, the

packet_proc

parameter is NULL), then it will be able to receive data only in response to messages it sends on the connection using either DTL_CIP_MESSAGE_SEND_W or DTL_CIP_MESSAGE_SEND_CB). All other requirements for messaging connections must also be met. (See Understanding CIP Communications.)

status_proc

is a function (of type DTL_CIP_CONNECTION_STATUS_PROC) in the calling application which will be called whenever the state of the connection changes (for example, when the connection closes or fails) and whenever a status event of interest occurred on the connection (see DTL_CIP_CONNECTION_STATUS_PROC and CIP Connection Parameter Structures). After the connection has been successfully established, the

status_proc

function will be called with a status of DTL_CONN_ESTABLISHED.

If the application does not specify a callback function, then it will not be able to track the state of the connection.

timeout

is the maximum time (in milliseconds) to wait for the connection to be established. If this time interval expires, the

status_proc

function will be called with a status of DTL_CONN_ERROR and an I/O completion value of DTL_E_TIME. The

conn_id

will be invalid.