CommonNetwork.xml 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>CommonNetwork</name>
  5. </assembly>
  6. <members>
  7. <member name="T:CommonNetwork.Client.NetClient">
  8. <summary>
  9. 用于监听请求回馈的客户端程序
  10. </summary>
  11. </member>
  12. <member name="P:CommonNetwork.Http.HttpWebSocket.TimeOut">
  13. <summary>
  14. 获取或设置请求与回应的超时时间,默认3秒.
  15. </summary>
  16. </member>
  17. <member name="P:CommonNetwork.Http.HttpWebSocket.Cookies">
  18. <summary>
  19. 获取或设置请求cookie
  20. </summary>
  21. </member>
  22. <member name="P:CommonNetwork.Http.HttpWebSocket.HttpHeaders">
  23. <summary>
  24. 获取请求返回的 HTTP 头部内容
  25. </summary>
  26. </member>
  27. <member name="F:CommonNetwork.Http.HttpWebSocket.ErrorMessageSeparate">
  28. <summary>
  29. 获取或设置错误信息分隔符
  30. </summary>
  31. </member>
  32. <member name="M:CommonNetwork.Http.HttpWebSocket.GetImageUseSocket(System.String,System.String,System.String)">
  33. <summary>
  34. get或post方式请求一个 http 或 https 地址.使用 Socket 方式
  35. </summary>
  36. <param name="url">请求绝对地址</param>
  37. <param name="referer">请求来源地址,可为空</param>
  38. <param name="postData">post请求参数. 设置空值为get方式请求</param>
  39. <returns>返回图像</returns>
  40. </member>
  41. <member name="M:CommonNetwork.Http.HttpWebSocket.GetHtmlUseSocket(System.String,System.String)">
  42. <summary>
  43. get或post方式请求一个 http 或 https 地址.使用 Socket 方式
  44. </summary>
  45. <param name="url">请求绝对地址</param>
  46. <param name="postData">post请求参数. 设置空值为get方式请求</param>
  47. <returns>返回 html 内容,如果发生异常将返回上次http状态码及异常信息</returns>
  48. </member>
  49. <member name="M:CommonNetwork.Http.HttpWebSocket.GetHtmlUseSocket(System.String,System.String,System.String)">
  50. <summary>
  51. get或post方式请求一个 http 或 https 地址.使用 Socket 方式
  52. </summary>
  53. <param name="url">请求绝对地址</param>
  54. <param name="referer">请求来源地址,可为空</param>
  55. <param name="postData">post请求参数. 设置空值为get方式请求</param>
  56. <returns>返回 html 内容,如果发生异常将返回上次http状态码及异常信息</returns>
  57. </member>
  58. <member name="M:CommonNetwork.Http.HttpWebSocket.GetSocketResult(System.String,System.String,System.String)">
  59. <summary>
  60. get或post方式请求一个 http 或 https 地址.
  61. </summary>
  62. <param name="url">请求绝对地址</param>
  63. <param name="referer">请求来源地址,可为空</param>
  64. <param name="postData">post请求参数. 设置空值为get方式请求</param>
  65. <returns>返回的已解压的数据内容</returns>
  66. </member>
  67. <member name="M:CommonNetwork.Http.HttpWebSocket.GetHttpResult(System.Uri,System.String,System.String)">
  68. <summary>
  69. get或post方式请求一个 http 地址.
  70. </summary>
  71. <param name="uri">请求绝对地址</param>
  72. <param name="referer">请求来源地址,可为空</param>
  73. <param name="postData">post请求参数. 设置空值为get方式请求</param>
  74. <param name="headText">输出包含头部内容的StringBuilder</param>
  75. <returns>返回未解压的数据流</returns>
  76. </member>
  77. <member name="M:CommonNetwork.Http.HttpWebSocket.GetSslResult(System.Uri,System.String,System.String)">
  78. <summary>
  79. get或post方式请求一个 https 地址.
  80. </summary>
  81. <param name="uri">请求绝对地址</param>
  82. <param name="referer">请求来源地址,可为空</param>
  83. <param name="postData">post请求参数. 设置空值为get方式请求</param>
  84. <param name="headText">输出包含头部内容的StringBuilder</param>
  85. <returns>返回未解压的数据流</returns>
  86. </member>
  87. <member name="M:CommonNetwork.Http.HttpWebSocket.GetSendHeaders(System.Uri,System.String,System.String)">
  88. <summary>
  89. 返回请求的头部内容
  90. </summary>
  91. <param name="uri">请求绝对地址</param>
  92. <param name="referer">请求来源地址,可为空</param>
  93. <param name="postData">post请求参数. 设置空值为get方式请求</param>
  94. <returns>请求头部数据</returns>
  95. </member>
  96. <member name="M:CommonNetwork.Http.HttpWebSocket.SetThisHeaders(System.String)">
  97. <summary>
  98. 设置此类的字段
  99. </summary>
  100. <param name="headText">头部文本</param>
  101. </member>
  102. <member name="M:CommonNetwork.Http.HttpWebSocket.unGzip(System.IO.MemoryStream)">
  103. <summary>
  104. 解压数据流
  105. </summary>
  106. <param name="data">数据流, 压缩或未压缩的.</param>
  107. <returns>返回解压缩的数据流</returns>
  108. </member>
  109. <member name="M:CommonNetwork.Http.HttpWebSocket.ProcessData``1(``0,System.IO.MemoryStream@)">
  110. <summary>
  111. 处理请求返回的数据.
  112. </summary>
  113. <typeparam name="T">数据源类型</typeparam>
  114. <param name="reader">数据源实例</param>
  115. <param name="body">保存数据的流</param>
  116. </member>
  117. <member name="M:CommonNetwork.Http.HttpWebSocket.GetHeaders``1(``0,System.Byte[]@,System.Int32@)">
  118. <summary>
  119. 取得返回的http头部内容,并设置相关属性.
  120. </summary>
  121. <typeparam name="T">数据源类型</typeparam>
  122. <param name="reader">数据源实例</param>
  123. <param name="data">待处理的数据</param>
  124. <param name="readLength">读取的长度</param>
  125. <returns>数据内容的起始位置,返回-1表示未读完头部内容</returns>
  126. </member>
  127. <member name="M:CommonNetwork.Http.HttpWebSocket.GetBodyData``1(``0,System.Byte[]@,System.Int32,System.Int32,System.IO.MemoryStream@)">
  128. <summary>
  129. 取得未分块数据的内容
  130. </summary>
  131. <typeparam name="T">数据源类型</typeparam>
  132. <param name="reader">数据源实例</param>
  133. <param name="data">已读取未处理的字节数据</param>
  134. <param name="startIndex">起始位置</param>
  135. <param name="readLength">读取的长度</param>
  136. <param name="body">保存块数据的流</param>
  137. </member>
  138. <member name="M:CommonNetwork.Http.HttpWebSocket.GetChunkData``1(``0,System.Byte[]@,System.Int32@,System.Int32@,System.IO.MemoryStream@)">
  139. <summary>
  140. 取得分块数据
  141. </summary>
  142. <typeparam name="T">数据源类型</typeparam>
  143. <param name="reader">Socket实例</param>
  144. <param name="data">已读取未处理的字节数据</param>
  145. <param name="startIndex">起始位置</param>
  146. <param name="readLength">读取的长度</param>
  147. <param name="body">保存块数据的流</param>
  148. </member>
  149. <member name="M:CommonNetwork.Http.HttpWebSocket.GetChunkHead``1(``0,System.Byte[]@,System.Int32@,System.Int32@)">
  150. <summary>
  151. 取得分块数据的数据长度
  152. </summary>
  153. <typeparam name="T">数据源类型</typeparam>
  154. <param name="reader">Socket实例</param>
  155. <param name="data">已读取未处理的字节数据</param>
  156. <param name="startIndex">起始位置</param>
  157. <param name="readLength">读取的长度</param>
  158. <returns>块长度,返回0表示已到末尾.</returns>
  159. </member>
  160. <member name="M:CommonNetwork.Http.HttpWebSocket.GetChunkBody``1(``0,System.Byte[]@,System.Int32@,System.Int32@,System.IO.MemoryStream@,System.Int32)">
  161. <summary>
  162. 取得分块传回的数据内容
  163. </summary>
  164. <typeparam name="T">数据源类型</typeparam>
  165. <param name="reader">Socket实例</param>
  166. <param name="data">已读取未处理的字节数据</param>
  167. <param name="startIndex">起始位置</param>
  168. <param name="readLength">读取的长度</param>
  169. <param name="body">保存块数据的流</param>
  170. <param name="chunkSize">块长度</param>
  171. </member>
  172. <member name="M:CommonNetwork.Http.HttpWebSocket.ReadData``1(``0,System.Byte[]@)">
  173. <summary>
  174. 从数据源读取数据
  175. </summary>
  176. <typeparam name="T">数据源类型</typeparam>
  177. <param name="reader">数据源</param>
  178. <param name="data">用于存储读取的数据</param>
  179. <returns>读取的数据长度,无数据为-1</returns>
  180. </member>
  181. <member name="P:CommonNetwork.Http.HttpHeader.ResponseStatusCode">
  182. <summary>
  183. 获取请求回应状态码
  184. </summary>
  185. </member>
  186. <member name="P:CommonNetwork.Http.HttpHeader.Location">
  187. <summary>
  188. 获取跳转url
  189. </summary>
  190. </member>
  191. <member name="P:CommonNetwork.Http.HttpHeader.IsGzip">
  192. <summary>
  193. 获取是否由Gzip压缩
  194. </summary>
  195. </member>
  196. <member name="P:CommonNetwork.Http.HttpHeader.ContentType">
  197. <summary>
  198. 获取返回的文档类型
  199. </summary>
  200. </member>
  201. <member name="P:CommonNetwork.Http.HttpHeader.Charset">
  202. <summary>
  203. 获取内容使用的字符集
  204. </summary>
  205. </member>
  206. <member name="P:CommonNetwork.Http.HttpHeader.ContentLength">
  207. <summary>
  208. 获取内容长度
  209. </summary>
  210. </member>
  211. <member name="P:CommonNetwork.Http.HttpHeader.IsChunk">
  212. <summary>
  213. 获取是否分块传输
  214. </summary>
  215. </member>
  216. <member name="M:CommonNetwork.Http.WebClient.GetChunkData(System.IO.Stream,System.Byte[]@,System.Int32@,System.Int32@,System.IO.MemoryStream@)">
  217. <summary>
  218. 取得分块数据
  219. </summary>
  220. <typeparam name="T">数据源类型</typeparam>
  221. <param name="reader">Socket实例</param>
  222. <param name="data">已读取未处理的字节数据</param>
  223. <param name="startIndex">起始位置</param>
  224. <param name="readLength">读取的长度</param>
  225. <param name="body">保存块数据的流</param>
  226. </member>
  227. <member name="M:CommonNetwork.Http.WebClient.GetChunkHead(System.IO.Stream,System.Byte[]@,System.Int32@,System.Int32@)">
  228. <summary>
  229. 取得分块数据的数据长度
  230. </summary>
  231. <typeparam name="T">数据源类型</typeparam>
  232. <param name="reader">Socket实例</param>
  233. <param name="data">已读取未处理的字节数据</param>
  234. <param name="startIndex">起始位置</param>
  235. <param name="readLength">读取的长度</param>
  236. <returns>块长度,返回0表示已到末尾.</returns>
  237. </member>
  238. <member name="M:CommonNetwork.Http.WebClient.GetChunkBody(System.IO.Stream,System.Byte[]@,System.Int32@,System.Int32@,System.IO.MemoryStream@,System.Int32)">
  239. <summary>
  240. 取得分块传回的数据内容
  241. </summary>
  242. <typeparam name="T">数据源类型</typeparam>
  243. <param name="reader">Socket实例</param>
  244. <param name="data">已读取未处理的字节数据</param>
  245. <param name="startIndex">起始位置</param>
  246. <param name="readLength">读取的长度</param>
  247. <param name="body">保存块数据的流</param>
  248. <param name="chunkSize">块长度</param>
  249. </member>
  250. <member name="M:CommonNetwork.Http.WebClient.ReadData(System.IO.Stream,System.Byte[]@)">
  251. <summary>
  252. 从数据源读取数据
  253. </summary>
  254. <typeparam name="T">数据源类型</typeparam>
  255. <param name="reader">数据源</param>
  256. <param name="data">用于存储读取的数据</param>
  257. <returns>读取的数据长度,无数据为-1</returns>
  258. </member>
  259. <member name="M:CommonNetwork.Net.INetSession.Send(System.Object)">
  260. <summary>
  261. 发送一个消息,该方法将立即返回。
  262. </summary>
  263. <param name="data"></param>
  264. </member>
  265. <member name="P:CommonNetwork.Sockets.NetSession.IsConnected">
  266. <summary>
  267. 判断当前网络是否已经连接
  268. </summary>
  269. <returns></returns>
  270. </member>
  271. <member name="M:CommonNetwork.Sockets.NetSession.Send(System.Object)">
  272. <summary>
  273. 发送一个消息,该方法将立即返回。
  274. </summary>
  275. <param name="data"></param>
  276. </member>
  277. <member name="M:CommonNetwork.Utils.ReceiveBuffer.Put(System.Byte[],System.Int32,System.Int32)">
  278. <summary>
  279. 向缓冲区写入数据
  280. </summary>
  281. <param name="data"></param>
  282. <param name="offset"></param>
  283. <param name="count"></param>
  284. </member>
  285. <member name="M:CommonNetwork.Utils.ReceiveBuffer.Over">
  286. <summary>
  287. 将读取的数据制空
  288. </summary>
  289. </member>
  290. </members>
  291. </doc>