1.3.3 Net System Service Interface

Data Types and Constants Summary

NameDescription
SYS_NET_INTF_WIFINet Socket Intf - Wifi
SYS_NET_INTF_ETHERNETNet Socket Intf - Ethernet
SYS_NET_MODE_CLIENTNet Socket Mode - Client
SYS_NET_MODE_SERVERNet Socket Mode - Server
SYS_NET_MAX_HOSTNAME_LENMax Host Name Length
SYS_NET_IP_PROT_UDPIp Protocol Mode - UDP
SYS_NET_IP_PROT_TCPIp Protocol Mode - TCP
SYS_NET_MAX_NUM_OF_SOCKETSNumber of Instances Supported by the NET System Service
SYS_NET_DEFAULT_TLS_ENABLEDefault Values for TLS - False
SYS_NET_DEFAULT_AUTO_RECONNECTDefault Values for Auto Reconnect - True
SYS_NET_DEFAULT_NET_INTFDefault Values for Interface - 0 (Wifi)
NET_CFGAppDebug Flow for the Logs - Configuration
NET_DATAAppDebug Flow for the Logs - Data
SYS_NET_ConfigUsed for passing on the configuration related to the Net Socket that needs
SYS_NET_STATUSIdentifies the current status of the Sys Net Instance.
SYS_NET_EVENTIdentifies the event type for which the User Callback is called.
SYS_NET_CTRL_MSGIdentifies the control message for which the User has called the SYS_NET_CtrlMsg().
SYS_NET_RESULTIdentifies the return values for the Sys Net APIs.

Initialization functions Summary

NameDescription
SYS_NET_InitializeReturns success/ failure for initialization of data structures of the NET service
SYS_NET_DeinitializeDeinitialization of data structures of the NET service

Status functions Summary

NameDescription
SYS_NET_GetStatusReturns System NET instance status.

Setup functions Summary

NameDescription
SYS_NET_OpenOpens a new NET System Service instance.
SYS_NET_CloseDeinitializes the specific instance of the NET System service
SYS_NET_TaskExecutes the SYS NET service state machine for the instance
SYS_NET_CtrlMsgReturns success/ failure for the disconnect/ reconnect operation asked by the user.
SYS_NET_SetConfigParamReturns success on setting a configuration parameter for Net System Service.

Data Exchange functions Summary

NameDescription
SYS_NET_SendMsgReturns No of Bytes sent to peer using the System NET instance.
SYS_NET_RecvMsgReturns No of Bytes received from peer using the System NET instance.
SYS_NET_CALLBACKPointer to a Net system service callback function.