模块契约HTTP Upgrade

错误

失败经 xrtGetError() 报告:

域/种类触发场景
XERR_ARGUMENT / XERR_RANGE参数与字段数组容量
XERR_MEMORY输出缓冲分配失败
xrt.http 域错误升级字段缺失、Accept 不匹配等协议错误

线程

升级协商 API 均为无共享状态的纯函数,可任意线程并发调用。

语法与借用

一个 xhttpupgradeitem 表示 protocol-name[/protocol-version]。Protocol 与 Version 都借用原字段值;空 Version 表示线路中没有斜杠和版本。名称与版本必须是 非空 HTTP token,斜杠两侧不允许空白。

xrtHttpUpgradeParse 解析单个元素。xrtHttpUpgradeValid 和 xrtHttpUpgradeCount 完整检查一个列表字段值。HTTP #list 允许空成员,因此前导、 连续和尾随逗号会被忽略;畸形的非空成员会失败。

迭代

xrtHttpUpgradeNext 在第一次发布条目前完整验证当前字段值。 xrtHttpUpgradeFieldNext 把全部重复 Upgrade 字段视为一份有序列表,并在第一次 发布前验证所有同名字段。这样后续坏字段不会让调用方先消费半份可信升级列表。

游标必须由对应的 CursorInit 函数初始化,输入在迭代结束前保持不变。游标、输出和 字段描述符支持未对齐存储;输出不能覆盖输入或游标。

协议名称按 RFC 使用 ASCII 大小写不敏感比较,可复用 xrtHttpTokenEqual;协议版本 是否区分大小写由具体协议定义。HTTP/1 解析器会拒绝任何畸形 Upgrade 字段,只有 列表至少包含一个协议时才发布 XHTTP1_UPGRADE。

写出

启用 XRT_FEATURE_HTTP_UPGRADE_WRITE 后:

  • xrtHttpUpgradeWrite 规范生成 name, name/version 列表;
  • xrtHttpUpgradeElementWrite 写一个元素;
  • xrtHttpUpgradeBuild 一次分配零结尾文本,返回值由 xrtFree 释放。

直接写出支持空输出精确计长;短缓冲返回所需长度且不写部分结果。描述符、借用值、 长度输出和目标缓冲不得重叠。

裁剪与依赖

  • XRT_FEATURE_HTTP_UPGRADE:解析、验证和重复字段迭代;依赖 HTTP;
  • XRT_FEATURE_HTTP_UPGRADE_WRITE:直接写出与 Build;依赖 HTTP_UPGRADE。

示例位于 examples/http/upgrade/main.c。

模块边界

模块裁剪宏作用
httpXRT_MODULE_HTTPtoken、字段、方法、状态和 Content-Length
http_paramXRT_MODULE_HTTP_PARAM参数与 quoted-string 语法
http_param_hostXRT_MODULE_HTTP_PARAM_HOST参数解码后的无分配 Host 验证
http_expectXRT_MODULE_HTTP_EXPECTExpect 字段
http_upgradeXRT_MODULE_HTTP_UPGRADEUpgrade 字段与写出
http_teXRT_MODULE_HTTP_TETE 与 transfer-coding 参数
http_connectionXRT_MODULE_HTTP_CONNECTIONConnection 选项与持久连接
http_trailerXRT_MODULE_HTTP_TRAILERTrailer 声明和尾字段约束
http_encodingXRT_MODULE_HTTP_ENCODINGAccept-Encoding 与 Content-Encoding
http_decodeXRT_MODULE_HTTP_DECODE流式 gzip/deflate 自动解码
http_hostXRT_MODULE_HTTP_HOSTHost authority
http_targetXRT_MODULE_HTTP_TARGET四种 request-target
http1_headXRT_MODULE_HTTP1_HEAD起始行、Header 解析与写入
http1_netXRT_MODULE_HTTP1_NETTCP 块链 Header 解析与余量保留
http1_tlsXRT_MODULE_HTTP1_TLSTLS 明文块链增量 Header 解析
http1_bodyXRT_MODULE_HTTP1_BODY正文计划、chunked 和 trailer
http1_messageXRT_MODULE_HTTP1_MESSAGE连续内存完整消息便利层

http_decode 才依赖 Inflate,http1_net 才依赖网络块链,http1_tls 才依赖 TLS Stream。 只启用连续内存 HTTP/1 解析不会带入压缩、网络、TLS 或 WebSocket。

借用模型

xhttpfield、xhttp1head、xhttp1message 和所有语法游标都借用调用方输入。 解析器不复制字段名称和值,输入缓冲和字段描述符数组必须覆盖借用视图的使用期。

请求方法同时以原始 xhttp1head.Method 视图和 xhttp1head.MethodCode 枚举发布。 xrtHttpMethodParse 按大小写敏感规则识别 GET、HEAD、POST、PUT、DELETE、CONNECT、 OPTIONS、TRACE 和 PATCH;合法但未内置的方法返回 XHTTP_METHOD_OTHER,非法 token 返回 XHTTP_METHOD_INVALID。每个非零枚举值占用独立 bit,既可以作为实际方法直接 比较,也可以通过位或组合成路由方法集合。XHTTP_METHOD_CRUD 覆盖 GET、POST、PUT、 PATCH 和 DELETE,XHTTP_METHOD_ANY 覆盖全部内置方法及 OTHER;应用仍应保留原始 视图处理具体的扩展方法。

字段描述符允许位于合法的未对齐存储。实现使用安全加载,不要求调用方为了协议 解析调整缓冲布局。

XRT 不再提供动态 Header 容器。需要拥有、修改或索引 Header 的框架应在 xhttp 中建立对象模型;快速路径可以直接使用栈数组或应用自己的存储。

Host 语法

xrtHttpHostParse 保留 Host、可选端口和 IP-literal 分类,任意长度十进制端口在 协议层仍然合法,只有可放入 uint16 的值才带 XHTTP_AUTHORITY_PORT_VALUE。 xrtHttpIpv4Valid 与 xrtHttpIpv6Valid 是无错误副作用的纯谓词,公开同一套严格 IP 文本规则,扩展协议无需复制 Host 内部解析器。

xrtHttpParamHostValid 直接消费 xhttpparam 的语义值。quoted-pair 会在验证时 流式解码,任意长度 reg-name 与 IPvFuture 不进入固定缓冲,也不申请堆内存。

Header 解析

xrtHttp1RequestParse 和 xrtHttp1ResponseParse 接受从消息首字节开始的累计输入:

  • XHTTP1_MORE:输入尚未包含完整 Header;
  • XHTTP1_FIELDS:Header 完整,但字段描述符容量不足,FieldCount 给出需求;
  • XHTTP1_READY:解析完成;
  • XHTTP1_ERROR:协议、限额或参数错误。

解析器只接受 CRLF,拒绝 obs-fold、裸 LF、非法字段名、控制字符、冲突的 Content-Length、歧义 Transfer-Encoding 和非法 Upgrade。xhttp1errorinfo 提供稳定错误码、消息相对偏移和行号。

xhttp1limits 分别限制 Header 总长度、起始行、单字段行和字段数量。默认值面向 公网输入,服务端应按路由策略进一步收紧,而不是无上限增长接收缓冲。

网络热路径使用 xrtHttp1RequestParseBuffer、xrtHttp1ResponseParseBuffer 直接扫描 xnetbuf。只有完整 Header 跨块时才连续化实际 Header 前缀,函数不消费输入,Upgrade 后的余量 保持原位。TLS 对应入口是 xrtHttp1RequestParseTls、xrtHttp1ResponseParseTls;输入不足时它们 通过 xrtTlsStreamReadMore 请求下一段受限明文,Header 完成后仍由调用方消费 Head.Bytes。

正文计划

Header 完成后必须调用:

  • xrtHttp1RequestBodyPlan 处理请求;
  • xrtHttp1ResponseBodyPlan 处理响应,并传入原请求方法。

xhttp1bodyplan 的模式是唯一分帧结论:

  • XHTTP1_BODY_NONE:没有正文;
  • XHTTP1_BODY_FIXED:Content-Length 定长;
  • XHTTP1_BODY_CHUNKED:分块编码;
  • XHTTP1_BODY_CLOSE:由可靠 EOF 定界;
  • XHTTP1_BODY_TUNNEL:CONNECT 或 101 后的字节不再属于 HTTP。

响应计划覆盖 HEAD、成功 CONNECT、1xx、204 和 304。调用方不应仅凭 Content-Length 判断响应正文。

流式接收

xrtHttp1BodyInit 创建无分配 reader。xrtHttp1BodyRead 每次返回一个借用正文 片段、容量请求或终态,并通过 Consumed 精确说明已消费线路字节。

xrtHttp1BodyLimitsInit 的 MaxBody 默认为 UINT64_MAX,因为底层 reader 不拥有、 聚合或分配正文。服务端、代理以及任何会持有正文的上层必须在接收前按路由和内存预算 设置有限上限,不能把该协议层默认值直接作为公网接收策略。

对于 chunked,reader 会验证 chunk-size、扩展语法、CRLF、last-chunk 和 trailer, 并严格拒绝 chunk-size 与分号或 CRLF 之间的空白,避免端点对报文边界产生分歧。 正文视图不包含分块元数据。Received 是应用正文长度,WireBytes 是正文区实际 线路长度。

当返回 XHTTP1_BODY_FIELDS 时,TrailerCount 给出所需描述符数量。调用 xrtHttp1BodyTrailers 绑定足够存储后,用同一输入继续解析,不会丢失进度。

close-delimited 模式只有在传输层给出可靠 EOF 时才传入 bEnd = true。超时、取消、 RST 和普通 EOF 不能混为同一种上层状态。

gzip 自动解码

xrtHttpDecodeCreate 直接读取解析后的字段数组。把 xrtHttp1BodyRead 发布的每个 正文片段交给 xrtHttpDecodeWrite,并只在 body reader 完成时设置 bFinal。

identity 和显式原样回退路径不复制输入。gzip/deflate 路径按 Content-Encoding 逆序流式解码,验证 gzip Header、CRC、ISIZE 和压缩流终态。每个中间层与最终 输出都受同一明文硬限额约束。

详见 HTTP 正文解码。

原始写出

xrtHttp1RequestWrite 和 xrtHttp1ResponseWrite 不添加 Host、Date、Server 或其他 策略字段。空输出用于精确测量,容量不足不会产生半个 Header。

高性能发送建议:

1. 在连接或协程栈上的小缓冲中写 Header; 2. 用 xrtNetStreamSendVec 一次提交 Header 与小正文; 3. 大正文用 xrtNetStreamSendRef、SendRefs、SendTake 或 SendBuffer; 4. chunked 正文只用 xrtHttp1ChunkLineWrite 生成短前缀,数据本身保持引用发送; 5. XNET_RESULT_AGAIN 时等待 writable/drain,不绕过网络队列硬上限。

这条路径只构造必需的线路字节,不创建请求、响应、字典或正文对象。

报文长度

  • xhttp1head.Bytes:起始行、Header 和最终空行的线路长度;
  • xhttp1bodyplan.Length:定长正文长度,仅在 FIXED 模式有效;
  • xhttp1body.Received:已经发布的应用正文长度;
  • xhttp1body.WireBytes:已经消费的正文线路长度;
  • xhttp1message.Wire.Size:连续输入中第一条完整消息的线路总长度;
  • xhttp1message.BodyBytes:移除 chunked 元数据后的正文长度。

chunked 和 close-delimited 消息在完成前不存在可提前得知的总线路长度。

TLS 与 Upgrade

HTTP 不拥有 TLS。http1_tls 只是块链适配器,不创建连接或安全策略;证书验证、SNI、会话恢复和 ALPN 仍属于通用 TLS 模块。它按需连续化实际 Header,不增加连接级固定缓冲。

xrtHttpUpgrade*、xrtHttpConnection* 和 WebSocket 握手函数共同完成 Upgrade 验证。101 后的剩余字节必须原样交给新协议,不能继续送入 HTTP body reader。

完整消息便利层

xrtHttp1RequestMessageParse 和 xrtHttp1ResponseMessageParse 适合已经连续驻留在 内存中的报文、测试和协议网关。它们仍只借用输入,不持有堆对象。

固定长度或 close-delimited 正文可由 xrtHttp1MessageBodyView 直接查看;chunked 正文使用 xrtHttp1MessageBodyCopy 去除分帧。真正的网络热路径应优先使用流式 body reader,避免等待和复制整个消息。

扩展库边界

客户端池、重定向、重试、缓存、认证、Cookie、MIME、Multipart、FormData、SSE、 服务器路由和中间件属于独立发布的 xhttp 扩展;它们不参与 XRT 核心构建、单头包或 兼容性承诺。

xhttpupgradeitem类型

一个 Upgrade 协议借用原字段值;空 Version 表示线路中没有版本。

字段类型语义
ProtocolxstrviewProtocol
Versionxstrview结构版本
typedef struct xhttpupgradeitem { xstrview Protocol; xstrview Version; } xhttpupgradeitem;

xhttpupgradecursor类型

单字段游标由初始化函数建立,调用方不得直接修改。

字段类型语义
Offsetsize_t偏移量
Validateduint8是否已校验
typedef struct xhttpupgradecursor { size_t Offset; uint8 Validated; } xhttpupgradecursor;

xhttpupgradefieldcursor类型

重复字段游标同时记录当前字段和字段内位置。

字段类型语义
Fieldsize_tField
Offsetsize_t偏移量
Validateduint8是否已校验
typedef struct xhttpupgradefieldcursor { size_t Field; size_t Offset; uint8 Validated; } xhttpupgradefieldcursor;
单值解析

xrtHttpUpgradeCursorInit函数

初始化单个 Upgrade 字段值游标。

void xrtHttpUpgradeCursorInit(xhttpupgradecursor* pCursor)

参数

参数方向约束说明
pCursor输出非空调用方存储
返回值
返回含义失败时状态
无纯初始化—
错误
  • 无

范例已编译验证

http/small_fields · Upgrade · 观察

		xrtHttpUpgradeCursorInit(&UpCursor);

xrtHttpUpgradeParse函数

严格解析一个 protocol-name[/protocol-version] 元素。

bool xrtHttpUpgradeParse(xstrview Text, xhttpupgradeitem* pUpgrade)

参数

参数方向约束说明
Text输入借用单个协议元素
pUpgrade输出非空接收名称/版本
返回值
返回含义失败时状态
true已解析—
false语法错误输出不变
错误
  • xrt.http 域错误

范例已编译验证

http/small_fields · Upgrade · 观察

		if ( !xrtHttpUpgradeParse(SV("websocket"), &Upgrade) ||
			(Upgrade.Protocol.Size != 9u) ) {

xrtHttpUpgradeValid函数

完整验证一个 Upgrade 字段值;空列表符合列表语法。

bool xrtHttpUpgradeValid(xstrview Value)

参数

参数方向约束说明
Value输入借用字段值
返回值
返回含义失败时状态
true合法—
false非法纯谓词
错误
  • 无 — 纯谓词

范例已编译验证

http/small_fields · Upgrade · 观察

			!xrtHttpUpgradeValid(SV("websocket")) ||
			xrtHttpUpgradeValid(SV("bad token")) ) {

xrtHttpUpgradeCount函数

完整验证并统计一个 Upgrade 字段值中的协议数量。

bool xrtHttpUpgradeCount(xstrview Value, size_t* pCount)

参数

参数方向约束说明
Value输入借用字段值
pCount输出非空接收计数
返回值
返回含义失败时状态
true计数已写出—
false语法错误计数不变
错误
  • xrt.http 域错误

范例已编译验证

http/small_fields · Upgrade · 观察

			!xrtHttpUpgradeCount(SV("websocket, h2c"),
				&iCount) ||
			(iCount != 2u) ||

xrtHttpUpgradeNext函数

按线路顺序迭代一个完整 Upgrade 字段值。

xhttpnext xrtHttpUpgradeNext(xstrview Value, xhttpupgradecursor* pCursor, xhttpupgradeitem* pUpgrade)

参数

参数方向约束说明
Value输入借用字段值
pCursor输入/输出已初始化游标
pUpgrade输出非空接收条目
返回值
返回含义失败时状态
XHTTP_NEXT_ITEM已产出一项—
XHTTP_NEXT_END遍历结束不设错误
XHTTP_NEXT_ERROR解析失败xrt.http 域错误
错误
  • xrt.http 域错误

范例已编译验证

http/small_fields · Upgrade · 观察

		while ( xrtHttpUpgradeNext(SV("websocket, h2c"),
				&UpCursor, &Upgrade) == XHTTP_NEXT_ITEM ) {
跨字段与写出

xrtHttpUpgradeFieldCursorInit函数

初始化跨重复 Upgrade 字段游标。

void xrtHttpUpgradeFieldCursorInit(xhttpupgradefieldcursor* pCursor)

参数

参数方向约束说明
pCursor输出非空调用方存储
返回值
返回含义失败时状态
无纯初始化—
错误
  • 无

范例已编译验证

http/upgrade · 字段游标 · 观察

	xrtHttpUpgradeFieldCursorInit(&Cursor);

xrtHttpUpgradeFieldNext函数

跨重复 Upgrade 字段行按线路顺序迭代协议。

xhttpnext xrtHttpUpgradeFieldNext(const xhttpfield* pFields, size_t iCount, xhttpupgradefieldcursor* pCursor, xhttpupgradeitem* pUpgrade)

参数

参数方向约束说明
pFields输入借用数组字段数组
iCount输入—条目数
pCursor输入/输出已初始化游标
pUpgrade输出非空接收条目
返回值
返回含义失败时状态
XHTTP_NEXT_ITEM已产出一项—
XHTTP_NEXT_END遍历结束不设错误
XHTTP_NEXT_ERROR解析失败xrt.http 域错误
错误
  • xrt.http 域错误

范例已编译验证

http/upgrade · 字段游标 · 观察

	while ( (Next = xrtHttpUpgradeFieldNext(
		Fields, 2u, &Cursor, &Upgrade
	)) == XHTTP_NEXT_ITEM ) {

xrtHttpUpgradeWrite函数

规范写出一个或多个 Upgrade 协议;空输出可精确查询长度。

bool xrtHttpUpgradeWrite(const xhttpupgradeitem* pUpgrades, size_t iCount, void* pOutput, size_t iCapacity, size_t* pSize)

参数

参数方向约束说明
pUpgrades输入借用数组协议元素数组
iCount输入—条目数
pOutput输出可空空+零容量 = 查长度
iCapacity输入—容量
pSize输出可空长度
返回值
返回含义失败时状态
true已写出—
false容量不足或参数错误输出不变
错误
  • XERR_ARGUMENT — 指针为空或视图非法
  • XERR_RANGE — 容量不足

范例已编译验证

http/upgrade · 写出 · 观察

		!xrtHttpUpgradeWrite(
			Offered,
			2u,
			sOutput,
			sizeof(sOutput),
			&iSize
		) ) {

xrtHttpUpgradeElementWrite函数

规范写出一个 Upgrade 协议元素。

bool xrtHttpUpgradeElementWrite(const xhttpupgradeitem* pUpgrade, void* pOutput, size_t iCapacity, size_t* pSize)

参数

参数方向约束说明
pUpgrade输入非空协议元素
pOutput输出可空输出缓冲
iCapacity输入—容量
pSize输出可空长度
返回值
返回含义失败时状态
true已写出—
false容量不足或参数错误输出不变
错误
  • XERR_ARGUMENT — 指针为空或视图非法
  • XERR_RANGE

范例已编译验证

http/small_fields · Upgrade · 观察

			if ( !xrtHttpUpgradeElementWrite(
					&(xhttpupgradeitem){ SV("h2c"), SV("v2") },
					Buffer, sizeof(Buffer), &iCount) ||
				(iCount != 6u) ||
				(memcmp(Buffer, "h2c/v2", 6u) != 0) ) {

xrtHttpUpgradeBuild函数

构建零结尾 Upgrade 字段值,返回值由 xrtFree 释放。

str xrtHttpUpgradeBuild(const xhttpupgradeitem* pUpgrades, size_t iCount, size_t* pSize)

参数

参数方向约束说明
pUpgrades输入借用数组协议元素数组
iCount输入—条目数
pSize输出可空接收长度
返回值
返回含义失败时状态
非空零结尾结果—
NULL参数错误或 OOM错误经 xrtGetError() 报告
错误
  • XERR_ARGUMENT — 指针为空或视图非法
  • XERR_MEMORY

范例已编译验证

http/small_fields · Upgrade · 观察

			str sBuilt = xrtHttpUpgradeBuild(arrUp, 2u, &iCount);