模块契约HTTP Trailer

线程

Trailer 解析 API 为无共享状态的纯函数,可任意线程并发调用。

字段声明

xrtHttpTrailerCount 完整验证全部重复 Trailer 字段行,并返回声明名称总数。 字段值使用 token-list;按 RFC 列表扩展规则,空值表示零个声明。每个名称还必须 通过通用 trailer 策略。输出在失败时保持为零,后置畸形字段不会造成部分发布。

xrtHttpTrailerFind 完整验证全部声明后返回三态结果:

  • XHTTP_NEXT_ITEM:名称已经声明;
  • XHTTP_NEXT_END:声明有效但不包含该名称;
  • XHTTP_NEXT_ERROR:查询名称或任一 Trailer 字段无效。

需要逐项处理时,可直接使用基础层 xrtHttpFieldTokenNext,字段名传入 Trailer;再用 xrtHttpTrailerNameValid 应用发送策略。

实际尾字段

xrtHttpTrailerSectionValid 校验实际 trailer section。它同时验证每个字段名是否 允许在线路末尾发送,以及字段值是否满足通用 HTTP 字段值语法。客户端、服务器、 HTTP/1 chunked 写出器和声明构建器共用这一入口,不再分别维护名称循环。

Header section 与 trailer section 必须保持分离。Trailer 声明只表示可能出现的 名称,声明缺少实际字段不是协议错误,实际字段未被提前声明也不应由协议解析层直接 判为错误;需要更严格对应关系的应用可用 xrtHttpTrailerFind 实施自己的策略。

发送策略

xrtHttpTrailerNameValid 拒绝会改变消息分帧、路由、请求条件、响应控制、认证或 正文解释的字段。返回 true 仍不代表某个扩展字段的定义允许它出现在 trailer; 发送方必须同时遵守该字段自己的规范。

xrtHttpTrailerNamesWrite 从实际 xhttpfield[] 生成声明值。它按 ASCII 大小写不敏感规则去重,保留第一次出现的名称与线路顺序;空输出可查询精确长度, 写入路径不分配内存,也不接受与输入描述符或借用文本重叠的输出。实际字段名称和值 会先经过 xrtHttpTrailerSectionValid,因此声明构建成功后不会在 chunk-end 写出阶段 才发现无效字段值。

xrtHttpTrailerNamesBuild 是一次分配便利层,返回零结尾文本并通过 pSize 返回 不含终止零的长度。返回值由 xrtFree 释放。

HTTP/1 的 chunked 解析和末块写出仍由 http1_body 负责;客户端与服务器准备层 使用本模块生成 Trailer Header,不再各自实现拼接逻辑。

裁剪与依赖

  • 宏:XRT_MODULE_HTTP_TRAILER;
  • 功能:XRT_FEATURE_HTTP_TRAILER;
  • 直接依赖:http;
  • section 校验、声明统计、查询和缓冲写入零分配;
  • 测试覆盖重复字段、后置错误、禁止名称、大小写去重、未对齐描述符、重叠输出、

短缓冲、OOM、单头发布和超过 1 KiB 的动态声明。

协议依据:RFC 9110 Trailer Fields、 RFC 9110 Trailer、 RFC 9112 Chunked Trailer Section 以及 RFC 9530 Digest Fields。

模块边界

模块裁剪宏作用
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 核心构建、单头包或 兼容性承诺。

名称校验

xrtHttpTrailerNameValid函数

判断字段名是否可作为通用 HTTP trailer 发送。

bool xrtHttpTrailerNameValid(xstrview Name)

参数

参数方向约束说明
Name输入借用字段名
返回值
返回含义失败时状态
true可发送(非禁投递集合)—
false禁止作为 trailer纯谓词
错误
  • 无 — 纯谓词

范例已编译验证

http/small_fields · Trailer · 观察

			!xrtHttpTrailerNameValid(SV("X-Checksum")) ||
			xrtHttpTrailerNameValid(SV("Bad Name")) ) {

xrtHttpTrailerSectionValid函数

完整验证实际 trailer section 的字段名称和值。

bool xrtHttpTrailerSectionValid(const xhttpfield* pTrailers, size_t iCount)

参数

参数方向约束说明
pTrailers输入借用数组实际 trailer 字段
iCount输入—条目数
返回值
返回含义失败时状态
true名称与值全部合法—
false存在禁投递名或非法值纯谓词
错误
  • 无 — 纯谓词

范例已编译验证

http/small_fields · Trailer · 观察

			if ( !xrtHttpTrailerSectionValid(arrSection, 1u) ||
				xrtHttpTrailerSectionValid(arrBad, 1u) ) {
声明生成与查询

xrtHttpTrailerCount函数

完整验证重复 Trailer 字段行并统计其中声明的名称。

bool xrtHttpTrailerCount(const xhttpfield* pFields, size_t iCount, size_t* pNameCount)

参数

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

范例已编译验证

http/small_fields · Trailer · 观察

		if ( !xrtHttpTrailerCount(arrTrailer, 2u, &iCount) ||
			(iCount != 3u) ||
			!xrtHttpTrailerFind(arrTrailer, 2u,
				SV("X-Checksum")) ||
			xrtHttpTrailerFind(arrTrailer, 2u,
				SV("X-Missing")) ||
			!xrtHttpTrailerNameValid(SV("X-Checksum")) ||
			xrtHttpTrailerNameValid(SV("Bad Name")) ) {

xrtHttpTrailerFind函数

查找已声明的 trailer 字段名;返回 ITEM、END 或 ERROR。

xhttpnext xrtHttpTrailerFind(const xhttpfield* pFields, size_t iCount, xstrview Name)

参数

参数方向约束说明
pFields输入借用数组声明字段
iCount输入—条目数
Name输入借用查找名称
返回值
返回含义失败时状态
XHTTP_NEXT_ITEM已产出一项—
XHTTP_NEXT_END遍历结束—
XHTTP_NEXT_ERROR失败—
错误
  • xrt.http 域错误

范例已编译验证

http/small_fields · Trailer · 观察

			!xrtHttpTrailerFind(arrTrailer, 2u,
				SV("X-Checksum")) ||
			xrtHttpTrailerFind(arrTrailer, 2u,

xrtHttpTrailerNamesWrite函数

从实际 trailer 字段写出规范的 Trailer 声明值;同名按大小写不敏感去重并保留首现顺序。

bool xrtHttpTrailerNamesWrite(const xhttpfield* pTrailers, size_t iTrailerCount, void* pOutput, size_t iCapacity, size_t* pSize)

参数

参数方向约束说明
pTrailers输入借用数组实际字段
iTrailerCount输入—条目数
pOutput输出可空、不得与描述符重叠空+零容量 = 查长度
iCapacity输入—容量
pSize输出可空长度
返回值
返回含义失败时状态
true已写出—
false容量不足或重叠输出不变
错误
  • XERR_ARGUMENT — 指针为空或视图非法
  • XERR_RANGE — 容量不足

范例已编译验证

http/small_fields · Trailer · 观察

			if ( !xrtHttpTrailerNamesWrite(arrActual, 2u,
					Buffer, sizeof(Buffer), &iCount) ||
				(iCount != 19u) ||
				(memcmp(Buffer, "X-Checksum, X-Total",
					19u) != 0) ) {

xrtHttpTrailerNamesBuild函数

构建零结尾的 Trailer 声明值,返回值由 xrtFree 释放。

str xrtHttpTrailerNamesBuild(const xhttpfield* pTrailers, size_t iTrailerCount, size_t* pSize)

参数

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

范例已编译验证

http/trailer · 构建 · 观察

	sNames = xrtHttpTrailerNamesBuild(Trailers, 2u, NULL);