bsd_socket_options.c File Reference

BSD socket options. More...

#include "core/net.h"
#include "core/bsd_socket.h"
#include "core/bsd_socket_misc.h"
#include "debug.h"
#include "core/bsd_socket_options.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL   BSD_SOCKET_TRACE_LEVEL
 

Functions

int_t socketSetSoReuseAddrOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set SO_REUSEADDR option. More...
 
int_t socketSetSoBroadcastOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set SO_BROADCAST option. More...
 
int_t socketSetSoSndTimeoOption (Socket *socket, const struct timeval *optval, socklen_t optlen)
 Set SO_SNDTIMEO option. More...
 
int_t socketSetSoRcvTimeoOption (Socket *socket, const struct timeval *optval, socklen_t optlen)
 Set SO_RCVTIMEO option. More...
 
int_t socketSetSoSndBufOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set SO_SNDBUF option. More...
 
int_t socketSetSoRcvBufOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set SO_RCVBUF option. More...
 
int_t socketSetSoKeepAliveOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set SO_KEEPALIVE option. More...
 
int_t socketSetIpTosOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set IP_TOS option. More...
 
int_t socketSetIpTtlOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set IP_TTL option. More...
 
int_t socketSetIpMulticastIfOption (Socket *socket, const struct in_addr *optval, socklen_t optlen)
 Set IP_MULTICAST_IF option. More...
 
int_t socketSetIpMulticastTtlOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set IP_MULTICAST_TTL option. More...
 
int_t socketSetIpMulticastLoopOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set IP_MULTICAST_LOOP option. More...
 
int_t socketSetIpAddMembershipOption (Socket *socket, const struct ip_mreq *optval, socklen_t optlen)
 Set IP_ADD_MEMBERSHIP option. More...
 
int_t socketSetIpDropMembershipOption (Socket *socket, const struct ip_mreq *optval, socklen_t optlen)
 Set IP_DROP_MEMBERSHIP option. More...
 
int_t socketSetIpDontFragOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set IP_DONTFRAG option. More...
 
int_t socketSetIpPktInfoOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set IP_PKTINFO option. More...
 
int_t socketSetIpRecvTosOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set IP_RECVTOS option. More...
 
int_t socketSetIpRecvTtlOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set IP_RECVTTL option. More...
 
int_t socketSetIpv6TrafficClassOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set IPV6_TCLASS option. More...
 
int_t socketSetIpv6UnicastHopsOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set IPV6_UNICAST_HOPS option. More...
 
int_t socketSetIpv6MulticastIfOption (Socket *socket, const struct in_addr *optval, socklen_t optlen)
 Set IPV6_MULTICAST_IF option. More...
 
int_t socketSetIpv6MulticastHopsOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set IPV6_MULTICAST_HOPS option. More...
 
int_t socketSetIpv6MulticastLoopOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set IPV6_MULTICAST_LOOP option. More...
 
int_t socketSetIpv6AddMembershipOption (Socket *socket, const struct ipv6_mreq *optval, socklen_t optlen)
 Set IPV6_ADD_MEMBERSHIP option. More...
 
int_t socketSetIpv6DropMembershipOption (Socket *socket, const struct ipv6_mreq *optval, socklen_t optlen)
 Set IPV6_DROP_MEMBERSHIP option. More...
 
int_t socketSetIpv6OnlyOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set IPV6_V6ONLY option. More...
 
int_t socketSetIpv6DontFragOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set IPV6_DONTFRAG option. More...
 
int_t socketSetIpv6PktInfoOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set IPV6_PKTINFO option. More...
 
int_t socketSetIpv6RecvTrafficClassOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set IPV6_RECVTCLASS option. More...
 
int_t socketSetIpv6RecvHopLimitOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set IPV6_RECVHOPLIMIT option. More...
 
int_t socketSetTcpNoDelayOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set TCP_NODELAY option. More...
 
int_t socketSetTcpMaxSegOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set TCP_MAXSEG option. More...
 
int_t socketSetTcpKeepIdleOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set TCP_KEEPIDLE option. More...
 
int_t socketSetTcpKeepIntvlOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set TCP_KEEPINTVL option. More...
 
int_t socketSetTcpKeepCntOption (Socket *socket, const int_t *optval, socklen_t optlen)
 Set TCP_KEEPCNT option. More...
 
int_t socketGetSoReuseAddrOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get SO_REUSEADDR option. More...
 
int_t socketGetSoBroadcastOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get SO_BROADCAST option. More...
 
int_t socketGetSoSndTimeoOption (Socket *socket, struct timeval *optval, socklen_t *optlen)
 Get SO_SNDTIMEO option. More...
 
int_t socketGetSoRcvTimeoOption (Socket *socket, struct timeval *optval, socklen_t *optlen)
 Get SO_RCVTIMEO option. More...
 
int_t socketGetSoSndBufOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get SO_SNDBUF option. More...
 
int_t socketGetSoRcvBufOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get SO_RCVBUF option. More...
 
int_t socketGetSoKeepAliveOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get SO_KEEPALIVE option. More...
 
int_t socketGetSoTypeOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get SO_TYPE option. More...
 
int_t socketGetSoErrorOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get SO_ERROR option. More...
 
int_t socketGetIpTosOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get IP_TOS option. More...
 
int_t socketGetIpTtlOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get IP_TTL option. More...
 
int_t socketGetIpMulticastTtlOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get IP_MULTICAST_TTL option. More...
 
int_t socketGetIpMulticastLoopOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get IP_MULTICAST_LOOP option. More...
 
int_t socketGetIpDontFragOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get IP_DONTFRAG option. More...
 
int_t socketGetIpPktInfoOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get IP_PKTINFO option. More...
 
int_t socketGetIpRecvTosOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get IP_RECVTOS option. More...
 
int_t socketGetIpRecvTtlOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get IP_RECVTTL option. More...
 
int_t socketGetIpv6TrafficClassOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get IPV6_TCLASS option. More...
 
int_t socketGetIpv6UnicastHopsOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get IPV6_UNICAST_HOPS option. More...
 
int_t socketGetIpv6MulticastHopsOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get IPV6_MULTICAST_HOPS option. More...
 
int_t socketGetIpv6MulticastLoopOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get IPV6_MULTICAST_LOOP option. More...
 
int_t socketGetIpv6OnlyOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get IPV6_V6ONLY option. More...
 
int_t socketGetIpv6DontFragOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get IPV6_DONTFRAG option. More...
 
int_t socketGetIpv6PktInfoOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get IPV6_PKTINFO option. More...
 
int_t socketGetIpv6RecvTrafficClassOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get IPV6_RECVTCLASS option. More...
 
int_t socketGetIpv6RecvHopLimitOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get IPV6_RECVHOPLIMIT option. More...
 
int_t socketGetTcpNoDelayOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get TCP_NODELAY option. More...
 
int_t socketGetTcpMaxSegOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get TCP_MAXSEG option. More...
 
int_t socketGetTcpKeepIdleOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get TCP_KEEPIDLE option. More...
 
int_t socketGetTcpKeepIntvlOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get TCP_KEEPINTVL option. More...
 
int_t socketGetTcpKeepCntOption (Socket *socket, int_t *optval, socklen_t *optlen)
 Get TCP_KEEPCNT option. More...
 

Detailed Description

BSD socket options.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
2.4.2

Definition in file bsd_socket_options.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   BSD_SOCKET_TRACE_LEVEL

Definition at line 32 of file bsd_socket_options.c.

Function Documentation

◆ socketGetIpDontFragOption()

int_t socketGetIpDontFragOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get IP_DONTFRAG option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2322 of file bsd_socket_options.c.

◆ socketGetIpMulticastLoopOption()

int_t socketGetIpMulticastLoopOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get IP_MULTICAST_LOOP option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2268 of file bsd_socket_options.c.

◆ socketGetIpMulticastTtlOption()

int_t socketGetIpMulticastTtlOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get IP_MULTICAST_TTL option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2224 of file bsd_socket_options.c.

◆ socketGetIpPktInfoOption()

int_t socketGetIpPktInfoOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get IP_PKTINFO option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2374 of file bsd_socket_options.c.

◆ socketGetIpRecvTosOption()

int_t socketGetIpRecvTosOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get IP_RECVTOS option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2427 of file bsd_socket_options.c.

◆ socketGetIpRecvTtlOption()

int_t socketGetIpRecvTtlOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get IP_RECVTTL option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2480 of file bsd_socket_options.c.

◆ socketGetIpTosOption()

int_t socketGetIpTosOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get IP_TOS option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2136 of file bsd_socket_options.c.

◆ socketGetIpTtlOption()

int_t socketGetIpTtlOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get IP_TTL option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2180 of file bsd_socket_options.c.

◆ socketGetIpv6DontFragOption()

int_t socketGetIpv6DontFragOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get IPV6_DONTFRAG option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2775 of file bsd_socket_options.c.

◆ socketGetIpv6MulticastHopsOption()

int_t socketGetIpv6MulticastHopsOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get IPV6_MULTICAST_HOPS option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2623 of file bsd_socket_options.c.

◆ socketGetIpv6MulticastLoopOption()

int_t socketGetIpv6MulticastLoopOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get IPV6_MULTICAST_LOOP option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2669 of file bsd_socket_options.c.

◆ socketGetIpv6OnlyOption()

int_t socketGetIpv6OnlyOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get IPV6_V6ONLY option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2722 of file bsd_socket_options.c.

◆ socketGetIpv6PktInfoOption()

int_t socketGetIpv6PktInfoOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get IPV6_PKTINFO option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2829 of file bsd_socket_options.c.

◆ socketGetIpv6RecvHopLimitOption()

int_t socketGetIpv6RecvHopLimitOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get IPV6_RECVHOPLIMIT option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2935 of file bsd_socket_options.c.

◆ socketGetIpv6RecvTrafficClassOption()

int_t socketGetIpv6RecvTrafficClassOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get IPV6_RECVTCLASS option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2882 of file bsd_socket_options.c.

◆ socketGetIpv6TrafficClassOption()

int_t socketGetIpv6TrafficClassOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get IPV6_TCLASS option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2533 of file bsd_socket_options.c.

◆ socketGetIpv6UnicastHopsOption()

int_t socketGetIpv6UnicastHopsOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get IPV6_UNICAST_HOPS option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2577 of file bsd_socket_options.c.

◆ socketGetSoBroadcastOption()

int_t socketGetSoBroadcastOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get SO_BROADCAST option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1777 of file bsd_socket_options.c.

◆ socketGetSoErrorOption()

int_t socketGetSoErrorOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get SO_ERROR option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2095 of file bsd_socket_options.c.

◆ socketGetSoKeepAliveOption()

int_t socketGetSoKeepAliveOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get SO_KEEPALIVE option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2004 of file bsd_socket_options.c.

◆ socketGetSoRcvBufOption()

int_t socketGetSoRcvBufOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get SO_RCVBUF option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1961 of file bsd_socket_options.c.

◆ socketGetSoRcvTimeoOption()

int_t socketGetSoRcvTimeoOption ( Socket socket,
struct timeval optval,
socklen_t optlen 
)

Get SO_RCVTIMEO option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1871 of file bsd_socket_options.c.

◆ socketGetSoReuseAddrOption()

int_t socketGetSoReuseAddrOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get SO_REUSEADDR option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1730 of file bsd_socket_options.c.

◆ socketGetSoSndBufOption()

int_t socketGetSoSndBufOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get SO_SNDBUF option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1918 of file bsd_socket_options.c.

◆ socketGetSoSndTimeoOption()

int_t socketGetSoSndTimeoOption ( Socket socket,
struct timeval optval,
socklen_t optlen 
)

Get SO_SNDTIMEO option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1824 of file bsd_socket_options.c.

◆ socketGetSoTypeOption()

int_t socketGetSoTypeOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get SO_TYPE option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2045 of file bsd_socket_options.c.

◆ socketGetTcpKeepCntOption()

int_t socketGetTcpKeepCntOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get TCP_KEEPCNT option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 3179 of file bsd_socket_options.c.

◆ socketGetTcpKeepIdleOption()

int_t socketGetTcpKeepIdleOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get TCP_KEEPIDLE option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 3096 of file bsd_socket_options.c.

◆ socketGetTcpKeepIntvlOption()

int_t socketGetTcpKeepIntvlOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get TCP_KEEPINTVL option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 3137 of file bsd_socket_options.c.

◆ socketGetTcpMaxSegOption()

int_t socketGetTcpMaxSegOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get TCP_MAXSEG option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 3040 of file bsd_socket_options.c.

◆ socketGetTcpNoDelayOption()

int_t socketGetTcpNoDelayOption ( Socket socket,
int_t optval,
socklen_t optlen 
)

Get TCP_NODELAY option.

Parameters
[in]socketHandle referencing the socket
[out]optvalA pointer to the buffer in which the value for the requested option is to be returned
[in,out]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 2988 of file bsd_socket_options.c.

◆ socketSetIpAddMembershipOption()

int_t socketSetIpAddMembershipOption ( Socket socket,
const struct ip_mreq optval,
socklen_t  optlen 
)

Set IP_ADD_MEMBERSHIP option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 576 of file bsd_socket_options.c.

◆ socketSetIpDontFragOption()

int_t socketSetIpDontFragOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set IP_DONTFRAG option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 683 of file bsd_socket_options.c.

◆ socketSetIpDropMembershipOption()

int_t socketSetIpDropMembershipOption ( Socket socket,
const struct ip_mreq optval,
socklen_t  optlen 
)

Set IP_DROP_MEMBERSHIP option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 635 of file bsd_socket_options.c.

◆ socketSetIpMulticastIfOption()

int_t socketSetIpMulticastIfOption ( Socket socket,
const struct in_addr optval,
socklen_t  optlen 
)

Set IP_MULTICAST_IF option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 437 of file bsd_socket_options.c.

◆ socketSetIpMulticastLoopOption()

int_t socketSetIpMulticastLoopOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set IP_MULTICAST_LOOP option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 519 of file bsd_socket_options.c.

◆ socketSetIpMulticastTtlOption()

int_t socketSetIpMulticastTtlOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set IP_MULTICAST_TTL option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 476 of file bsd_socket_options.c.

◆ socketSetIpPktInfoOption()

int_t socketSetIpPktInfoOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set IP_PKTINFO option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 738 of file bsd_socket_options.c.

◆ socketSetIpRecvTosOption()

int_t socketSetIpRecvTosOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set IP_RECVTOS option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 794 of file bsd_socket_options.c.

◆ socketSetIpRecvTtlOption()

int_t socketSetIpRecvTtlOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set IP_RECVTTL option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 850 of file bsd_socket_options.c.

◆ socketSetIpTosOption()

int_t socketSetIpTosOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set IP_TOS option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 353 of file bsd_socket_options.c.

◆ socketSetIpTtlOption()

int_t socketSetIpTtlOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set IP_TTL option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 394 of file bsd_socket_options.c.

◆ socketSetIpv6AddMembershipOption()

int_t socketSetIpv6AddMembershipOption ( Socket socket,
const struct ipv6_mreq optval,
socklen_t  optlen 
)

Set IPV6_ADD_MEMBERSHIP option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1129 of file bsd_socket_options.c.

◆ socketSetIpv6DontFragOption()

int_t socketSetIpv6DontFragOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set IPV6_DONTFRAG option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1292 of file bsd_socket_options.c.

◆ socketSetIpv6DropMembershipOption()

int_t socketSetIpv6DropMembershipOption ( Socket socket,
const struct ipv6_mreq optval,
socklen_t  optlen 
)

Set IPV6_DROP_MEMBERSHIP option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1188 of file bsd_socket_options.c.

◆ socketSetIpv6MulticastHopsOption()

int_t socketSetIpv6MulticastHopsOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set IPV6_MULTICAST_HOPS option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1029 of file bsd_socket_options.c.

◆ socketSetIpv6MulticastIfOption()

int_t socketSetIpv6MulticastIfOption ( Socket socket,
const struct in_addr optval,
socklen_t  optlen 
)

Set IPV6_MULTICAST_IF option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 990 of file bsd_socket_options.c.

◆ socketSetIpv6MulticastLoopOption()

int_t socketSetIpv6MulticastLoopOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set IPV6_MULTICAST_LOOP option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1072 of file bsd_socket_options.c.

◆ socketSetIpv6OnlyOption()

int_t socketSetIpv6OnlyOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set IPV6_V6ONLY option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1236 of file bsd_socket_options.c.

◆ socketSetIpv6PktInfoOption()

int_t socketSetIpv6PktInfoOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set IPV6_PKTINFO option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1340 of file bsd_socket_options.c.

◆ socketSetIpv6RecvHopLimitOption()

int_t socketSetIpv6RecvHopLimitOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set IPV6_RECVHOPLIMIT option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1452 of file bsd_socket_options.c.

◆ socketSetIpv6RecvTrafficClassOption()

int_t socketSetIpv6RecvTrafficClassOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set IPV6_RECVTCLASS option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1396 of file bsd_socket_options.c.

◆ socketSetIpv6TrafficClassOption()

int_t socketSetIpv6TrafficClassOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set IPV6_TCLASS option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 906 of file bsd_socket_options.c.

◆ socketSetIpv6UnicastHopsOption()

int_t socketSetIpv6UnicastHopsOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set IPV6_UNICAST_HOPS option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 947 of file bsd_socket_options.c.

◆ socketSetSoBroadcastOption()

int_t socketSetSoBroadcastOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set SO_BROADCAST option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 107 of file bsd_socket_options.c.

◆ socketSetSoKeepAliveOption()

int_t socketSetSoKeepAliveOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set SO_KEEPALIVE option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 312 of file bsd_socket_options.c.

◆ socketSetSoRcvBufOption()

int_t socketSetSoRcvBufOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set SO_RCVBUF option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 271 of file bsd_socket_options.c.

◆ socketSetSoRcvTimeoOption()

int_t socketSetSoRcvTimeoOption ( Socket socket,
const struct timeval optval,
socklen_t  optlen 
)

Set SO_RCVTIMEO option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 187 of file bsd_socket_options.c.

◆ socketSetSoReuseAddrOption()

int_t socketSetSoReuseAddrOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set SO_REUSEADDR option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 57 of file bsd_socket_options.c.

◆ socketSetSoSndBufOption()

int_t socketSetSoSndBufOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set SO_SNDBUF option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 230 of file bsd_socket_options.c.

◆ socketSetSoSndTimeoOption()

int_t socketSetSoSndTimeoOption ( Socket socket,
const struct timeval optval,
socklen_t  optlen 
)

Set SO_SNDTIMEO option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 144 of file bsd_socket_options.c.

◆ socketSetTcpKeepCntOption()

int_t socketSetTcpKeepCntOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set TCP_KEEPCNT option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1689 of file bsd_socket_options.c.

◆ socketSetTcpKeepIdleOption()

int_t socketSetTcpKeepIdleOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set TCP_KEEPIDLE option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1607 of file bsd_socket_options.c.

◆ socketSetTcpKeepIntvlOption()

int_t socketSetTcpKeepIntvlOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set TCP_KEEPINTVL option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1648 of file bsd_socket_options.c.

◆ socketSetTcpMaxSegOption()

int_t socketSetTcpMaxSegOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set TCP_MAXSEG option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1563 of file bsd_socket_options.c.

◆ socketSetTcpNoDelayOption()

int_t socketSetTcpNoDelayOption ( Socket socket,
const int_t optval,
socklen_t  optlen 
)

Set TCP_NODELAY option.

Parameters
[in]socketHandle referencing the socket
[in]optvalA pointer to the buffer in which the value for the requested option is specified
[in]optlenThe size, in bytes, of the buffer pointed to by the optval parameter
Returns
Error code (SOCKET_SUCCESS or SOCKET_ERROR)

Definition at line 1508 of file bsd_socket_options.c.