Linux下 getsockopt/setsockopt 函数使用说明

阳光穿透心脏的1/2处 2022-06-07 05:05 504阅读 0赞

getsockopt, setsockopt - 获取或设置socket套接字相关的选项

### **函数使用** ###

**函数原型：**  
int getsockopt(int sockfd, int level, int optname, void \*optval, socklen\_t \*optlen);  
int setsockopt(int sockfd, int level, int optname, const void \*optval, socklen\_t optlen);

**功能：**  
获取或设置文件描述符sockfd对应的套接字选项。选项可能存在于多个协议级别;它们总是存在于最高的套接字级别。在操作套接字选项时，必须指定该选项所在的级别和该选项的名称。要在套接字API级别操作选项，级别指定为SOL\_SOCKET。要处理任何其他级别的选项，提供了控制该选项的适当协议的协议号。例如，为了指示一个选项是由TCP协议解释的，则应将级别设置为TCP的协议号（IPPROTO\_TCP）。

**头文件：**  
`#include <sys/types.h>`  
`#include <sys/socket.h>`

**参数：**

*  sockfd：将要被设置或者获取选项的套接字的文件描述符。
 *  level：选项所在的协议层。
 *  optname：需要访问的选项名。
 *  optval：对于getsockopt()，指向返回选项值的地址。对于setsockopt()，指向包含新选项值的地址。
 *  optlen：对于getsockopt()，作为入口参数时，选项值的最大长度。作为出口参数时，选项值的实际长度。对于setsockopt()，现选项的长度。

**返回值：**  
成功执行时，返回0。失败返回-1，errno被设为以下的某个值：  
EBADF：sockfd不是有效的文件描述符  
EFAULT：optval指向的内存并非有效的进程空间  
EINVAL：在调用setsockopt()时，optlen无效  
ENOPROTOOPT：指定的协议层不能识别选项  
ENOTSOCK：sockfd描述的不是套接字文件描述符

### **socket选项** ###

根据level（SOL\_SOCKET、IPPROTO\_IP、IPPROTO\_TCP）的不同，有对应的socket选项

**1、level为SOL\_SOCKET**

<table> 
 <thead> 
  <tr> 
   <th>选项名称</th> 
   <th>说明</th> 
   <th>数据类型</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>SO_BROADCAST</td> 
   <td>允许发送广播数据</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>SO_BSDCOMPAT</td> 
   <td>与BSD系统兼容</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>SO_DOMAIN</td> 
   <td>获取套接字域，如AF_INET6（此选项只读）</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>SO_DEBUG</td> 
   <td>允许调试</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>SO_DONTROUTE</td> 
   <td>不经过网关，只向直接相连的主机发送数据</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>SO_ERROR</td> 
   <td>获得套接字错误（此选项只读）</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>SO_KEEPALIVE</td> 
   <td>使能发送keep_alive报文</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>SO_LINGER</td> 
   <td>设置或获取SO_LINGER选项</td> 
   <td>struct linger</td> 
  </tr> 
  <tr> 
   <td>SO_OOBINLINE</td> 
   <td>使能带外数据放入正常数据流</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>SO_PROTOCOL</td> 
   <td>获取套接字协议，如IPPROTO_SCTP（此选项只读）</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>SO_RCVBUF</td> 
   <td>接收缓冲区大小</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>SO_SNDBUF</td> 
   <td>发送缓冲区大小</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>SO_RCVLOWAT</td> 
   <td>接收缓冲区下限</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>SO_SNDLOWAT</td> 
   <td>发送缓冲区下限</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>SO_RCVTIMEO</td> 
   <td>接收超时</td> 
   <td>struct timeval</td> 
  </tr> 
  <tr> 
   <td>SO_SNDTIMEO</td> 
   <td>发送超时</td> 
   <td>struct timeval</td> 
  </tr> 
  <tr> 
   <td>SO_REUSERADDR</td> 
   <td>允许重用本地地址和端口</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>SO_TYPE</td> 
   <td>获得套接字类型（此选项只读）</td> 
   <td>int</td> 
  </tr> 
 </tbody> 
</table>

更多选项说明请见：[https://linux.die.net/man/7/socket][https_linux.die.net_man_7_socket]

**2、level为IPPROTO\_IP**

<table> 
 <thead> 
  <tr> 
   <th>选项名称</th> 
   <th>说明</th> 
   <th>数据类型</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>IP_ADD_MEMBERSHIP</td> 
   <td>加入一个多播组</td> 
   <td>struct ip_mreqn</td> 
  </tr> 
  <tr> 
   <td>IP_HDRINCL</td> 
   <td>在数据包中包含IP首部</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>IP_MTU</td> 
   <td>获取socket的当前路径MTU（此选项只读）</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>IP_OPTINOS</td> 
   <td>IP首部选项</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>IP_TOS</td> 
   <td>服务类型</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>IP_TTL</td> 
   <td>生存时间</td> 
   <td>int</td> 
  </tr> 
 </tbody> 
</table>

更多选项说明请见：[https://linux.die.net/man/7/ip][https_linux.die.net_man_7_ip]

**1、level为IPPROTO\_TCP**

<table> 
 <thead> 
  <tr> 
   <th>选项名称</th> 
   <th>说明</th> 
   <th>数据类型</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>TCP_INFO</td> 
   <td>收集socket的信息</td> 
   <td>struct tcp_info</td> 
  </tr> 
  <tr> 
   <td>TCP_MAXSEG</td> 
   <td>TCP最大数据段的大小</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>TCP_NODELAY</td> 
   <td>不使用Nagle算法</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>TCP_QUICKACK</td> 
   <td>使能quickack模式</td> 
   <td>int</td> 
  </tr> 
 </tbody> 
</table>

更多选项说明请见：[https://linux.die.net/man/7/tcp][https_linux.die.net_man_7_tcp]

[https_linux.die.net_man_7_socket]: https://linux.die.net/man/7/socket
[https_linux.die.net_man_7_ip]: https://linux.die.net/man/7/ip
[https_linux.die.net_man_7_tcp]: https://linux.die.net/man/7/tcp