Sers.Core.xml 57 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Sers.Core</name>
  5. </assembly>
  6. <members>
  7. <member name="P:Sers.Core.CL.CommunicationManage.CommunicationManageClient.requestTimeoutMs">
  8. <summary>
  9. 请求超时时间(单位ms,默认60000)(Config.requestTimeoutMs)
  10. </summary>
  11. </member>
  12. <member name="P:Sers.Core.CL.CommunicationManage.CommunicationManageClient.conn_OnGetRequest">
  13. <summary>
  14. 会在内部线程中被调用
  15. </summary>
  16. </member>
  17. <member name="F:Sers.Core.CL.CommunicationManage.CommunicationManageClient.BeforeBuildOrganize">
  18. <summary>
  19. </summary>
  20. </member>
  21. <member name="P:Sers.Core.CL.CommunicationManage.CommunicationManageServer.CurConn">
  22. <summary>
  23. 当前连接
  24. </summary>
  25. </member>
  26. <member name="P:Sers.Core.CL.CommunicationManage.CommunicationManageServer.requestTimeoutMs">
  27. <summary>
  28. 请求超时时间(单位ms,默认60000)(Config.requestTimeoutMs)
  29. </summary>
  30. </member>
  31. <member name="P:Sers.Core.CL.CommunicationManage.CommunicationManageServer.conn_OnGetRequest">
  32. <summary>
  33. 会在内部线程中被调用
  34. (conn,sender,requestData, callback)
  35. </summary>
  36. </member>
  37. <member name="P:Sers.Core.CL.CommunicationManage.CommunicationManageServer.BeforeBuildOrganize">
  38. <summary>
  39. configs,organizeList
  40. </summary>
  41. </member>
  42. <member name="T:Sers.Core.CL.MessageDelivery.DeliveryConnState">
  43. <summary>
  44. (0:waitForCertify; 2:certified; 4:waitForClose; 8:closed;)
  45. </summary>
  46. </member>
  47. <member name="P:Sers.Core.CL.MessageDelivery.IDeliveryClient.Conn_OnGetFrame">
  48. <summary>
  49. 请勿处理耗时操作,需立即返回。收到数据事件
  50. </summary>
  51. </member>
  52. <member name="P:Sers.Core.CL.MessageDelivery.IDeliveryConnection.state">
  53. <summary>
  54. 连接状态(0:waitForCertify; 2:certified; 4:waitForClose; 8:closed;)
  55. </summary>
  56. </member>
  57. <member name="P:Sers.Core.CL.MessageDelivery.IDeliveryServer.Conn_OnConnected">
  58. <summary>
  59. 请勿处理耗时操作,需立即返回
  60. </summary>
  61. </member>
  62. <member name="P:Sers.Core.CL.MessageDelivery.IDeliveryServer.Conn_OnDisconnected">
  63. <summary>
  64. 请勿处理耗时操作,需立即返回
  65. </summary>
  66. </member>
  67. <member name="F:Sers.Core.CL.MessageOrganize.DefaultOrganize.EFrameType.request">
  68. <summary>
  69. request
  70. </summary>
  71. </member>
  72. <member name="F:Sers.Core.CL.MessageOrganize.DefaultOrganize.EFrameType.reply">
  73. <summary>
  74. reply
  75. </summary>
  76. </member>
  77. <member name="F:Sers.Core.CL.MessageOrganize.DefaultOrganize.EFrameType.message">
  78. <summary>
  79. 单向数据
  80. </summary>
  81. </member>
  82. <member name="F:Sers.Core.CL.MessageOrganize.DefaultOrganize.OrganizeClient.secretKey">
  83. <summary>
  84. 连接秘钥,用以验证连接安全性。服务端和客户端必须一致
  85. </summary>
  86. </member>
  87. <member name="P:Sers.Core.CL.MessageOrganize.DefaultOrganize.OrganizeClient.conn_OnGetRequest">
  88. <summary>
  89. 会在内部线程中被调用
  90. (conn,sender,requestData,callback)
  91. </summary>
  92. </member>
  93. <member name="F:Sers.Core.CL.MessageOrganize.DefaultOrganize.OrganizeServer.secretKey">
  94. <summary>
  95. 连接秘钥,用以验证连接安全性。服务端和客户端必须一致
  96. </summary>
  97. </member>
  98. <member name="F:Sers.Core.CL.MessageOrganize.DefaultOrganize.OrganizeServer.connMap">
  99. <summary>
  100. 已经认证过的连接
  101. </summary>
  102. </member>
  103. <member name="P:Sers.Core.CL.MessageOrganize.DefaultOrganize.OrganizeServer.conn_OnGetRequest">
  104. <summary>
  105. 会在内部线程中被调用
  106. </summary>
  107. </member>
  108. <member name="T:Sers.Core.CL.MessageOrganize.DefaultOrganize.RequestAdaptor">
  109. <summary>
  110. 协调 MessageDelivery 和 MessageOrganize,只负责处理数据,不负责管理打开或关闭事件
  111. </summary>
  112. </member>
  113. <member name="P:Sers.Core.CL.MessageOrganize.DefaultOrganize.RequestAdaptor.event_OnGetRequest">
  114. <summary>
  115. deliveryToOrganize_OnGetRequest
  116. 会在内部线程中被调用
  117. (conn,sender,requestData,callback)
  118. </summary>
  119. </member>
  120. <member name="P:Sers.Core.CL.MessageOrganize.DefaultOrganize.RequestAdaptor.event_OnGetMessage">
  121. <summary>
  122. deliveryToOrganize_OnGetMessage
  123. 会在内部线程中被调用
  124. </summary>
  125. </member>
  126. <member name="F:Sers.Core.CL.MessageOrganize.DefaultOrganize.RequestAdaptor.workThreadCount">
  127. <summary>
  128. 后台处理消息的线程个数(单位个,默认2)
  129. </summary>
  130. </member>
  131. <member name="F:Sers.Core.CL.MessageOrganize.DefaultOrganize.RequestAdaptor.requestTimeoutMs">
  132. <summary>
  133. 请求超时时间(单位ms,默认60000)
  134. </summary>
  135. </member>
  136. <member name="F:Sers.Core.CL.MessageOrganize.DefaultOrganize.RequestAdaptor.heartBeatTimeoutMs">
  137. <summary>
  138. 心跳检测超时时间(单位ms,默认30000)
  139. </summary>
  140. </member>
  141. <member name="F:Sers.Core.CL.MessageOrganize.DefaultOrganize.RequestAdaptor.heartBeatRetryCount">
  142. <summary>
  143. 心跳检测失败重试次数(单位次,默认10)
  144. </summary>
  145. </member>
  146. <member name="F:Sers.Core.CL.MessageOrganize.DefaultOrganize.RequestAdaptor.heartBeatIntervalMs">
  147. <summary>
  148. 心跳检测时间间隔(单位ms,默认10000,若指定为0则不进行心跳检测)
  149. </summary>
  150. </member>
  151. <member name="M:Sers.Core.CL.MessageOrganize.DefaultOrganize.RequestAdaptor.DeliveryToOrganize_MessageFrame.Push">
  152. <summary>
  153. 使用结束请手动调用
  154. </summary>
  155. </member>
  156. <member name="M:Sers.Core.CL.MessageOrganize.DefaultOrganize.RequestAdaptor.DeliveryToOrganize_RequestInfo.Push">
  157. <summary>
  158. 使用结束请手动调用
  159. </summary>
  160. </member>
  161. <member name="M:Sers.Core.CL.MessageOrganize.DefaultOrganize.RequestAdaptor.OrganizeToDelivery_RequestInfo.Push">
  162. <summary>
  163. 使用结束请手动调用
  164. </summary>
  165. </member>
  166. <member name="P:Sers.Core.CL.MessageOrganize.DefaultOrganize.RequestAdaptor.HeartBeatPackage.timeouted">
  167. <summary>
  168. 是否超时 true:已经超时 false:未超时 null:未知
  169. </summary>
  170. </member>
  171. <member name="M:Sers.Core.CL.MessageOrganize.DefaultOrganize.RequestAdaptor.PackageReqRepFrame(System.Int64,System.Collections.Generic.List{System.ArraySegment{System.Byte}},System.Collections.Generic.List{System.ArraySegment{System.Byte}}@)">
  172. <summary>
  173. 注:调用后,不改变oriMsg
  174. </summary>
  175. <param name="reqKey"></param>
  176. <param name="oriMsg"></param>
  177. <param name="reqRepFrame"></param>
  178. </member>
  179. <member name="P:Sers.Core.CL.MessageOrganize.IOrganizeClient.conn_OnGetRequest">
  180. <summary>
  181. 会在内部线程中被调用
  182. (conn,sender,requestData,callback)
  183. </summary>
  184. </member>
  185. <member name="P:Sers.Core.CL.MessageOrganize.IOrganizeServer.conn_OnGetRequest">
  186. <summary>
  187. 会在内部线程中被调用
  188. (conn,sender,requestData, callback)
  189. </summary>
  190. </member>
  191. <member name="M:Sers.Core.Module.ApiLoader.ApiLoaderMng.LoadApi">
  192. <summary>
  193. 从配置文件(appsettings.json Sers.LocalApiService.ApiLoaders ) 加载api加载器并加载api
  194. </summary>
  195. <returns></returns>
  196. </member>
  197. <member name="M:Sers.Core.Module.Api.ApiClient.SetOnSendRequest(System.Func{System.Collections.Generic.List{System.ArraySegment{System.Byte}},System.ArraySegment{System.Byte}}[])">
  198. <summary>
  199. callbacks长度必须大于1
  200. </summary>
  201. <param name="callbacks"></param>
  202. </member>
  203. <member name="M:Sers.Core.Module.Api.ApiClient.CallApi(System.Collections.Generic.List{System.ArraySegment{System.Byte}})">
  204. <summary>
  205. </summary>
  206. <param name="reqOri"></param>
  207. <returns></returns>
  208. </member>
  209. <member name="M:Sers.Core.Module.Api.ApiClient.CallApi(Sers.Core.Module.Message.ApiMessage)">
  210. <summary>
  211. </summary>
  212. <param name="request"></param>
  213. <returns></returns>
  214. </member>
  215. <member name="M:Sers.Core.Module.Api.ApiClient.CallApiAsync(Sers.Core.Module.Message.ApiMessage)">
  216. <summary>
  217. </summary>
  218. <param name="request"></param>
  219. <returns></returns>
  220. </member>
  221. <member name="M:Sers.Core.Module.Api.ApiClient.CallApi``1(System.String,System.Object,System.String,System.Action{Sers.Core.Module.Rpc.IRpcContextData})">
  222. <summary>
  223. </summary>
  224. <typeparam name="ReturnType"></typeparam>
  225. <param name="route"></param>
  226. <param name="arg"></param>
  227. <param name="httpMethod">可为 GET、POST、DELETE、PUT等,可不指定</param>
  228. <param name="InitRpc">对Rpc的额外处理,如添加header</param>
  229. <returns></returns>
  230. </member>
  231. <member name="M:Sers.Core.Module.Api.ApiClient.CallApi(System.String,System.Object,System.String,System.Action{Sers.Core.Module.Rpc.IRpcContextData})">
  232. <summary>
  233. </summary>
  234. <param name="route"></param>
  235. <param name="arg"></param>
  236. <param name="httpMethod">可为 GET、POST、DELETE、PUT等,可不指定</param>
  237. <param name="InitRpc">对Rpc的额外处理,如添加header</param>
  238. <returns></returns>
  239. </member>
  240. <member name="M:Sers.Core.Module.Api.ApiClient.CallApiAsync``1(System.String,System.Object,System.String,System.Action{Sers.Core.Module.Rpc.IRpcContextData})">
  241. <summary>
  242. </summary>
  243. <typeparam name="ReturnType"></typeparam>
  244. <param name="route"></param>
  245. <param name="arg"></param>
  246. <param name="httpMethod">可为 GET、POST、DELETE、PUT等,可不指定</param>
  247. <param name="InitRpc">对Rpc的额外处理,如添加header</param>
  248. <returns></returns>
  249. </member>
  250. <member name="M:Sers.Core.Module.Api.ApiClient.CallRemoteApi(Sers.Core.Module.Message.ApiMessage)">
  251. <summary>
  252. </summary>
  253. <param name="request"></param>
  254. <returns></returns>
  255. </member>
  256. <member name="M:Sers.Core.Module.Api.ApiClient.CallRemoteApi(System.String,System.String,System.String,System.Action{Sers.Core.Module.Rpc.IRpcContextData})">
  257. <summary>
  258. </summary>
  259. <param name="route"></param>
  260. <param name="arg"></param>
  261. <param name="httpMethod">可为 GET、POST、DELETE、PUT等,可不指定</param>
  262. <param name="InitRpc">对Rpc的额外处理,如添加header</param>
  263. </member>
  264. <member name="M:Sers.Core.Module.Api.ApiClient.CallRemoteApi(System.String,System.Object,System.String,System.Action{Sers.Core.Module.Rpc.IRpcContextData})">
  265. <summary>
  266. </summary>
  267. <param name="route"></param>
  268. <param name="arg"></param>
  269. <param name="httpMethod">可为 GET、POST、DELETE、PUT等,可不指定</param>
  270. <param name="InitRpc">对Rpc的额外处理,如添加header</param>
  271. </member>
  272. <member name="M:Sers.Core.Module.Api.ApiClient.CallRemoteApi``1(System.String,System.Object,System.String,System.Action{Sers.Core.Module.Rpc.IRpcContextData})">
  273. <summary>
  274. </summary>
  275. <typeparam name="ReturnType"></typeparam>
  276. <param name="route"></param>
  277. <param name="arg"></param>
  278. <param name="httpMethod">可为 GET、POST、DELETE、PUT等,可不指定</param>
  279. <param name="InitRpc">对Rpc的额外处理,如添加header</param>
  280. <returns></returns>
  281. </member>
  282. <member name="M:Sers.Core.Module.Api.ApiClient.CallRemoteApiAsync(Sers.Core.Module.Message.ApiMessage)">
  283. <summary>
  284. </summary>
  285. <param name="request"></param>
  286. <returns></returns>
  287. </member>
  288. <member name="M:Sers.Core.Module.Api.ApiClient.CallRemoteApiAsync``1(System.String,System.Object,System.String,System.Action{Sers.Core.Module.Rpc.IRpcContextData})">
  289. <summary>
  290. </summary>
  291. <typeparam name="ReturnType"></typeparam>
  292. <param name="route"></param>
  293. <param name="arg"></param>
  294. <param name="httpMethod">可为 GET、POST、DELETE、PUT等,可不指定</param>
  295. <param name="InitRpc">对Rpc的额外处理,如添加header</param>
  296. <returns></returns>
  297. </member>
  298. <member name="T:Sers.Core.Module.Api.ApiDesc.SsApiDesc">
  299. <summary>
  300. Api描述
  301. </summary>
  302. </member>
  303. <member name="P:Sers.Core.Module.Api.ApiDesc.SsApiDesc.name">
  304. <summary>
  305. api名称(不为route)
  306. </summary>
  307. </member>
  308. <member name="P:Sers.Core.Module.Api.ApiDesc.SsApiDesc.description">
  309. <summary>
  310. 文字描述
  311. </summary>
  312. </member>
  313. <member name="P:Sers.Core.Module.Api.ApiDesc.SsApiDesc.route">
  314. <summary>
  315. 路由 例如 "/ApiStation1/path1/path2/api1"
  316. </summary>
  317. </member>
  318. <member name="P:Sers.Core.Module.Api.ApiDesc.SsApiDesc.extendConfig">
  319. <summary>
  320. 扩展配置(json)
  321. </summary>
  322. </member>
  323. <member name="P:Sers.Core.Module.Api.ApiDesc.SsApiDesc.argType">
  324. <summary>
  325. 请求参数类型(SsModel类型)
  326. </summary>
  327. </member>
  328. <member name="P:Sers.Core.Module.Api.ApiDesc.SsApiDesc.returnType">
  329. <summary>
  330. 返回数据类型(SsModel类型)
  331. </summary>
  332. </member>
  333. <member name="P:Sers.Core.Module.Api.ApiDesc.SsApiDesc.rpcValidations">
  334. <summary>
  335. api调用限制(rpc),sers1版本使用(为了兼容,暂不禁用)
  336. </summary>
  337. </member>
  338. <member name="P:Sers.Core.Module.Api.ApiDesc.SsApiDesc.rpcVerify2">
  339. <summary>
  340. api调用限制(rpc),sers2版本使用
  341. </summary>
  342. </member>
  343. <member name="P:Sers.Core.Module.Api.ApiDesc.SsApiDesc.ext">
  344. <summary>
  345. 额外数据
  346. </summary>
  347. </member>
  348. <member name="F:Sers.Core.Module.Api.ApiDesc.SsModel.type">
  349. <summary>
  350. 数据类型。 可为 object、string、int32、int64、float、double、bool、datetime 或 SsModelEntity的name
  351. </summary>
  352. </member>
  353. <member name="F:Sers.Core.Module.Api.ApiDesc.SsModel.mode">
  354. <summary>
  355. 数据模式。只可为 value、object、array
  356. </summary>
  357. </member>
  358. <member name="F:Sers.Core.Module.Api.ApiDesc.SsModel.description">
  359. <summary>
  360. 描述
  361. </summary>
  362. </member>
  363. <member name="F:Sers.Core.Module.Api.ApiDesc.SsModel.defaultValue">
  364. <summary>
  365. 默认值
  366. </summary>
  367. </member>
  368. <member name="F:Sers.Core.Module.Api.ApiDesc.SsModel.example">
  369. <summary>
  370. 示例值
  371. </summary>
  372. </member>
  373. <member name="F:Sers.Core.Module.Api.ApiDesc.SsModelEntity.type">
  374. <summary>
  375. 数据类型。可以唯一定位到一个模型
  376. </summary>
  377. </member>
  378. <member name="F:Sers.Core.Module.Api.ApiDesc.SsModelEntity.mode">
  379. <summary>
  380. 数据模式。只可为 value、object、array
  381. </summary>
  382. </member>
  383. <member name="F:Sers.Core.Module.Api.ApiDesc.SsModelEntity.propertys">
  384. <summary>
  385. 成员属性
  386. </summary>
  387. </member>
  388. <member name="F:Sers.Core.Module.Api.ApiDesc.SsModelProperty.name">
  389. <summary>
  390. 名称
  391. </summary>
  392. </member>
  393. <member name="F:Sers.Core.Module.Api.ApiDesc.SsModelProperty.type">
  394. <summary>
  395. 数据类型。 可为 object、string、int32、int64、float、double、bool、datetime 或 SsModelEntity的name
  396. </summary>
  397. </member>
  398. <member name="F:Sers.Core.Module.Api.ApiDesc.SsModelProperty.mode">
  399. <summary>
  400. 数据模式。只可为 value、object、array
  401. </summary>
  402. </member>
  403. <member name="F:Sers.Core.Module.Api.ApiDesc.SsModelProperty.description">
  404. <summary>
  405. 描述
  406. </summary>
  407. </member>
  408. <member name="F:Sers.Core.Module.Api.ApiDesc.SsModelProperty.defaultValue">
  409. <summary>
  410. 默认值
  411. </summary>
  412. </member>
  413. <member name="F:Sers.Core.Module.Api.ApiDesc.SsModelProperty.example">
  414. <summary>
  415. 示例值
  416. </summary>
  417. </member>
  418. <member name="T:Sers.Core.Module.Api.ApiEvent.ApiScope.IApiScopeEvent">
  419. <summary>
  420. 调用Api时的自定义Scope对象
  421. </summary>
  422. </member>
  423. <member name="M:Sers.Core.Module.Api.ApiEvent.ApiScope.IApiScopeEvent.OnCreateScope">
  424. <summary>
  425. 返回对象在apiScope结束时被调用,可为空
  426. </summary>
  427. <returns></returns>
  428. </member>
  429. <member name="T:Sers.Core.Module.Api.ApiEvent.BeforeCallApi.AccountInCookie.AccountInCookie">
  430. <summary>
  431. 在调用接口前,会获取 rpcData.http.headers.Cookie(格式为 "user=xxx;c=7")中的user,在账号列表中比对userToken,回写 CallerSource(rpcData.caller.source) 和 userInfo(rpcData.user.userInfo)
  432. </summary>
  433. </member>
  434. <member name="M:Sers.Core.Module.Api.ApiEvent.BeforeCallApi.AccountInCookie.AccountInCookie.Init(Newtonsoft.Json.Linq.JObject)">
  435. <summary>
  436. Sers.AccountInCookie.account: [ {"userToken":"admin_123","CallerSource":"Internal","userInfo":{} } ]
  437. </summary>
  438. <param name="config"></param>
  439. </member>
  440. <member name="M:Sers.Core.Module.Api.ApiEvent.BeforeCallApi.AccountInCookie.AccountInCookie.BeforeCallApi(Sers.Core.Module.Rpc.IRpcContextData,Sers.Core.Module.Message.ApiMessage)">
  441. <summary>
  442. 转换Cookie为对应的用户
  443. </summary>
  444. <param name="rpcData"></param>
  445. <param name="requestMessage"></param>
  446. </member>
  447. <member name="T:Sers.Core.Module.Api.ApiEvent.BeforeCallApi.Bearer.Bearer">
  448. <summary>
  449. 在调用接口前,会获取 rpcData.http.headers.Authorization(格式为 "Bearer xxxxxx"),并作为参数调用接口api_verifyAt,把返回数据放到 rpcData.user.userInfo
  450. </summary>
  451. </member>
  452. <member name="M:Sers.Core.Module.Api.ApiEvent.BeforeCallApi.Bearer.Bearer.BeforeCallApi(Sers.Core.Module.Rpc.IRpcContextData,Sers.Core.Module.Message.ApiMessage)">
  453. <summary>
  454. Bearer。 转换at为对应的用户
  455. </summary>
  456. <param name="rpcData"></param>
  457. <param name="requestMessage"></param>
  458. </member>
  459. <member name="T:Sers.Core.Module.Api.ApiEvent.BeforeCallApi.IBeforeCallApi">
  460. <summary>
  461. 调用api前的事件
  462. </summary>
  463. </member>
  464. <member name="M:Sers.Core.Module.Api.ApiEvent.EventBuilder.LoadEvent_BeforeCallApi(Newtonsoft.Json.Linq.JArray)">
  465. <summary>
  466. 从传入的配置项加载BeforeCallApi事件
  467. </summary>
  468. <param name="events"></param>
  469. <returns></returns>
  470. </member>
  471. <member name="M:Sers.Core.Module.Api.ApiEvent.EventBuilder.LoadEvent_OnCreateScope(Newtonsoft.Json.Linq.JArray)">
  472. <summary>
  473. 从传入的配置项加载OnCreateScope事件
  474. </summary>
  475. <param name="events"></param>
  476. <returns></returns>
  477. </member>
  478. <member name="F:Sers.Core.Module.Api.LocalApi.ApiNodeMng.apiNodeMapWithMethod">
  479. <summary>
  480. 映射 /{httpMethod}{route} -> LocalApiNode
  481. 例如 "/POST/api/value"
  482. </summary>
  483. </member>
  484. <member name="F:Sers.Core.Module.Api.LocalApi.ApiNodeMng.apiNodeMapWithoutMethod">
  485. <summary>
  486. 映射 {route} -> LocalApiNode
  487. 例如 "/api/value"
  488. </summary>
  489. </member>
  490. <member name="T:Sers.Core.Module.Api.LocalApi.Event.LocalApiEventMng">
  491. <summary>
  492. 事件顺序为 OnCreateScope -> BeforeCallApi -> OnDispose
  493. </summary>
  494. </member>
  495. <member name="F:Sers.Core.Module.Api.LocalApi.Event.LocalApiEventMng.BeforeCallApi">
  496. <summary>
  497. BeforeCallApi(IRpcContextData rpcData, ApiMessage requestMessage)
  498. </summary>
  499. </member>
  500. <member name="P:Sers.Core.Module.Api.LocalApi.LocalApiService.workThreadCount">
  501. <summary>
  502. 后台服务的线程个数(单位个,默认0,代表不开启服务)(appsettings.json :: Sers.LocalApiService.workThreadCount)
  503. </summary>
  504. </member>
  505. <member name="F:Sers.Core.Module.Api.LocalApi.LocalApiService.apiNodeMng">
  506. <summary>
  507. 映射 route -> LocalApiNode
  508. </summary>
  509. </member>
  510. <member name="M:Sers.Core.Module.Api.LocalApi.LocalApiService.LoadApi">
  511. <summary>
  512. 从配置文件(appsettings.json Sers.LocalApiService.ApiLoaders ) 加载api加载器并加载api
  513. </summary>
  514. </member>
  515. <member name="M:Sers.Core.Module.Api.LocalApi.LocalApiService.LoadSersApi(Sers.SersLoader.ApiLoaderConfig)">
  516. <summary>
  517. 调用SersApi加载器加载api
  518. </summary>
  519. <param name="config"></param>
  520. </member>
  521. <member name="M:Sers.Core.Module.Api.LocalApi.LocalApiService.LoadSersApi(System.Reflection.Assembly)">
  522. <summary>
  523. 调用SersApi加载器加载api
  524. </summary>
  525. <param name="assembly"></param>
  526. </member>
  527. <member name="M:Sers.Core.Module.Api.LocalApi.LocalApiService.CallLocalApi(Sers.Core.Module.Message.ApiMessage)">
  528. <summary>
  529. 构建RpcContext并调用
  530. </summary>
  531. <param name="apiRequest"></param>
  532. <returns></returns>
  533. </member>
  534. <member name="F:Sers.Core.Module.Api.LocalApi.LocalApiService.worker">
  535. <summary>
  536. 后台调用Api的线程
  537. </summary>
  538. </member>
  539. <member name="P:Sers.Core.Module.Api.LocalApi.LocalApiService.Worker_TimeLimit.timeout_ms">
  540. <summary>
  541. 超时时间,(主动关闭超过此时间的任务,实际任务强制关闭的时间会在1倍超时时间到2倍超时时间内)。单位:ms。
  542. 脉冲间隔。
  543. </summary>
  544. </member>
  545. <member name="P:Sers.Core.Module.Api.LocalApi.StaticFileTransmit.Extensions.StaticFilesApiNodeConfig.route">
  546. <summary>
  547. api路由前缀,例如 "/demo/ui/*"
  548. </summary>
  549. </member>
  550. <member name="P:Sers.Core.Module.Api.LocalApi.StaticFileTransmit.Extensions.StaticFilesApiNodeConfig.apiName">
  551. <summary>
  552. api描述,静态文件描述
  553. </summary>
  554. </member>
  555. <member name="T:Sers.Core.Module.Api.LocalApi.StaticFileTransmit.FileExtensionContentTypeProvider">
  556. <summary>
  557. Provides a mapping between file extensions and MIME types.
  558. </summary>
  559. </member>
  560. <member name="P:Sers.Core.Module.Api.LocalApi.StaticFileTransmit.FileExtensionContentTypeProvider.Mappings">
  561. <summary>
  562. The cross reference table of file extensions and content-types.
  563. </summary>
  564. </member>
  565. <member name="M:Sers.Core.Module.Api.LocalApi.StaticFileTransmit.FileExtensionContentTypeProvider.#ctor">
  566. <summary>
  567. Creates a new provider with a set of default mappings.
  568. </summary>
  569. </member>
  570. <member name="M:Sers.Core.Module.Api.LocalApi.StaticFileTransmit.FileExtensionContentTypeProvider.#ctor(System.Collections.Generic.IDictionary{System.String,System.String})">
  571. <summary>
  572. Creates a lookup engine using the provided mapping.
  573. It is recommended that the IDictionary instance use StringComparer.OrdinalIgnoreCase.
  574. </summary>
  575. <param name="mapping"></param>
  576. </member>
  577. <member name="M:Sers.Core.Module.Api.LocalApi.StaticFileTransmit.FileExtensionContentTypeProvider.TryGetContentType(System.String,System.String@)">
  578. <summary>
  579. Given a file path, determine the MIME type
  580. </summary>
  581. <param name="subpath">A file path</param>
  582. <param name="contentType">The resulting MIME type</param>
  583. <returns>True if MIME type could be determined</returns>
  584. </member>
  585. <member name="P:Sers.Core.Module.Api.LocalApi.StaticFileTransmit.StaticFileMap.fileBasePath">
  586. <summary>
  587. D://fold1/wwwroot
  588. 静态文件绝对路径
  589. </summary>
  590. </member>
  591. <member name="M:Sers.Core.Module.Api.LocalApi.StaticFileTransmit.StaticFileMap.LoadContentTypeFromFile(System.String)">
  592. <summary>
  593. </summary>
  594. <param name="filePath"></param>
  595. <returns></returns>
  596. </member>
  597. <member name="M:Sers.Core.Module.Api.LocalApi.StaticFileTransmit.StaticFileMap.#ctor(System.String)">
  598. <summary>
  599. fileBasePath:静态文件路径。可为相对路径或绝对路径。若不指定(null或空字符串)则默认为入口程序所在目录下的wwwroot文件夹。
  600. demo D://fold1/wwwroot
  601. </summary>
  602. <param name="fileBasePath"></param>
  603. </member>
  604. <member name="M:Sers.Core.Module.Api.LocalApi.StaticFileTransmit.StaticFileMap.GetRelativePath">
  605. <summary>
  606. 获取当前url对应的相对文件路径(若不合法,则返回null)。demo:"rpc/2.html"
  607. <para>(若 route为"/Station1/fold1/a/*",url为"http://127.0.0.1/Station1/fold1/a/1/2.html?c=9",则 relativePath为"1/2.html")</para>
  608. </summary>
  609. <returns></returns>
  610. </member>
  611. <member name="M:Sers.Core.Module.Api.LocalApi.StaticFileTransmit.StaticFileMap.GetAbsFilePath">
  612. <summary>
  613. 获取当前url映射到文件系统中的绝对路径。demo:"/root/netapp/FileStorage/wwwroot/fold2/a.html"
  614. </summary>
  615. <returns></returns>
  616. </member>
  617. <member name="P:Sers.Core.Module.Api.LocalApi.StaticFileTransmit.StaticFilesConfig.rootPath">
  618. <summary>
  619. 静态文件路径。可为相对路径或绝对路径。若为空或空字符串则默认为入口程序所在目录。demo:"wwwroot/demo"
  620. </summary>
  621. </member>
  622. <member name="P:Sers.Core.Module.Api.LocalApi.StaticFileTransmit.StaticFilesConfig.responseHeaders">
  623. <summary>
  624. 回应静态文件时额外添加的http回应头。可不指定。
  625. </summary>
  626. </member>
  627. <member name="P:Sers.Core.Module.Api.LocalApi.StaticFileTransmit.StaticFilesConfig.contentTypeMapFile">
  628. <summary>
  629. 静态文件类型映射配置的文件路径。可为相对路径或绝对路径。例如"contentTypeMap.json"。若不指定(或指定的文件不存在)则不指定文件类型映射配置
  630. </summary>
  631. </member>
  632. <member name="F:Sers.Core.Module.Api.RouteMap.ERouteType.nomalRoute">
  633. <summary>
  634. 普通接口。例如: "/station1/fold2/api1"
  635. </summary>
  636. </member>
  637. <member name="F:Sers.Core.Module.Api.RouteMap.ERouteType.genericRoute">
  638. <summary>
  639. 泛接口。例如: "/station1/fold2/*"
  640. </summary>
  641. </member>
  642. <member name="M:Sers.Core.Module.Api.RouteMap.GenericRouteMap`1.Remove(System.String)">
  643. <summary>
  644. path demo: "/station1/fold2/*"
  645. </summary>
  646. <param name="route"></param>
  647. <returns></returns>
  648. </member>
  649. <member name="M:Sers.Core.Module.Api.RouteMap.GenericRouteMap`1.Set(System.String,`0)">
  650. <summary>
  651. path demo: "/station1/fold2/*"
  652. </summary>
  653. <param name="route"></param>
  654. <param name="apiService"></param>
  655. </member>
  656. <member name="M:Sers.Core.Module.Api.RouteMap.GenericRouteMap`1.Routing(System.String)">
  657. <summary>
  658. path demo: "/station1/fold2/action2.html"
  659. </summary>
  660. <param name="route"></param>
  661. <returns></returns>
  662. </member>
  663. <member name="M:Sers.Core.Module.Api.RouteMap.GenericRouteMap`1.Tree`1.BuildPath(System.String)">
  664. <summary>
  665. path demo: "/station1/fold2/api1"
  666. </summary>
  667. <param name="path"></param>
  668. <returns></returns>
  669. </member>
  670. <member name="M:Sers.Core.Module.Api.RouteMap.GenericRouteMap`1.Tree`1.QueryByPath(System.String)">
  671. <summary>
  672. path demo: "/station1/fold2/api1/action2"
  673. </summary>
  674. <param name="path"></param>
  675. <returns></returns>
  676. </member>
  677. <member name="M:Sers.Core.Module.Api.RouteMap.GenericRouteMap`1.Tree`1.GetChildren(System.String)">
  678. <summary>
  679. path demo: "/station1/fold2/api1/action2"
  680. </summary>
  681. <param name="path"></param>
  682. <returns></returns>
  683. </member>
  684. <member name="M:Sers.Core.Module.Api.RouteMap.GenericRouteMap`1.Tree`1.Remove(System.String)">
  685. <summary>
  686. path demo: "/station1/fold2/api1/action2"
  687. </summary>
  688. <param name="path"></param>
  689. <returns></returns>
  690. </member>
  691. <member name="M:Sers.Core.Module.Api.RouteMap.IDataMap`1.Get(System.String)">
  692. <summary>
  693. 根据路由字符串直接查找
  694. </summary>
  695. <param name="route"></param>
  696. <returns></returns>
  697. </member>
  698. <member name="M:Sers.Core.Module.Api.RouteMap.IDataMap`1.Routing(System.String)">
  699. <summary>
  700. 通过路由规则查找
  701. </summary>
  702. <param name="route"></param>
  703. <returns></returns>
  704. </member>
  705. <member name="F:Sers.Core.Module.Api.RouteMap.NomalRouteMap`1.apiRouteMap">
  706. <summary>
  707. 映射表 route -> ApiService
  708. </summary>
  709. </member>
  710. <member name="M:Sers.Core.Module.Api.RouteMap.RouteMap`1.RouteIsNormalApi(System.String)">
  711. <summary>
  712. 是否为普通接口(不为泛接口)
  713. </summary>
  714. <param name="route"></param>
  715. <returns></returns>
  716. </member>
  717. <member name="M:Sers.Core.Module.Api.RouteMap.RouteMap`1.Set(System.String,`0)">
  718. <summary>
  719. path demo: 1."/station1/fold2/api1" 2."/station1/fold2/*"
  720. </summary>
  721. <param name="route"></param>
  722. <param name="apiService"></param>
  723. </member>
  724. <member name="M:Sers.Core.Module.Api.RouteMap.RouteMap`1.Get(System.String)">
  725. <summary>
  726. route demo: 1."/station1/fold2/api1" 2."/station1/fold2/*"
  727. </summary>
  728. <param name="route"></param>
  729. <returns></returns>
  730. </member>
  731. <member name="M:Sers.Core.Module.Api.RouteMap.RouteMap`1.Routing(System.String,Sers.Core.Module.Api.RouteMap.ERouteType@)">
  732. <summary>
  733. route demo: 1."/station1/fold2/api1" 2."/station1/fold2/*" 3."/station1/fold2/index.html"
  734. </summary>
  735. <param name="route"></param>
  736. <param name="routeType"></param>
  737. <returns></returns>
  738. </member>
  739. <member name="M:Sers.Core.Module.Api.RouteMap.RouteMap`1.Routing(System.String)">
  740. <summary>
  741. route demo: 1."/station1/fold2/api1" 2."/station1/fold2/*" 3."/station1/fold2/index.html"
  742. </summary>
  743. <param name="route"></param>
  744. <returns></returns>
  745. </member>
  746. <member name="M:Sers.Core.Module.Api.RouteMap.RouteMap`1.Remove(System.String)">
  747. <summary>
  748. route demo: 1."/station1/fold2/api1" 2."/station1/fold2/*"
  749. </summary>
  750. <param name="route"></param>
  751. <returns></returns>
  752. </member>
  753. <member name="T:Sers.Core.Module.Api.Rpc.ECallerSource">
  754. <summary>
  755. 调用来源
  756. </summary>
  757. </member>
  758. <member name="F:Sers.Core.Module.Api.Rpc.ECallerSource.Internal">
  759. <summary>
  760. 内部调用
  761. </summary>
  762. </member>
  763. <member name="F:Sers.Core.Module.Api.Rpc.ECallerSource.OutSide">
  764. <summary>
  765. 外部调用(通过网关调用)
  766. </summary>
  767. </member>
  768. <member name="T:Sers.Core.Module.Api.Rpc.RpcContextData">
  769. <summary>
  770. </summary>
  771. </member>
  772. <member name="M:Sers.Core.Module.Api.Rpc.RpcContextData.UnpackOriData(System.ArraySegment{System.Byte})">
  773. <summary>
  774. </summary>
  775. <param name="oriData"></param>
  776. </member>
  777. <member name="M:Sers.Core.Module.Api.Rpc.RpcContextData.PackageOriData">
  778. <summary>
  779. </summary>
  780. <returns></returns>
  781. </member>
  782. <member name="P:Sers.Core.Module.Api.Rpc.RpcContextData.caller_source">
  783. <summary>
  784. 调用来源
  785. </summary>
  786. </member>
  787. <member name="M:Sers.Core.Module.App.AppEvent.AppEventLoader.LoadAppEvent(Newtonsoft.Json.Linq.JArray)">
  788. <summary>
  789. 从传入的配置项加载事件
  790. </summary>
  791. <param name="events"></param>
  792. <returns></returns>
  793. </member>
  794. <member name="M:Sers.Core.Module.App.SersApplication.RunAwait">
  795. <summary>
  796. 强制控制台不退出,除非执行Stop()
  797. </summary>
  798. </member>
  799. <member name="M:Sers.Core.Module.App.SersApplication.ResistConsoleCancelKey(System.Action)">
  800. <summary>
  801. 注册Ctrl+C 关闭事件
  802. </summary>
  803. </member>
  804. <member name="F:Sers.Core.Module.App.SersApplication.serviceStationInfo">
  805. <summary>
  806. 服务站点信息
  807. </summary>
  808. </member>
  809. <member name="F:Sers.Core.Module.App.SersApplication.deviceInfo">
  810. <summary>
  811. 服务站点硬件设备信息
  812. </summary>
  813. </member>
  814. <member name="M:Sers.Core.Module.Counter.Counter.ReportTo(Sers.Core.Module.Counter.Counter)">
  815. <summary>
  816. 计数时 向上级报告
  817. </summary>
  818. <param name="parentCounter"></param>
  819. </member>
  820. <member name="F:Sers.Core.Module.Counter.Counter.sumCount">
  821. <summary>
  822. 已经调用次数
  823. </summary>
  824. </member>
  825. <member name="F:Sers.Core.Module.Counter.Counter.errorCount">
  826. <summary>
  827. 失败调用次数
  828. </summary>
  829. </member>
  830. <member name="P:Sers.Core.Module.Env.SersEnvironment.deviceKey">
  831. <summary>
  832. 每台机器的deviceKey在任何时候都唯一
  833. </summary>
  834. </member>
  835. <member name="P:Sers.Core.Module.Env.SersEnvironment.serviceStationKey">
  836. <summary>
  837. 每个服务站点的serviceStationKey在任何时候都唯一
  838. </summary>
  839. </member>
  840. <member name="M:Sers.Core.Module.Env.SersEnvironment.GetEntryAssemblyVersion">
  841. <summary>
  842. </summary>
  843. <returns></returns>
  844. </member>
  845. <member name="F:Sers.Core.Module.Env.ServiceStationInfo.serviceStationKey">
  846. <summary>
  847. 站点key码,同一台机器上的同一个站点不变(根据机器码文件夹路径等计算得到)
  848. </summary>
  849. </member>
  850. <member name="F:Sers.Core.Module.Env.ServiceStationInfo.stationVersion">
  851. <summary>
  852. 站点版本信息
  853. </summary>
  854. </member>
  855. <member name="F:Sers.Core.Module.Env.ServiceStationInfo.serviceStationName">
  856. <summary>
  857. 站点Name
  858. </summary>
  859. </member>
  860. <member name="F:Sers.Core.Module.Env.ServiceStationInfo.info">
  861. <summary>
  862. 站点附加信息
  863. </summary>
  864. </member>
  865. <member name="M:Sers.Core.Module.Env.UsageReporter.StartReportTask(System.Double)">
  866. <summary>
  867. 开启自动上报Usage任务
  868. </summary>
  869. </member>
  870. <member name="M:Sers.Core.Module.Env.UsageReporter.StopReportTask">
  871. <summary>
  872. 关闭自动上报Usage任务
  873. </summary>
  874. </member>
  875. <member name="M:Sers.Core.Module.Env.UsageReporter.UseUsageReporter">
  876. <summary>
  877. 自动上报Usage任务
  878. </summary>
  879. </member>
  880. <member name="P:Sers.Core.Module.Message.ApiMessage.rpcContextData_OriData">
  881. <summary>
  882. RpcContextData Files[0]
  883. </summary>
  884. </member>
  885. <member name="P:Sers.Core.Module.Message.ApiMessage.value_OriData">
  886. <summary>
  887. value Files[1]
  888. 若为Request 则为 ArgValue
  889. 若为Reply 则为 ReturnValue
  890. </summary>
  891. </member>
  892. <member name="M:Sers.Core.Module.Message.SersFile.PackageArraySegmentByte(System.Collections.Generic.List{System.ArraySegment{System.Byte}})">
  893. <summary>
  894. 每个文件为 ArraySegmentByte 类型
  895. </summary>
  896. <param name="files"></param>
  897. <returns></returns>
  898. </member>
  899. <member name="F:Sers.Core.Module.PubSub.EFrameType.publish">
  900. <summary>
  901. publish,msgTitle,msgData
  902. </summary>
  903. </member>
  904. <member name="F:Sers.Core.Module.PubSub.EFrameType.subscribe">
  905. <summary>
  906. subscribe,msgTitle
  907. </summary>
  908. </member>
  909. <member name="F:Sers.Core.Module.PubSub.EFrameType.subscribeCancel">
  910. <summary>
  911. subscribeCancel,msgTitle
  912. </summary>
  913. </member>
  914. <member name="F:Sers.Core.Module.PubSub.EFrameType.message">
  915. <summary>
  916. message,msgTitle,msgData
  917. </summary>
  918. </member>
  919. <member name="F:Sers.Core.Module.PubSub.EndpointManage.subscriberMap">
  920. <summary>
  921. 消息订阅者 msgTitle -> {Subscriber hashcode:Subscriber}
  922. </summary>
  923. </member>
  924. <member name="M:Sers.Core.Module.PubSub.HotPlugSubscriber.Subscribe">
  925. <summary>
  926. 开启消息订阅
  927. </summary>
  928. </member>
  929. <member name="M:Sers.Core.Module.PubSub.HotPlugSubscriber.SubscribeCancel">
  930. <summary>
  931. 关闭消息订阅
  932. </summary>
  933. </member>
  934. <member name="F:Sers.Core.Module.PubSub.MessageCenterService.subscriberMap">
  935. <summary>
  936. 消息订阅者 msgTitle -> connList
  937. </summary>
  938. </member>
  939. <member name="F:Sers.Core.Module.Valid.Sers1.RpcVerify1.EValidType.Equal">
  940. <summary>
  941. { "type":"Equal","value":"Logined"}
  942. </summary>
  943. </member>
  944. <member name="F:Sers.Core.Module.Valid.Sers1.RpcVerify1.EValidType.Regex">
  945. <summary>
  946. { "type":"Regex","value":"^\\d{11}$"}
  947. </summary>
  948. </member>
  949. <member name="F:Sers.Core.Module.Valid.Sers1.RpcVerify1.EValidType.Required">
  950. <summary>
  951. { "type":"Required" }
  952. </summary>
  953. </member>
  954. <member name="F:Sers.Core.Module.Valid.Sers1.RpcVerify1.EValidType.Null">
  955. <summary>
  956. { "type":"Null"} always true
  957. </summary>
  958. </member>
  959. <member name="F:Sers.Core.Module.Valid.Sers1.RpcVerify1.EValidType.NotEqual">
  960. <summary>
  961. { "type":"NotEqual","value":"Logined"}
  962. </summary>
  963. </member>
  964. <member name="F:Sers.Core.Module.Valid.Sers1.RpcVerify1.EValidType.Scope">
  965. <summary>
  966. { "type":"Scope","min":10.8,"max":12.5} //包含最大值 最小值,可只指定最大值或最小值
  967. </summary>
  968. </member>
  969. <member name="F:Sers.Core.Module.Valid.Sers1.SsValidation.path">
  970. <summary>
  971. 数据的路径
  972. </summary>
  973. </member>
  974. <member name="F:Sers.Core.Module.Valid.Sers1.SsValidation.ssError">
  975. <summary>
  976. 验证不通过时提示的错误
  977. </summary>
  978. </member>
  979. <member name="F:Sers.Core.Module.Valid.Sers1.SsValidation.ssValid">
  980. <summary>
  981. 验证方式
  982. </summary>
  983. </member>
  984. <member name="P:Sers.SersLoader.ApiDesc.Attribute.RpcVerify.SsRpcVerifyAttribute.verifiedWhenNull">
  985. <summary>
  986. 当出现空值时,是否通过验证(默认不通过,false)
  987. </summary>
  988. </member>
  989. <member name="P:Sers.SersLoader.ApiDesc.Attribute.RpcVerify.SsRpcVerifyAttribute.condition">
  990. <summary>
  991. 例如:{"type":"!=","path":"caller.source" , "value":"Internal" }
  992. </summary>
  993. </member>
  994. <member name="P:Sers.SersLoader.ApiDesc.Attribute.RpcVerify.SsRpcVerifyAttribute.errorMessage">
  995. <summary>
  996. 校验不通过时的提示消息,若不指定则使用默认提示消息
  997. </summary>
  998. </member>
  999. <member name="P:Sers.SersLoader.ApiDesc.Attribute.RpcVerify.SsRpcVerifyAttribute.errorCode">
  1000. <summary>
  1001. 校验不通过时的errorCode, 如 1000。可不指定
  1002. </summary>
  1003. </member>
  1004. <member name="T:Sers.SersLoader.ApiDesc.Attribute.Valid.SsCallerSourceAttribute">
  1005. <summary>
  1006. 调用来源限制(内部调用 外部调用) demo:
  1007. [SsCallerSource(ECallerSource.Internal)]
  1008. [SsCallerSource(ECallerSource.OutSide, errorMessage = "只可外部调用")]
  1009. [SsCallerSource(callerSourceString = "Internal,OutSide")]
  1010. </summary>
  1011. </member>
  1012. <member name="P:Sers.SersLoader.ApiDesc.Attribute.Valid.SsCallerSourceAttribute.callerSourceString">
  1013. <summary>
  1014. 用逗号隔开的多个。例如 "Internal,OutSide"
  1015. </summary>
  1016. </member>
  1017. <member name="P:Sers.SersLoader.ApiDesc.Attribute.Valid.SsCallerSourceAttribute.callerSource">
  1018. <summary>
  1019. 可多个。例如: ECallerSource.Internal| ECallerSource.OutSide
  1020. </summary>
  1021. </member>
  1022. <member name="T:Sers.SersLoader.ApiDesc.Attribute.Valid.SsCmpAttribute">
  1023. <summary>
  1024. demo:
  1025. [SsCmp(path = "http.method", type = "==" , value="PUT")]
  1026. </summary>
  1027. </member>
  1028. <member name="P:Sers.SersLoader.ApiDesc.Attribute.Valid.SsCmpAttribute.type">
  1029. <summary>
  1030. 可为 == != &gt; &gt;= &lt; &lt;= 等
  1031. </summary>
  1032. </member>
  1033. <member name="T:Sers.SersLoader.ApiDesc.Attribute.Valid.SsEqualAttribute">
  1034. <summary>
  1035. demo:
  1036. [SsEqual(path = "http.method", value = "PUT")]
  1037. </summary>
  1038. </member>
  1039. <member name="T:Sers.SersLoader.ApiDesc.Attribute.Valid.SsNotEqualAttribute">
  1040. <summary>
  1041. demo:
  1042. [SsNotEqual(path = "http.method", value = "PUT",errorMessage = "不可为PUT请求")]
  1043. </summary>
  1044. </member>
  1045. <member name="T:Sers.SersLoader.ApiDesc.Attribute.Valid.SsNotNullAttribute">
  1046. <summary>
  1047. demo:
  1048. [SsNotNull(path = "http.headers.Authorization", errorMessage = "必须指定Authorization")]
  1049. </summary>
  1050. </member>
  1051. <member name="T:Sers.SersLoader.ApiDesc.Attribute.Valid.SsRegexAttribute">
  1052. <summary>
  1053. 正则限制
  1054. </summary>
  1055. </member>
  1056. <member name="M:Sers.SersLoader.ApiLoader.LoadApi(Newtonsoft.Json.Linq.JObject)">
  1057. <summary>
  1058. 调用SsApi加载器加载api
  1059. </summary>
  1060. <param name="config"></param>
  1061. <returns></returns>
  1062. </member>
  1063. <member name="M:Sers.SersLoader.ApiLoader.LoadApi(Sers.SersLoader.ApiLoaderConfig)">
  1064. <summary>
  1065. 调用SsApi加载器加载api
  1066. </summary>
  1067. <param name="config"></param>
  1068. <returns></returns>
  1069. </member>
  1070. <member name="M:Sers.SersLoader.ApiLoader.GetApiDesc(System.Reflection.MethodInfo)">
  1071. <summary>
  1072. </summary>
  1073. <param name="method"></param>
  1074. </member>
  1075. <member name="M:Sers.SersLoader.ApiLoader.LoadApiNodes(System.Collections.Generic.List{System.String},System.Reflection.MethodInfo,System.Func{Sers.Core.Module.Api.ApiDesc.SsApiDesc})">
  1076. <summary>
  1077. </summary>
  1078. <param name="routePrefixs">demo: ["/Auth/fold1/fold2","/api","/"]</param>
  1079. <param name="method"></param>
  1080. <param name="CreateApiDesc"></param>
  1081. </member>
  1082. <member name="P:Sers.SersLoader.ApiLoaderConfig.apiStationName_Force">
  1083. <summary>
  1084. 强制指定ApiStation名称。可不指定。(优先级从高到低: apiStationName_Force 、 在代码上的SsStationNameAttribute特性指定 、 apiStationName 、 appsettings.json指定)
  1085. </summary>
  1086. </member>
  1087. <member name="P:Sers.SersLoader.ApiLoaderConfig.apiStationName">
  1088. <summary>
  1089. ApiStation名称。可不指定。(优先级从高到低: apiStationName_Force 、 在代码上的SsStationNameAttribute特性指定 、 apiStationName 、 appsettings.json指定)
  1090. </summary>
  1091. </member>
  1092. <member name="P:Sers.SersLoader.ApiLoaderConfig.assembly">
  1093. <summary>
  1094. 在此Assembly中查找服务(assembly、assemblyFile、assemblyName 指定任一即可)
  1095. </summary>
  1096. </member>
  1097. <member name="P:Sers.SersLoader.ApiLoaderConfig.assemblyFile">
  1098. <summary>
  1099. 在此Assembly中查找服务(如 App.StationDemo.Station.dll)(assembly、assemblyFile、assemblyName 指定任一即可)
  1100. </summary>
  1101. </member>
  1102. <member name="P:Sers.SersLoader.ApiLoaderConfig.assemblyName">
  1103. <summary>
  1104. 在此Assembly中查找服务(如 App.StationDemo.Station)(assembly、assemblyFile、assemblyName 指定任一即可)
  1105. </summary>
  1106. </member>
  1107. <member name="P:Sers.SersLoader.ApiLoaderConfig.routePrefix_Force">
  1108. <summary>
  1109. 强制路由前缀,例如:"demo/v1"。可不指定。(优先级从高到低: routePrefix_Force、在代码上的SsRoutePrefixAttribute特性指定 、 routePrefix)
  1110. </summary>
  1111. </member>
  1112. <member name="P:Sers.SersLoader.ApiLoaderConfig.routePrefix">
  1113. <summary>
  1114. 路由前缀,例如:"demo/v1"。可不指定。(优先级从高到低: routePrefix_Force、在代码上的SsRoutePrefixAttribute特性指定 、 routePrefix )
  1115. </summary>
  1116. </member>
  1117. <member name="M:Sers.SersLoader.SsModelBuilder.CreateEntityByParameterInfo(System.Reflection.ParameterInfo[],Vit.Core.Util.XmlComment.MethodComment,System.Collections.Generic.List{Sers.Core.Module.Api.ApiDesc.SsModelEntity})">
  1118. <summary>
  1119. </summary>
  1120. <param name="infos">length大于0</param>
  1121. <param name="comment"></param>
  1122. <param name="refModels"></param>
  1123. <returns></returns>
  1124. </member>
  1125. <member name="M:Sers.SersLoader.SsModelBuilder.CreateEntityByType(System.Type,System.Collections.Generic.List{Sers.Core.Module.Api.ApiDesc.SsModelEntity})">
  1126. <summary>
  1127. info mode 可为 array 或 object
  1128. </summary>
  1129. <param name="info"></param>
  1130. <param name="refModels"></param>
  1131. <returns></returns>
  1132. </member>
  1133. <member name="M:Vit.Extensions.SsApiDescExtensions.ServiceKeyGet(Sers.Core.Module.Api.ApiDesc.SsApiDesc)">
  1134. <summary>
  1135. 为 route + "_"+ httpMethod
  1136. httpMethod可能为空
  1137. </summary>
  1138. <param name="data"></param>
  1139. <returns></returns>
  1140. </member>
  1141. <member name="T:Vit.Extensions.IRpcContextDataExtensions">
  1142. <summary>
  1143. Extension methods for RpcContextData
  1144. </summary>
  1145. <summary>
  1146. Extension methods for RpcContextData
  1147. </summary>
  1148. </member>
  1149. <member name="M:Vit.Extensions.IRpcContextDataExtensions.ValueSetByPath(Sers.Core.Module.Rpc.IRpcContextData,System.Object,System.Object[])">
  1150. <summary>
  1151. </summary>
  1152. <param name="data"></param>
  1153. <param name="value"></param>
  1154. <param name="path">value在data中的路径,至少一层,例如:new []{"taskList"}</param>
  1155. </member>
  1156. <member name="M:Vit.Extensions.IRpcContextDataExtensions.StringGetByPath(Sers.Core.Module.Rpc.IRpcContextData,System.Object[])">
  1157. <summary>
  1158. </summary>
  1159. <param name="data"></param>
  1160. <param name="path">value在data中的路径,至少一层,例如:new []{"taskList"}</param>
  1161. <returns></returns>
  1162. </member>
  1163. <member name="M:Vit.Extensions.IRpcContextDataExtensions.http_url_Get(Sers.Core.Module.Rpc.IRpcContextData)">
  1164. <summary>
  1165. 若为内部调用,在调用时构建的url前缀为 "http://sers.internal"。
  1166. 如 "http://sers.internal/Station1/getName"
  1167. </summary>
  1168. <param name="data"></param>
  1169. <returns></returns>
  1170. </member>
  1171. <member name="M:Vit.Extensions.IRpcContextDataExtensions.http_url_Set(Sers.Core.Module.Rpc.IRpcContextData,System.String)">
  1172. <summary>
  1173. 若为内部调用,手动添加url前缀 "http://sers.internal"。
  1174. 如 "http://sers.internal/Station1/getName"
  1175. </summary>
  1176. <param name="data"></param>
  1177. <param name="url"></param>
  1178. </member>
  1179. <member name="M:Vit.Extensions.IRpcContextDataExtensions.http_url_search_Get(Sers.Core.Module.Rpc.IRpcContextData)">
  1180. <summary>
  1181. 获取泛接口 路由 * 实际传递的内容。
  1182. <para>(若 route为"/Station1/fold1/a/*",url为"http://127.0.0.1/Station1/fold1/a/1/2.html?c=9",则search为"1/2.html?c=9")</para>
  1183. </summary>
  1184. <param name="data"></param>
  1185. <returns></returns>
  1186. </member>
  1187. <member name="M:Vit.Extensions.IRpcContextDataExtensions.http_url_RelativeUrl_Get(Sers.Core.Module.Rpc.IRpcContextData)">
  1188. <summary>
  1189. 获取当前url对应的相对文件路径(若不合法,则返回null)。demo:"rpc/2.html"
  1190. <para>(若 route为"/Station1/fold1/a/*",url为"http://127.0.0.1/Station1/fold1/a/1/2.html?c=9",则 relativePath为"1/2.html")</para>
  1191. </summary>
  1192. <returns></returns>
  1193. </member>
  1194. <member name="M:Vit.Extensions.IRpcContextDataExtensions.http_url_RelativePath_Get(Sers.Core.Module.Rpc.IRpcContextData)">
  1195. <summary>
  1196. 获取当前url对应的相对文件路径(若不合法,则返回null,会自动转换文件夹分隔符)。demo:"rpc\\2.html"
  1197. <para>(若 route为"/Station1/fold1/a/*",url为"http://127.0.0.1/Station1/fold1/a/1/2.html?c=9",则 relativePath为"1\\2.html")</para>
  1198. </summary>
  1199. <returns></returns>
  1200. </member>
  1201. <member name="M:Vit.Extensions.IRpcContextDataExtensions.http_protocol_Get(Sers.Core.Module.Rpc.IRpcContextData)">
  1202. <summary>
  1203. 如 "HTTP/2.0"
  1204. </summary>
  1205. <param name="data"></param>
  1206. <returns></returns>
  1207. </member>
  1208. <member name="M:Vit.Extensions.IRpcContextDataExtensions.http_protocol_Set(Sers.Core.Module.Rpc.IRpcContextData,System.String)">
  1209. <summary>
  1210. 如 "HTTP/2.0"
  1211. </summary>
  1212. <param name="data"></param>
  1213. <param name="value"></param>
  1214. <returns></returns>
  1215. </member>
  1216. <member name="M:Vit.Extensions.IRpcContextDataExtensions.http_headers_Get(Sers.Core.Module.Rpc.IRpcContextData)">
  1217. <summary>
  1218. 若没指定headers则返回null
  1219. </summary>
  1220. <param name="data"></param>
  1221. <returns></returns>
  1222. </member>
  1223. <member name="M:Vit.Extensions.UseApiTraceLogExtensions.UseApiTraceLog(Sers.Core.Module.Api.LocalApi.Event.LocalApiEventMng)">
  1224. <summary>
  1225. txt log ("2018-01-01apitrace.log")
  1226. </summary>
  1227. <param name="data"></param>
  1228. </member>
  1229. <member name="M:Vit.Extensions.LocalApiService_StaticFileMap_Extensions.LoadApi_StaticFiles(Sers.Core.Module.Api.LocalApi.LocalApiService)">
  1230. <summary>
  1231. 从配置文件(appsettings.json::Sers.LocalApiService.staticFiles)加载静态文件映射器
  1232. </summary>
  1233. </member>
  1234. <member name="T:Vit.Extensions.ECallerSourceExtensions">
  1235. <summary>
  1236. </summary>
  1237. </member>
  1238. <member name="M:Vit.Extensions.ApiMessageExtensions.InitAsApiRequestMessage(Sers.Core.Module.Message.ApiMessage,System.String,System.Object,System.String,System.Action{Sers.Core.Module.Rpc.IRpcContextData})">
  1239. <summary>
  1240. </summary>
  1241. <param name="apiRequestMessage"></param>
  1242. <param name="url"> /api/cotrollers1/value?name=lith </param>
  1243. <param name="arg"></param>
  1244. <param name="httpMethod">可为 GET、POST、DELETE、PUT等,可不指定</param>
  1245. <param name="InitRpc">对Rpc的额外处理,如添加header</param>
  1246. <returns></returns>
  1247. </member>
  1248. </members>
  1249. </doc>