BSD socket options. More...
Go to the source code of this file.
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.
- Version
- 2.4.0
Definition in file bsd_socket_options.h.
Function Documentation
◆ socketGetIpDontFragOption()
Get IP_DONTFRAG option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get IP_MULTICAST_LOOP option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get IP_MULTICAST_TTL option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get IP_PKTINFO option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get IP_RECVTOS option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get IP_RECVTTL option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get IP_TOS option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get IP_TTL option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get IPV6_DONTFRAG option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get IPV6_MULTICAST_HOPS option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get IPV6_MULTICAST_LOOP option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get IPV6_V6ONLY option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get IPV6_PKTINFO option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get IPV6_RECVHOPLIMIT option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get IPV6_RECVTCLASS option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get IPV6_TCLASS option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get IPV6_UNICAST_HOPS option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get SO_BROADCAST option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get SO_ERROR option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get SO_KEEPALIVE option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get SO_RCVBUF option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get SO_RCVTIMEO option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get SO_REUSEADDR option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get SO_SNDBUF option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get SO_SNDTIMEO option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get SO_TYPE option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get TCP_KEEPCNT option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get TCP_KEEPIDLE option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get TCP_KEEPINTVL option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get TCP_MAXSEG option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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()
Get TCP_NODELAY option.
- Parameters
-
[in] socket Handle referencing the socket [out] optval A pointer to the buffer in which the value for the requested option is to be returned [in,out] optlen The 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] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set IP_DONTFRAG option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set IP_MULTICAST_LOOP option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set IP_MULTICAST_TTL option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set IP_PKTINFO option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set IP_RECVTOS option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set IP_RECVTTL option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set IP_TOS option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set IP_TTL option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set IPV6_DONTFRAG option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set IPV6_MULTICAST_HOPS option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set IPV6_MULTICAST_LOOP option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set IPV6_V6ONLY option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set IPV6_PKTINFO option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set IPV6_RECVHOPLIMIT option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set IPV6_TCLASS option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set IPV6_UNICAST_HOPS option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set SO_BROADCAST option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set SO_KEEPALIVE option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set SO_RCVBUF option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set SO_REUSEADDR option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set SO_SNDBUF option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set TCP_KEEPCNT option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set TCP_KEEPIDLE option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set TCP_KEEPINTVL option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set TCP_MAXSEG option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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()
Set TCP_NODELAY option.
- Parameters
-
[in] socket Handle referencing the socket [in] optval A pointer to the buffer in which the value for the requested option is specified [in] optlen The 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.