PROFINET Device4.2.0
 
Loading...
Searching...
No Matches

◆ PN_API_IOD_arDisconnCbf

typedef void(* PN_API_IOD_arDisconnCbf) (PN_API_IOD_Handle_t *const pnHandle, const uint16_t arNum, const uint16_t sessionKey, const PN_API_IOD_ArReason_t reasonCode)

Callback function prototype to notify the user application that an AR connection with the IO controller has been terminated.

A connection termination event takes place when an established connection is either alarmed or deliberately terminated by the IO controller or the IO device.

Parameters
[in]pnHandleProfinet API Handle.
[in]arNumAR number.
[in]sessionKeySession key.
[in]reasonCodeReason code (see PN_API_IOD_ArReason_t)
Example
#include "pn_api_iod_callbacks.h"
#include "pn_api_iod_communication.h"
#include "pn_api_iod_startup.h"
//Implement the callback function in the user application
uint32_t arNum, PN_API_IOD_ArReason_t reasonCode)
{...}
PN_API_IOD_Handle_t* pnHandle = NULL;
uint32_t status;
pnHandle = PN_API_IOD_new();
//Store callback functions implemented by the user application
...}
//Register callback function
status = PN_API_IOD_registerCallbacks(pnHandle, &callbacks);
PN_API_IOD_Handle_t * PN_API_IOD_new(void)
Creates Profinet API handle.
uint32_t PN_API_IOD_registerCallbacks(PN_API_IOD_Handle_t *const pnHandle, PN_API_IOD_Callbacks_t *callbacksInst)
Register callback functions.
PN_API_IOD_ArReason_t
AR disconnection reason.
Definition pn_api_iod_types.h:259
struct PN_API_IOD_Handle PN_API_IOD_Handle_t
API handle instance which holds IO device's info.
Definition pn_api_iod_types.h:61
void PN_APP_IOD_cbArDisconn(PN_API_IOD_Handle_t *const pnHandle, const uint16_t arNum, const uint16_t arSessionKey, const PN_API_IOD_ArReason_t reasonCode)
Callback function to notify that an AR connection with the IO controller has been terminated.
PN_API_IOD_arDisconnCbf arDisconn
Definition pn_api_iod_callbacks.h:43
Structure representing a set of callbacks.
Definition pn_api_iod_callbacks.h:41