Opc.Ua.Bindings.Https.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Opc.Ua.Bindings.Https</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Opc.Ua.Bindings.HttpsServiceHost">
  8. <summary>
  9. Creates a new <see cref="T:Opc.Ua.Bindings.HttpsTransportListener"/> with
  10. <see cref="T:Opc.Ua.ITransportListener"/> interface.
  11. </summary>
  12. </member>
  13. <member name="P:Opc.Ua.Bindings.HttpsServiceHost.UriScheme">
  14. <summary>
  15. The protocol supported by the listener.
  16. </summary>
  17. </member>
  18. <member name="M:Opc.Ua.Bindings.HttpsServiceHost.Create">
  19. <summary>
  20. The method creates a new instance of a <see cref="T:Opc.Ua.Bindings.HttpsTransportListener"/>.
  21. </summary>
  22. <returns>The transport listener.</returns>
  23. </member>
  24. <member name="M:Opc.Ua.Bindings.HttpsServiceHost.CreateServiceHost(Opc.Ua.ServerBase,System.Collections.Generic.IDictionary{System.String,System.Threading.Tasks.Task},Opc.Ua.ApplicationConfiguration,System.Collections.Generic.IList{System.String},Opc.Ua.ApplicationDescription,System.Collections.Generic.List{Opc.Ua.ServerSecurityPolicy},System.Security.Cryptography.X509Certificates.X509Certificate2,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)">
  25. <inheritdoc/>
  26. <summary>
  27. Create a new service host for UA HTTPS.
  28. </summary>
  29. </member>
  30. <member name="T:Opc.Ua.Bindings.HttpsTransportChannelFactory">
  31. <summary>
  32. Creates a new HttpsTransportChannel with ITransportChannel interface.
  33. </summary>
  34. </member>
  35. <member name="P:Opc.Ua.Bindings.HttpsTransportChannelFactory.UriScheme">
  36. <summary>
  37. The protocol supported by the channel.
  38. </summary>
  39. </member>
  40. <member name="M:Opc.Ua.Bindings.HttpsTransportChannelFactory.Create">
  41. <summary>
  42. The method creates a new instance of a Https transport channel
  43. </summary>
  44. <returns>The transport channel</returns>
  45. </member>
  46. <member name="T:Opc.Ua.Bindings.HttpsTransportChannel">
  47. <summary>
  48. Wraps the HttpsTransportChannel and provides an ITransportChannel implementation.
  49. </summary>
  50. </member>
  51. <member name="M:Opc.Ua.Bindings.HttpsTransportChannel.Dispose">
  52. <inheritdoc/>
  53. </member>
  54. <member name="P:Opc.Ua.Bindings.HttpsTransportChannel.UriScheme">
  55. <inheritdoc/>
  56. </member>
  57. <member name="P:Opc.Ua.Bindings.HttpsTransportChannel.SupportedFeatures">
  58. <inheritdoc/>
  59. </member>
  60. <member name="P:Opc.Ua.Bindings.HttpsTransportChannel.EndpointDescription">
  61. <inheritdoc/>
  62. </member>
  63. <member name="P:Opc.Ua.Bindings.HttpsTransportChannel.EndpointConfiguration">
  64. <inheritdoc/>
  65. </member>
  66. <member name="P:Opc.Ua.Bindings.HttpsTransportChannel.MessageContext">
  67. <inheritdoc/>
  68. </member>
  69. <member name="P:Opc.Ua.Bindings.HttpsTransportChannel.CurrentToken">
  70. <inheritdoc/>
  71. </member>
  72. <member name="P:Opc.Ua.Bindings.HttpsTransportChannel.OperationTimeout">
  73. <inheritdoc/>
  74. </member>
  75. <member name="M:Opc.Ua.Bindings.HttpsTransportChannel.Initialize(System.Uri,Opc.Ua.TransportChannelSettings)">
  76. <inheritdoc/>
  77. </member>
  78. <member name="M:Opc.Ua.Bindings.HttpsTransportChannel.Initialize(Opc.Ua.ITransportWaitingConnection,Opc.Ua.TransportChannelSettings)">
  79. <summary>
  80. Initializes a secure channel with a waiting reverse connection.
  81. </summary>
  82. <param name="connection">The connection to use.</param>
  83. <param name="settings">The settings to use when creating the channel.</param>
  84. <exception cref="T:Opc.Ua.ServiceResultException">Thrown if any communication error occurs.</exception>
  85. </member>
  86. <member name="M:Opc.Ua.Bindings.HttpsTransportChannel.Open">
  87. <inheritdoc/>
  88. </member>
  89. <member name="M:Opc.Ua.Bindings.HttpsTransportChannel.Close">
  90. <inheritdoc/>
  91. </member>
  92. <member name="T:Opc.Ua.Bindings.HttpsTransportChannel.AsyncResult">
  93. <summary>
  94. The async result class for the Https transport.
  95. </summary>
  96. </member>
  97. <member name="M:Opc.Ua.Bindings.HttpsTransportChannel.BeginSendRequest(Opc.Ua.IServiceRequest,System.AsyncCallback,System.Object)">
  98. <inheritdoc/>
  99. </member>
  100. <member name="M:Opc.Ua.Bindings.HttpsTransportChannel.EndSendRequest(System.IAsyncResult)">
  101. <inheritdoc/>
  102. </member>
  103. <member name="M:Opc.Ua.Bindings.HttpsTransportChannel.BeginOpen(System.AsyncCallback,System.Object)">
  104. <inheritdoc/>
  105. <remarks>Not implemented here.</remarks>
  106. </member>
  107. <member name="M:Opc.Ua.Bindings.HttpsTransportChannel.EndOpen(System.IAsyncResult)">
  108. <inheritdoc/>
  109. <remarks>Not implemented here.</remarks>
  110. </member>
  111. <member name="M:Opc.Ua.Bindings.HttpsTransportChannel.Reconnect">
  112. <inheritdoc/>
  113. <remarks>Not implemented here.</remarks>
  114. </member>
  115. <member name="M:Opc.Ua.Bindings.HttpsTransportChannel.Opc#Ua#ITransportChannel#Reconnect(Opc.Ua.ITransportWaitingConnection)">
  116. <inheritdoc/>
  117. <remarks>Not implemented here.</remarks>
  118. </member>
  119. <member name="M:Opc.Ua.Bindings.HttpsTransportChannel.BeginReconnect(System.AsyncCallback,System.Object)">
  120. <inheritdoc/>
  121. <remarks>Not implemented here.</remarks>
  122. </member>
  123. <member name="M:Opc.Ua.Bindings.HttpsTransportChannel.EndReconnect(System.IAsyncResult)">
  124. <inheritdoc/>
  125. <remarks>Not implemented here.</remarks>
  126. </member>
  127. <member name="M:Opc.Ua.Bindings.HttpsTransportChannel.BeginClose(System.AsyncCallback,System.Object)">
  128. <inheritdoc/>
  129. <remarks>Not implemented here.</remarks>
  130. </member>
  131. <member name="M:Opc.Ua.Bindings.HttpsTransportChannel.EndClose(System.IAsyncResult)">
  132. <inheritdoc/>
  133. <remarks>Not implemented here.</remarks>
  134. </member>
  135. <member name="M:Opc.Ua.Bindings.HttpsTransportChannel.SendRequest(Opc.Ua.IServiceRequest)">
  136. <inheritdoc/>
  137. </member>
  138. <member name="M:Opc.Ua.Bindings.HttpsTransportChannel.SaveSettings(System.Uri,Opc.Ua.TransportChannelSettings)">
  139. <summary>
  140. Save the settings for a connection.
  141. </summary>
  142. <param name="url">The server url.</param>
  143. <param name="settings">The settings for the transport channel.</param>
  144. </member>
  145. <member name="T:Opc.Ua.Bindings.HttpsTransportListenerFactory">
  146. <summary>
  147. Creates a new <see cref="T:Opc.Ua.Bindings.HttpsTransportListener"/> with
  148. <see cref="T:Opc.Ua.ITransportListener"/> interface.
  149. </summary>
  150. </member>
  151. <member name="P:Opc.Ua.Bindings.HttpsTransportListenerFactory.UriScheme">
  152. <summary>
  153. The protocol supported by the listener.
  154. </summary>
  155. </member>
  156. <member name="M:Opc.Ua.Bindings.HttpsTransportListenerFactory.Create">
  157. <summary>
  158. The method creates a new instance of a <see cref="T:Opc.Ua.Bindings.HttpsTransportListener"/>.
  159. </summary>
  160. <returns>The transport listener.</returns>
  161. </member>
  162. <member name="T:Opc.Ua.Bindings.Startup">
  163. <summary>
  164. Implements the kestrel startup of the Https listener.
  165. </summary>
  166. </member>
  167. <member name="P:Opc.Ua.Bindings.Startup.Listener">
  168. <summary>
  169. Get the Https listener.
  170. </summary>
  171. </member>
  172. <member name="M:Opc.Ua.Bindings.Startup.Configure(Microsoft.AspNetCore.Builder.IApplicationBuilder)">
  173. <summary>
  174. Configure the request pipeline for the listener.
  175. </summary>
  176. <param name="appBuilder">The application builder.</param>
  177. </member>
  178. <member name="T:Opc.Ua.Bindings.HttpsTransportListener">
  179. <summary>
  180. Manages the connections for a UA HTTPS server.
  181. </summary>
  182. </member>
  183. <member name="M:Opc.Ua.Bindings.HttpsTransportListener.#ctor">
  184. <summary>
  185. Initializes a new instance of the <see cref="T:Opc.Ua.Bindings.HttpsTransportListener"/> class.
  186. </summary>
  187. </member>
  188. <member name="M:Opc.Ua.Bindings.HttpsTransportListener.Dispose">
  189. <summary>
  190. Frees any unmanaged resources.
  191. </summary>
  192. </member>
  193. <member name="M:Opc.Ua.Bindings.HttpsTransportListener.Dispose(System.Boolean)">
  194. <summary>
  195. An overrideable version of the Dispose.
  196. </summary>
  197. </member>
  198. <member name="P:Opc.Ua.Bindings.HttpsTransportListener.UriScheme">
  199. <summary>
  200. The URI scheme handled by the listener.
  201. </summary>
  202. </member>
  203. <member name="M:Opc.Ua.Bindings.HttpsTransportListener.Open(System.Uri,Opc.Ua.TransportListenerSettings,Opc.Ua.ITransportListenerCallback)">
  204. <summary>
  205. Opens the listener and starts accepting connection.
  206. </summary>
  207. <param name="baseAddress">The base address.</param>
  208. <param name="settings">The settings to use when creating the listener.</param>
  209. <param name="callback">The callback to use when requests arrive via the channel.</param>
  210. <exception cref="T:System.ArgumentNullException">Thrown if any parameter is null.</exception>
  211. <exception cref="T:Opc.Ua.ServiceResultException">Thrown if any communication error occurs.</exception>
  212. </member>
  213. <member name="M:Opc.Ua.Bindings.HttpsTransportListener.Close">
  214. <summary>
  215. Closes the listener and stops accepting connection.
  216. </summary>
  217. <exception cref="T:Opc.Ua.ServiceResultException">Thrown if any communication error occurs.</exception>
  218. </member>
  219. <member name="E:Opc.Ua.Bindings.HttpsTransportListener.ConnectionWaiting">
  220. <summary>
  221. Raised when a new connection is waiting for a client.
  222. </summary>
  223. </member>
  224. <member name="E:Opc.Ua.Bindings.HttpsTransportListener.ConnectionStatusChanged">
  225. <summary>
  226. Raised when a monitored connection's status changed.
  227. </summary>
  228. </member>
  229. <member name="M:Opc.Ua.Bindings.HttpsTransportListener.CreateReverseConnection(System.Uri,System.Int32)">
  230. <inheritdoc/>
  231. <remarks>
  232. Reverse connect for the https transport listener is not implemeted.
  233. </remarks>
  234. </member>
  235. <member name="P:Opc.Ua.Bindings.HttpsTransportListener.EndpointUrl">
  236. <summary>
  237. Gets the URL for the listener's endpoint.
  238. </summary>
  239. <value>The URL for the listener's endpoint.</value>
  240. </member>
  241. <member name="M:Opc.Ua.Bindings.HttpsTransportListener.Start">
  242. <summary>
  243. Starts listening at the specified port.
  244. </summary>
  245. </member>
  246. <member name="M:Opc.Ua.Bindings.HttpsTransportListener.Stop">
  247. <summary>
  248. Stops listening.
  249. </summary>
  250. </member>
  251. <member name="M:Opc.Ua.Bindings.HttpsTransportListener.SendAsync(Microsoft.AspNetCore.Http.HttpContext)">
  252. <summary>
  253. Handles requests arriving from a channel.
  254. </summary>
  255. </member>
  256. <member name="M:Opc.Ua.Bindings.HttpsTransportListener.CertificateUpdate(Opc.Ua.ICertificateValidator,System.Security.Cryptography.X509Certificates.X509Certificate2,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)">
  257. <summary>
  258. Called when a UpdateCertificate event occured.
  259. </summary>
  260. </member>
  261. </members>
  262. </doc>