EtherNet/IP™ Adapter  1.04.06
User Reference Manual

◆ EI_API_ADP_setEncapInactTimeout()

uint32_t EI_API_ADP_setEncapInactTimeout ( T pAdp_p,
uint16_t  encapInactTimeout_p 
)

Set the current adapter encapsulation inactivity timeout (Instance Attribute ID: 13).

This function sets the adapter encapsulation inactivity timeout. The unit is in seconds. Valid values are:

Value Description
0 Disable
1 - 3600 (default = 120) Timeout in seconds
Parameters
[in]pAdp_pPointer to the adapter.
[in]encapInactTimeout_pThe encapsulation inactivity timeout in seconds.
Returns
EI_API_ADP_EError_t as uint32_t value.
Return values
EI_API_ADP_eERR_OKSuccess.
EI_API_ADP_eERR_GENERALGeneral error.
Example
#include <api/EI_API.h>
EI_API_ADP_T* pEI_API_ADP = NULL;
uint32_t errCode;
uint8_t numInterfaces = 1;
pEI_API_ADP = EI_API_ADP_new(numInterfaces);
// set timeout to 120
errCode = EI_API_ADP_setEncapInactTimeout(pEI_API_ADP, 0x0078);
See also
EI_API_ADP_getEncapInactTimeout EI_API_ADP_EError_t
EI_API_ADP_setEncapInactTimeout
ETHIP_API uint32_t EI_API_ADP_setEncapInactTimeout(T *pAdp_p, uint16_t encapInactTimeout_p)
Set the current adapter encapsulation inactivity timeout (Instance Attribute ID: 13).
Definition: EI_API_ADP_main.c:5224
EI_API_ADP_new
ETHIP_API T * EI_API_ADP_new(uint8_t numInterfaces_p)
Create a new EtherNet/IP adapter.
Definition: EI_API_ADP_main.c:235