Configure a socket’s secure mode.
Files
net_sock.h/net_sock.c
Prototype
Code Block |
---|
CPU_BOOLEAN NetSock_CfgBlock(NET_SOCK_ID sock_id,
CPU_INT08U secure,
NET_ERR *p_err); |
Arguments
sock_id
This is the socket ID returned by NetSock_Open()/socket()
when the socket was created.
...
Socket operations will not be secured.
perr
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_SOCK
NET_INIT_ERR_INITNOT_INCOMPLETECOMPLETED
NET_SECURE_ERR_NOT_AVAIL
NET_OSERR_ERRFAULT_LOCK_ACQUIRE
Returned Value
DEF_OK
,
Socket secure mode successfully configured;
DEF_FAIL
,
otherwise.
Required Configuration
Available only if NET_CFG_TRANSPORT_LAYER_SEL
is configured for TCP (see section D-12-1) and if NET_SECURE_CFG_EN
is enabled (see section D-15)None.
Notes / Warnings
Available only for stream-type sockets (e.g., TCP sockets).