NetSock_CfgSecureClientCommonName
Configure client socket's common name.
File
net_sock.h/net_sock.c
Called from
Application
Prototype
CPU_BOOLEAN NetSock_CfgSecureClientCommonName(NET_SOCK_ID sock_id, CPU_CHAR *pcommon_name, NET_ERR *p_err);
Arguments
sock_id
Socket descriptor/handle identifier of client socket to configure common name.
pcommon_name
Pointer to string that contain the common name.
p_err
Pointer to variable that will receive the return error code from this function:
NET_SOCK_ERR_NONE
NET_SOCK_ERR_NOT_USED
NET_SOCK_ERR_INVALID_ARG
NET_SOCK_ERR_INVALID_TYPE
NET_SOCK_ERR_INVALID_STATE
NET_SOCK_ERR_INVALID_OP
NET_SOCK_ERR_API_DIS
NET_INIT_ERR_NOT_COMPLETED
NET_SOCK_ERR_INVALID_SOCK
NET_SECURE_ERR_NOT_AVAIL
NET_ERR_FAULT_LOCK_ACQUIRE
Returned Value
DEF_OK
,
common name successfully configured.
DEF_FAIL
,
otherwise.
Required Configuration
Available only if NET_SECURE_CFG_EN
is enabled (see section Transport Layer Security Configuration).
Notes / Warnings
The socket’s secure mode must be configured before calling this function, see function NetSock_CfgSecure().