ip_socket类 参考

IP协议族Socket基类 更多...

#include <ip_socket.hpp>

类 ip_socket 继承关系图:

Public 成员函数
	ip_socket ()=default
	默认构造函数
	ip_socket (const native_handle_type fd) noexcept
	从原生句柄构造
	~ip_socket () override=default
	析构函数
NEFORCE_NODISCARD int	address_family () const noexcept
	获取地址族
NEFORCE_NODISCARD bool	is_ipv4 () const noexcept
	检查是否为IPv4 socket
NEFORCE_NODISCARD bool	is_ipv6 () const noexcept
	检查是否为IPv6 socket
virtual void	connect (const ip_address &endpoint)
	连接到远程端点（TCP客户端）
bool	close () noexcept override
	关闭socket
Public 成员函数 继承自 socket_base
	socket_base ()
	默认构造函数
	socket_base (const native_handle_type fd) noexcept
	从原生句柄构造
	socket_base (socket_base &&other) noexcept
	移动构造函数
socket_base &	operator= (socket_base &&other) noexcept
	移动赋值运算符
virtual	~socket_base ()
	析构函数
NEFORCE_NODISCARD native_handle_type	native_handle () const noexcept
	获取原生句柄
NEFORCE_NODISCARD bool	is_open () const noexcept
	检查socket是否已打开
	operator bool () const noexcept
	布尔转换运算符
void	open (int family, int type, int protocol)
	打开socket
bool	try_open (int family, int type, int protocol) noexcept
	尝试打开socket（不抛出异常）
bool	set_nonblocking (bool enable) noexcept
	设置非阻塞模式
bool	shutdown_send () noexcept
	关闭发送方向
bool	shutdown_receive () noexcept
	关闭接收方向
bool	shutdown_both () noexcept
	关闭双向通信
bool	set_option (int level, int optname, const void *value, ::socklen_t len) noexcept
	设置socket选项
bool	get_option (int level, int optname, void *optval, ::socklen_t *optlen) const noexcept
	获取socket选项
bool	set_reuse_address (bool enable=true) noexcept
	设置地址重用（SO_REUSEADDR）
bool	set_reuse_port (bool enable=true) noexcept
	设置端口重用（SO_REUSEPORT）
bool	set_keep_alive (bool enable=true) noexcept
	设置TCP KeepAlive
bool	set_tcp_nodelay (bool enable=true) noexcept
	设置TCP_NODELAY（禁用Nagle算法）
bool	set_receive_buffer_size (int size) noexcept
	设置接收缓冲区大小
bool	set_send_buffer_size (int size) noexcept
	设置发送缓冲区大小
bool	set_send_timeout (milliseconds timeout) noexcept
	设置发送超时时间
bool	set_receive_timeout (milliseconds timeout) noexcept
	设置接收超时时间
NEFORCE_NODISCARD optional< ip_address >	local_endpoint () const
	获取本地端点地址
NEFORCE_NODISCARD optional< ip_address >	remote_endpoint () const
	获取远程端点地址
void	bind (const ip_address &endpoint)
	绑定socket到本地地址
void	listen (int backlog)
	开始监听连接（TCP）
NEFORCE_NODISCARD native_handle_type	release () noexcept
	释放socket所有权

Protected 属性
int	family_ = AF_UNSPEC
	地址族
Protected 属性 继承自 socket_base
native_handle_type	fd_ = invalid_handle
	Socket句柄

额外继承的成员函数
Public 类型 继承自 socket_base
using	native_handle_type
	平台原生句柄类型
静态 Public 属性 继承自 socket_base
static constexpr native_handle_type	invalid_handle
	无效句柄常量

详细描述

IP协议族Socket基类

继承自socket_base，专门用于IP协议族（IPv4/IPv6）的Socket操作。 增加了地址族约束、连接功能和地址族查询。

主要功能：

• 地址族约束
• IPv4/IPv6地址族检测
• 连接操作
• IP头结构定义

注解

此类是抽象基类，具体使用TCP或UDP时应使用tcp_socket或udp_socket。

在文件 ip_socket.hpp 第 71 行定义.

构造及析构函数说明

ip_socket()

ip_socket::ip_socket ( const native_handle_type fd )

inlineexplicitnoexcept

从原生句柄构造

参数

fd	原生socket句柄

在文件 ip_socket.hpp 第 87 行定义.

成员函数说明

address_family()

NEFORCE_NODISCARD int ip_socket::address_family ( ) const

inlinenoexcept

获取地址族

返回

AF_INET、AF_INET6或AF_UNSPEC

在文件 ip_socket.hpp 第 105 行定义.

引用了 address_family() , 以及 family_.

被这些函数引用 address_family().

close()

bool ip_socket::close ( )

inlineoverridevirtualnoexcept

关闭socket

返回

关闭成功返回true

重置地址族为AF_UNSPEC，然后关闭socket。

重载 socket_base .

在文件 ip_socket.hpp 第 136 行定义.

引用了 socket_base::close() , 以及 family_.

connect()

virtual void ip_socket::connect ( const ip_address & endpoint )

virtual

连接到远程端点（TCP客户端）

参数

endpoint

远程IP地址和端口

异常

socket_exception	连接失败时抛出
value_exception	socket未打开或端点无效时抛出

发起TCP连接到指定的远程服务器。 对于非阻塞socket，连接可能不会立即完成。

is_ipv4()

NEFORCE_NODISCARD bool ip_socket::is_ipv4 ( ) const

inlinenoexcept

检查是否为IPv4 socket

返回

IPv4返回true

在文件 ip_socket.hpp 第 111 行定义.

引用了 family_.

is_ipv6()

NEFORCE_NODISCARD bool ip_socket::is_ipv6 ( ) const

inlinenoexcept

检查是否为IPv6 socket

返回

IPv6返回true

在文件 ip_socket.hpp 第 117 行定义.

引用了 family_.

---

该类的文档由以下文件生成:

• ip_socket.hpp