TouchSocket.Http
静态文件缓存池
添加委托
Is the file cache empty?
Get the file cache size
Add a new cache value with the given millisecondsTimeout into the file cache
Key to add
Value to add
Cache millisecondsTimeout (default is 0 - no millisecondsTimeout)
'true' if the cache value was added, 'false' if the given key was not added
Try to find the cache value by the given key
Key to find
'true' and cache value if the cache value was found, 'false' if the given key was not found
Remove the cache value with the given key from the file cache
Key to remove
'true' if the cache value was removed, 'false' if the given key was not found
Insert a new cache path with the given millisecondsTimeout into the file cache
Path to insert
Cache prefix (default is "/")
Cache filter (default is "*.*")
Cache millisecondsTimeout (default is 0 - no millisecondsTimeout)
Cache insert handler (default is 'return cache.Add(key, value, millisecondsTimeout)')
'true' if the cache path was setup, 'false' if failed to setup the cache path
Try to find the cache path
Path to find
'true' if the cache path was found, 'false' if the given path was not found
Remove the cache path from the file cache
Path to remove
'true' if the cache path was removed, 'false' if the given path was not found
Clear the memory cache
释放
析构函数
Http基础头部
服务器版本
构造函数
能否写入。
客户端
内容填充完成
内容长度
保持连接。
一般的,当是http1.1时,如果没有显式的Connection: close,即返回true。当是http1.0时,如果没有显式的Connection: Keep-Alive,即返回false。
内容类型
允许编码
可接受MIME类型
传递标识
请求头集合
协议名称,默认HTTP
HTTP协议版本,默认1.1
请求行
从Request中持续读取数据。
从内存中读取
设置一次性内容
获取一次性内容。
持续写入内容。
读取信息
重置Http状态。
Http上下文
构造函数
构造函数
Http请求
Http响应
HttpMethod
值
Get
Post
Put
Delete
表示
值
转换为字符串
获取哈希码
比较是否和目标相等
目标
等于
不等于
Http代理
不带基本验证的代理
带基本验证的代理
验证代理
代理的地址
Range: bytes=0-499 表示第 0-499 字节范围的内容
Range: bytes=500-999 表示第 500-999 字节范围的内容
Range: bytes=-500 表示最后 500 字节的内容
Range: bytes=500- 表示从第 500 字节开始到文件结束部分的内容
Range: bytes=0-0,-1 表示第一个和最后一个字节
Range: bytes=500-600,601-999 同时指定几个范围
转换获取的集合
转换获取的集合
起始位置
长度
HTTP请求定义
构造函数
构造函数
表单数据
HTTP请求方式。
Body参数
url参数
相对路径(不含参数)
Url全地址,包含参数
构建响应数据。
当数据较大时,不建议这样操作,可直接
构建数据为字节数组。
设置内容
设置代理Host
设置Url,可带参数
输出
从内存中读取
构建响应头部
Http响应
Http响应
从创建一个Http响应
构造函数
是否分块
是否代理权限验证。
是否重定向
是否已经响应数据。
状态码,默认200
状态消息,默认Success
构建数据并回应。
该方法仅在具有Client实例时有效。
构建数据并回应。
该方法仅在具有Client实例时有效。
构建响应数据。
当数据较大时,不建议这样操作,可直接
输出
构建数据为字节数组。
当传输模式是Chunk时,用于结束传输。
读取数据
构建响应头部
Http工具
从扩展名获取ContentType
多文件集合
多文件集合
获取一个迭代器。
HttpUtility
非缓存上限
处理代理认证凭证
构造
服务器返回的凭证认证类型
基本凭证用户名密码
暂时不知道是什么
暂时不知
其实用不用他都一样
凭证类型
转换成凭证本文
代理身份认证类型
不允许身份认证
指定摘要身份验证。
指定基本身份验证。
指定匿名身份验证。
代理身份认证
构造
基本认证应该不需要这个
凭证用户名
凭证密码
Domain
Roles
Http客户端
Http客户端基类
HttpClient客户端连接池
最大连接数量。
目标地址
清除现有的所有链接
发起请求,并获取数据体
请求体
等待超时时间
结束等待令箭
发起请求,并获取数据体
请求体
等待超时时间
结束等待令箭
这是基于的通讯模型。
这是基于的通讯模型。
通讯客户端
HTTP/HTTPS服务器
HTTP/HTTPS服务器
http辅助类
构造函数
当收到到Http请求时。覆盖父类方法将不会触发插件。
Http终端接口
发起请求
请求体
仅仅请求,而不等待结果
等待超时时间
结束等待令箭
发起请求
请求体
仅仅请求,而不等待结果
等待超时时间
结束等待令箭
发起请求,并获取数据体
请求体
仅仅请求,而不等待结果
等待超时时间
结束等待令箭
发起请求,并获取数据体
请求体
仅仅请求,而不等待结果
等待超时时间
结束等待令箭
Http终端基础接口
IHttpService
IHttpService
IHttpServiceBase
Http服务器终端接口
当该连接是WebSocket时,可获取该对象,否则为null。
转化Protocol协议标识为
Http上下文
CorsBuilder
允许客户端携带验证信息
请求头
允许跨域的方法。
允许跨域的域名
允许所有的Header
允许任何Method。
允许所有的源
允许客户端携带验证信息
允许跨域的Header
允许跨域的方法。
例如“PUT,POST,GET,DELETE,OPTIONS,HEAD,PATCH”
允许跨域的域名
构建
跨域相关配置
跨域策略集
添加跨域策略
添加跨域策略
可以配置跨域的插件
可以配置跨域的插件
CorsResult
CorsResult
允许客户端携带验证信息
请求头
允许跨域的方法。
允许跨域的域名
应用跨域策略
跨域相关的服务类接口
按照策略名称,获取策略
Http客户端数据处理适配器
缓存数据,如果需要手动释放,请先判断,然后到调用后,再置空;
Http服务器数据处理适配器
缓存数据,如果需要手动释放,请先判断,然后到调用后,再置空;
HTTP上下文事件委托
请求头枚举
Cache-Control 标头,指定请求/响应链上所有缓存控制机制必须服从的指令。
Connection 标头,指定特定连接需要的选项。
Date 标头,指定开始创建请求的日期和时间。
Keep-Alive 标头,指定用以维护持久性连接的参数。
Pragma 标头,指定可应用于请求/响应链上的任何代理的特定于实现的指令。
Trailer 标头,指定标头字段显示在以 chunked 传输编码方式编码的消息的尾部。
Transfer-Encoding 标头,指定对消息正文应用的转换的类型(如果有)。
Upgrade 标头,指定客户端支持的附加通信协议。
Via 标头,指定网关和代理程序要使用的中间协议。
Warning 标头,指定关于可能未在消息中反映的消息的状态或转换的附加信息。
Allow 标头,指定支持的 HTTP 方法集。
Content-Length 标头,指定伴随正文数据的长度(以字节为单位)。
Content-Type 标头,指定伴随正文数据的 MIME 类型。
Content-Encoding 标头,指定已应用于伴随正文数据的编码。
Content-Langauge 标头,指定伴随正文数据的自然语言。
Content-Location 标头,指定可从其中获得伴随正文的 URI。
Content-MD5 标头,指定伴随正文数据的 MD5 摘要,用于提供端到端消息完整性检查。
Content-Range 标头,指定在完整正文中应用伴随部分正文数据的位置。
Expires 标头,指定日期和时间,在此之后伴随的正文数据应视为陈旧的。
Last-Modified 标头,指定上次修改伴随的正文数据的日期和时间。
Accept 标头,指定响应可接受的 MIME 类型。
Accept-Charset 标头,指定响应可接受的字符集。
Accept-Encoding 标头,指定响应可接受的内容编码。
Accept-Langauge 标头,指定响应首选的自然语言。
Authorization 标头,指定客户端为向服务器验证自身身份而出示的凭据。
Cookie 标头,指定向服务器提供的 Cookie 数据。
Expect 标头,指定客户端要求的特定服务器行为。
From 标头,指定控制请求用户代理的用户的 Internet 电子邮件地址。
Host 标头,指定所请求资源的主机名和端口号。
If-Match 标头,指定仅当客户端的指示资源的缓存副本是最新的时,才执行请求的操作。
If-Modified-Since 标头,指定仅当自指示的数据和时间之后修改了请求的资源时,才执行请求的操作。
If-None-Match 标头,指定仅当客户端的指示资源的缓存副本都不是最新的时,才执行请求的操作。
If-Range 标头,指定如果客户端的缓存副本是最新的,仅发送指定范围的请求资源。
If-Unmodified-Since 标头,指定仅当自指示的日期和时间之后修改了请求的资源时,才执行请求的操作。
Max-Forwards 标头,指定一个整数,表示此请求还可转发的次数。
Proxy-Authorization 标头,指定客户端为向代理验证自身身份而出示的凭据。
Referer 标头,指定从中获得请求 URI 的资源的 URI。
Range 标头,指定代替整个响应返回的客户端请求的响应的子范围。
TE 标头,指定响应可接受的传输编码方式。
Translate 标头,与 WebDAV 功能一起使用的 HTTP 规范的 Microsoft 扩展。
User-Agent 标头,指定有关客户端代理的信息。
Accept-Ranges 标头,指定服务器接受的范围。
Age 标头,指定自起始服务器生成响应以来的时间长度(以秒为单位)。
Etag 标头,指定请求的变量的当前值。
Location 标头,指定为获取请求的资源而将客户端重定向到的 URI。
Proxy-Authenticate 标头,指定客户端必须对代理验证其自身。
Retry-After 标头,指定某个时间(以秒为单位)或日期和时间,在此时间之后客户端可以重试其请求。
Server 标头,指定关于起始服务器代理的信息。
Set-Cookie 标头,指定提供给客户端的 Cookie 数据。
Vary 标头,指定用于确定缓存的响应是否为新响应的请求标头。
WWW-Authenticate 标头,指定客户端必须对服务器验证其自身。
Origin。
Content-Disposition
Http请求事件类
Http上下文
构造函数
HttpContainerExtension
向注册器中添加跨域服务。
Http扩展辅助
根据字符串获取枚举
添加Header参数
添加Header参数
从Json
从文本
从Xml格式
获取Body的字符串
当数据类型为multipart/form-data时,获取boundary
设置内容
设置数据体长度
从扩展名设置内容类型,必须以“.”开头
写入
获取多文件集合。如果不存在,则返回null。
初始化常规的请求头。
包含:
- Connection:keep-alive
- Pragma:no-cache
- UserAgent:TouchSocket.Http
添加Host请求头
添加Query参数
对比不包含参数的Url。其中有任意一方为null,则均返回False。
作为Delete访问
作为Get访问
作为指定函数
作为Post访问
作为Put访问
是否作为Delete访问
是否作为Get访问
是否作为指定函数
是否作为Post访问
是否作为Put访问
是否在headers中包含升级连接
设置文件类型。
判断返回的状态码是否为成功。
当不指定具体的状态码时,只要状态码在200-299之间则为。
当指定时,状态码不仅必须要在200-299之间,还必须是指定的状态码才会返回。
设置状态,并且附带时间戳。
设置默认Success状态,并且附带时间戳。
路径文件没找到
从文件响应。
当response支持持续写入时,会直接回复响应。并阻塞执行,直到完成。所以在执行该方法之前,请确保已设置完成所有状态字
当response不支持持续写入时,会填充Content,且不会响应,需要自己执行Build,并发送。
响应
请求头,用于尝试续传,为null时则不续传。
文件路径
文件名,不设置时会获取路径文件名
最大速度(仅企业版有效)。
读取长度。
从文件响应。
当response支持持续写入时,会直接回复响应。并阻塞执行,直到完成。所以在执行该方法之前,请确保已设置完成所有状态字
当response不支持持续写入时,会填充Content,且不会响应,需要自己执行Build,并发送。
上下文
文件路径
文件名,不设置时会获取路径文件名
最大速度(仅企业版有效)。
读取长度。
从文件响应。
当response支持持续写入时,会直接回复响应。并阻塞执行,直到完成。所以在执行该方法之前,请确保已设置完成所有状态字
当response不支持持续写入时,会填充Content,且不会响应,需要自己执行Build,并发送。
响应
请求头,用于尝试续传,为null时则不续传。
文件路径
文件名,不设置时会获取路径文件名
最大速度(仅企业版有效)。
读取长度。
从文件响应。
当response支持持续写入时,会直接回复响应。并阻塞执行,直到完成。所以在执行该方法之前,请确保已设置完成所有状态字
当response不支持持续写入时,会填充Content,且不会响应,需要自己执行Build,并发送。
上下文
文件路径
文件名,不设置时会获取路径文件名
最大速度(仅企业版有效)。
读取长度。
IContentTypeProvider
给定文件路径,确定MIME类型
表单文件
获取Content-Disposition
获取Content-Type
实际的数据
数据对
获取file name
文件长度。在数据接收完成之前,该值为-1;
获取name字段
表示http的headers
获取Header
获取Header
添加Header
获取、添加Header
Http参数
获取参数
默认的Http服务。为Http做兜底拦截。该插件应该最后添加。
IHttpPlugin
在收到Http请求。
IHttpPlugin
FileExtensionContentTypeProvider
FileExtensionContentTypeProvider
FileExtensionContentTypeProvider
Http静态内容插件
构造函数
提供文件扩展名和MIME类型之间的映射。
静态文件缓存。
重新导航
在响应之前调用。
添加静态
Static content path
Cache prefix (default is "/")
Cache filter (default is "*.*")
Refresh cache millisecondsTimeout (default is 1 hour)
Clear static content cache
Remove static content cache
Static content path
设置提供文件扩展名和MIME类型之间的映射。
设定重新导航
设定重新导航
在响应之前调用。
在响应之前调用。
静态页面配置
WebSocket配置
版本
WebSocketReceiveResult
WebSocketReceiveResult
WebSocket数据帧
连接已关闭
WebSocket数据帧
是否为最后数据帧。
是否是二进制数据类型
是否是关闭请求
是否是Ping
是否是Pong
是否是文本类型
计算掩码
掩码值
数据类型
有效数据
有效载荷数据长度
标识RSV-1。
标识RSV-2。
标识RSV-3。
构建数据
TotalSize
设置Mask。
WSTools
应答。
构建数据
计算Base64值
获取Base64随即字符串。
掩码运算
获取WS的请求头
获取响应
SetupClientWebSocket
SetupClientWebSocket
是否已完成连接
通讯实际客户端
中断连接
加载配置
已断开连接。
收到数据
WebSocketClient用户终端简单实现。
收到WebSocket数据
WebSocket用户终端。
WebSocket用户终端
连接到ws服务器
表示完成握手后。
表示在即将握手连接时。
表示完成握手后。
表示在即将握手连接时。
当收到WS数据时。
WebSocket适配器
数据包剩余长度
临时包
解码
当接收到数据时处理数据
数据流
分解包
收到WebSocket数据
WebSocket数据类型
表示一个中间数据包
表示一个text类型数据包
表示一个binary类型数据包
表示一个断开连接类型数据包
表示一个ping类型数据包
表示一个pong类型数据包
WS数据事件类
构造函数
WS数据帧。
WebSocket连接异常。
WebSocket连接异常
HttpContext
WebSocketClientExtension
WSDataFrame辅助扩展类
追加二进制流
追加文本
构建请求数据(含Make)
构建请求数据(含Make)
构建响应数据(无Make)
构建响应数据(无Make)
当时,转换为Text消息。
IWebSocket
WebSocket版本
允许异步Read读取
使用的Http客户端
发送Ping报文。
发送Ping报文
发送Pong报文。
发送Pong报文
异步等待读取数据
采用WebSocket协议,发送WS数据。发送结束后,请及时释放
发送文本消息
发送二进制消息
发送二进制消息
发送二进制消息
采用WebSocket协议,发送WS数据。发送结束后,请及时释放
发送文本消息
发送二进制消息
发送二进制消息
用户终端接口
IWebSocketClosingPlugin
表示收到断开连接报文。如果对方直接断开连接,此方法则不会触发。
IWebSocketClosingPlugin
IWebSocketHandshakedPlugin
表示完成握手后。
IWebSocketHandshakedPlugin
IWebSocketHandshakingPlugin
表示在即将握手连接时。
IWebSocketHandshakingPlugin
IWebSocketReceivedPlugin
当收到WS数据时。
IWebSocketReceivedPlugin
WS命令行插件。
WSCommandLinePlugin
字符串转换器,默认支持基础类型和Json。可以自定义。
是否返回执行异常。
当有执行异常时,不返回异常。
基于Http的WebSocket的扩展。
此组件只能挂载在中
自动响应Close报文
自动响应Ping报文
WebSocketFeature
是否默认处理Close报文。
当收到ping报文时,是否自动回应pong。
验证连接
用于WebSocket连接的路径,默认为“/ws”
如果设置为null或空,则意味着所有的连接都将解释为WS
不处理Close报文。
验证连接
验证连接
用于WebSocket连接的路径,默认为“/ws”
如果设置为null或空,则意味着所有的连接都将解释为WS
当收到ping报文时,自动回应pong。
初始化一个适用于WebSocket的心跳插件
HttpConfigExtensions
构建Http类客户端,并连接
构建Http类客户端,并连接
构建Http类服务器,并启动。
构建Http类服务器,并启动。
Http代理
设置Http代理
WebSocketConfigExtensions
构建WebSocketClient类客户端,并连接
构建WebSocketClient类客户端,并连接
WebSocket配置属性
设置WebSocket的相关配置
HttpPluginManagerExtension
默认的Http服务。为Http做兜底拦截。该插件应该最后添加。
使用Http静态页面。
使用跨域
WebSocketPluginManagerExtension
使用WebSocket插件。
插件类型实例
使用WebSocket心跳插件,客户端、服务器均有效。但是一般建议客户端使用即可。
插件类型实例
TouchSocketHttp资源枚举
未知错误
操作成功
操作超时
用户主动取消操作。
参数‘{0}’为空。
发生异常,信息:{0}。