Opc.Ua.Client.xml 114 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Opc.Ua.Client</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Opc.Ua.Client.Browser">
  8. <summary>
  9. Stores the options to use for a browse operation.
  10. </summary>
  11. </member>
  12. <member name="M:Opc.Ua.Client.Browser.#ctor">
  13. <summary>
  14. Creates an unattached instance of a browser.
  15. </summary>
  16. </member>
  17. <member name="M:Opc.Ua.Client.Browser.#ctor(Opc.Ua.Client.Session)">
  18. <summary>
  19. Creates new instance of a browser and attaches it to a session.
  20. </summary>
  21. </member>
  22. <member name="M:Opc.Ua.Client.Browser.#ctor(Opc.Ua.Client.Browser)">
  23. <summary>
  24. Creates a copy of a browser.
  25. </summary>
  26. </member>
  27. <member name="M:Opc.Ua.Client.Browser.Initialize">
  28. <summary>
  29. Sets all private fields to default values.
  30. </summary>
  31. </member>
  32. <member name="P:Opc.Ua.Client.Browser.Session">
  33. <summary>
  34. The session that the browse is attached to.
  35. </summary>
  36. </member>
  37. <member name="P:Opc.Ua.Client.Browser.View">
  38. <summary>
  39. The view to use for the browse operation.
  40. </summary>
  41. </member>
  42. <member name="P:Opc.Ua.Client.Browser.MaxReferencesReturned">
  43. <summary>
  44. The maximum number of refrences to return in a single browse operation.
  45. </summary>
  46. </member>
  47. <member name="P:Opc.Ua.Client.Browser.BrowseDirection">
  48. <summary>
  49. The direction to browse.
  50. </summary>
  51. </member>
  52. <member name="P:Opc.Ua.Client.Browser.ReferenceTypeId">
  53. <summary>
  54. The reference type to follow.
  55. </summary>
  56. </member>
  57. <member name="P:Opc.Ua.Client.Browser.IncludeSubtypes">
  58. <summary>
  59. Whether subtypes of the reference type should be included.
  60. </summary>
  61. </member>
  62. <member name="P:Opc.Ua.Client.Browser.NodeClassMask">
  63. <summary>
  64. The classes of the target nodes.
  65. </summary>
  66. </member>
  67. <member name="P:Opc.Ua.Client.Browser.ResultMask">
  68. <summary>
  69. The results to return.
  70. </summary>
  71. </member>
  72. <member name="E:Opc.Ua.Client.Browser.MoreReferences">
  73. <summary>
  74. Raised when a browse operation halted because of a continuation point.
  75. </summary>
  76. </member>
  77. <member name="P:Opc.Ua.Client.Browser.ContinueUntilDone">
  78. <summary>
  79. Whether subsequent continuation points should be processed automatically.
  80. </summary>
  81. </member>
  82. <member name="M:Opc.Ua.Client.Browser.Browse(Opc.Ua.NodeId)">
  83. <summary>
  84. Browses the specified node.
  85. </summary>
  86. </member>
  87. <member name="M:Opc.Ua.Client.Browser.CheckBrowserState">
  88. <summary>
  89. Checks the state of the browser.
  90. </summary>
  91. </member>
  92. <member name="M:Opc.Ua.Client.Browser.BrowseNext(System.Byte[]@,System.Boolean)">
  93. <summary>
  94. Fetches the next batch of references.
  95. </summary>
  96. <param name="continuationPoint">The continuation point.</param>
  97. <param name="cancel">if set to <c>true</c> the browse operation is cancelled.</param>
  98. <returns>The next batch of references</returns>
  99. </member>
  100. <member name="T:Opc.Ua.Client.BrowserEventArgs">
  101. <summary>
  102. The event arguments provided a browse operation returns a continuation point.
  103. </summary>
  104. </member>
  105. <member name="M:Opc.Ua.Client.BrowserEventArgs.#ctor(Opc.Ua.ReferenceDescriptionCollection)">
  106. <summary>
  107. Creates a new instance.
  108. </summary>
  109. </member>
  110. <member name="P:Opc.Ua.Client.BrowserEventArgs.Cancel">
  111. <summary>
  112. Whether the browse operation should be cancelled.
  113. </summary>
  114. </member>
  115. <member name="P:Opc.Ua.Client.BrowserEventArgs.ContinueUntilDone">
  116. <summary>
  117. Whether subsequent continuation points should be processed automatically.
  118. </summary>
  119. </member>
  120. <member name="P:Opc.Ua.Client.BrowserEventArgs.References">
  121. <summary>
  122. The references that have been fetched so far.
  123. </summary>
  124. </member>
  125. <member name="T:Opc.Ua.Client.BrowserEventHandler">
  126. <summary>
  127. A delegate used to received browser events.
  128. </summary>
  129. </member>
  130. <member name="T:Opc.Ua.Client.CoreClientUtils">
  131. <summary>
  132. Defines numerous re-useable utility functions for clients.
  133. </summary>
  134. </member>
  135. <member name="F:Opc.Ua.Client.CoreClientUtils.DefaultDiscoverTimeout">
  136. <summary>
  137. The default discover operation timeout.
  138. </summary>
  139. </member>
  140. <member name="M:Opc.Ua.Client.CoreClientUtils.DiscoverServers(Opc.Ua.ApplicationConfiguration)">
  141. <summary>
  142. Discovers the servers on the local machine.
  143. </summary>
  144. <param name="configuration">The configuration.</param>
  145. <returns>A list of server urls.</returns>
  146. </member>
  147. <member name="M:Opc.Ua.Client.CoreClientUtils.DiscoverServers(Opc.Ua.ApplicationConfiguration,System.Int32)">
  148. <summary>
  149. Discovers the servers on the local machine.
  150. </summary>
  151. <param name="configuration">The configuration.</param>
  152. <param name="discoverTimeout">Operation timeout in milliseconds.</param>
  153. <returns>A list of server urls.</returns>
  154. </member>
  155. <member name="M:Opc.Ua.Client.CoreClientUtils.SelectEndpoint(System.String,System.Boolean)">
  156. <summary>
  157. Finds the endpoint that best matches the current settings.
  158. </summary>
  159. <param name="discoveryUrl">The discovery URL.</param>
  160. <param name="useSecurity">if set to <c>true</c> select an endpoint that uses security.</param>
  161. <returns>The best available endpoint.</returns>
  162. </member>
  163. <member name="M:Opc.Ua.Client.CoreClientUtils.SelectEndpoint(System.String,System.Boolean,System.Int32)">
  164. <summary>
  165. Finds the endpoint that best matches the current settings.
  166. </summary>
  167. <param name="discoveryUrl">The discovery URL.</param>
  168. <param name="useSecurity">if set to <c>true</c> select an endpoint that uses security.</param>
  169. <param name="discoverTimeout">Operation timeout in milliseconds.</param>
  170. <returns>The best available endpoint.</returns>
  171. </member>
  172. <member name="M:Opc.Ua.Client.CoreClientUtils.SelectEndpoint(Opc.Ua.ApplicationConfiguration,Opc.Ua.ITransportWaitingConnection,System.Boolean)">
  173. <summary>
  174. Finds the endpoint that best matches the current settings.
  175. </summary>
  176. </member>
  177. <member name="M:Opc.Ua.Client.CoreClientUtils.SelectEndpoint(Opc.Ua.ApplicationConfiguration,Opc.Ua.ITransportWaitingConnection,System.Boolean,System.Int32)">
  178. <summary>
  179. Finds the endpoint that best matches the current settings.
  180. </summary>
  181. </member>
  182. <member name="M:Opc.Ua.Client.CoreClientUtils.SelectEndpoint(Opc.Ua.ApplicationConfiguration,System.String,System.Boolean)">
  183. <summary>
  184. Finds the endpoint that best matches the current settings.
  185. </summary>
  186. <param name="application">The application configuration.</param>
  187. <param name="discoveryUrl">The discovery URL.</param>
  188. <param name="useSecurity">if set to <c>true</c> select an endpoint that uses security.</param>
  189. <returns>The best available endpoint.</returns>
  190. </member>
  191. <member name="M:Opc.Ua.Client.CoreClientUtils.SelectEndpoint(Opc.Ua.ApplicationConfiguration,System.String,System.Boolean,System.Int32)">
  192. <summary>
  193. Finds the endpoint that best matches the current settings.
  194. </summary>
  195. <param name="application">The application configuration.</param>
  196. <param name="discoveryUrl">The discovery URL.</param>
  197. <param name="useSecurity">if set to <c>true</c> select an endpoint that uses security.</param>
  198. <param name="discoverTimeout">The timeout for the discover operation.</param>
  199. <returns>The best available endpoint.</returns>
  200. </member>
  201. <member name="M:Opc.Ua.Client.CoreClientUtils.SelectEndpoint(System.Uri,Opc.Ua.EndpointDescriptionCollection,System.Boolean)">
  202. <summary>
  203. Select the best supported endpoint from an
  204. EndpointDescriptionCollection, with or without security.
  205. </summary>
  206. <param name="url"></param>
  207. <param name="endpoints"></param>
  208. <param name="useSecurity"></param>
  209. </member>
  210. <member name="T:Opc.Ua.Client.DataDictionary">
  211. <summary>
  212. A class that holds the configuration for a UA service.
  213. </summary>
  214. </member>
  215. <member name="M:Opc.Ua.Client.DataDictionary.#ctor(Opc.Ua.Client.Session)">
  216. <summary>
  217. The default constructor.
  218. </summary>
  219. </member>
  220. <member name="M:Opc.Ua.Client.DataDictionary.Initialize">
  221. <summary>
  222. Sets private members to default values.
  223. </summary>
  224. </member>
  225. <member name="P:Opc.Ua.Client.DataDictionary.DictionaryId">
  226. <summary>
  227. The node id for the dictionary.
  228. </summary>
  229. </member>
  230. <member name="P:Opc.Ua.Client.DataDictionary.Name">
  231. <summary>
  232. The display name for the dictionary.
  233. </summary>
  234. </member>
  235. <member name="P:Opc.Ua.Client.DataDictionary.TypeSystemId">
  236. <summary>
  237. The node id for the type system.
  238. </summary>
  239. </member>
  240. <member name="P:Opc.Ua.Client.DataDictionary.TypeSystemName">
  241. <summary>
  242. The display name for the type system.
  243. </summary>
  244. </member>
  245. <member name="P:Opc.Ua.Client.DataDictionary.TypeDictionary">
  246. <summary>
  247. The type dictionary.
  248. </summary>
  249. </member>
  250. <member name="P:Opc.Ua.Client.DataDictionary.DataTypes">
  251. <summary>
  252. The data type dictionary.
  253. </summary>
  254. </member>
  255. <member name="M:Opc.Ua.Client.DataDictionary.Load(Opc.Ua.ReferenceDescription)">
  256. <summary>
  257. Loads the dictionary identified by the node id.
  258. </summary>
  259. </member>
  260. <member name="M:Opc.Ua.Client.DataDictionary.Load(Opc.Ua.NodeId,System.String)">
  261. <summary>
  262. Loads the dictionary identified by the node id.
  263. </summary>
  264. </member>
  265. <member name="M:Opc.Ua.Client.DataDictionary.Contains(Opc.Ua.NodeId)">
  266. <summary>
  267. Returns true if the dictionary contains the data type description;
  268. </summary>
  269. </member>
  270. <member name="M:Opc.Ua.Client.DataDictionary.GetSchema(Opc.Ua.NodeId)">
  271. <summary>
  272. Returns the schema for the specified type (returns the entire dictionary if null).
  273. </summary>
  274. </member>
  275. <member name="M:Opc.Ua.Client.DataDictionary.GetTypeSystem(Opc.Ua.NodeId)">
  276. <summary>
  277. Retrieves the type system for the dictionary.
  278. </summary>
  279. </member>
  280. <member name="M:Opc.Ua.Client.DataDictionary.ReadDataTypes(Opc.Ua.NodeId)">
  281. <summary>
  282. Retrieves the data types in the dictionary.
  283. </summary>
  284. <remarks>
  285. In order to allow for fast Linq matching of dictionary
  286. QNames with the data type nodes, the BrowseName of
  287. the DataType node is replaced with Value string.
  288. </remarks>
  289. </member>
  290. <member name="M:Opc.Ua.Client.DataDictionary.ReadDictionary(Opc.Ua.NodeId)">
  291. <summary>
  292. Reads the contents of a data dictionary.
  293. </summary>
  294. </member>
  295. <member name="M:Opc.Ua.Client.DataDictionary.Validate(System.Byte[])">
  296. <summary>
  297. Validates the type dictionary.
  298. </summary>
  299. <param name="dictionary"></param>
  300. </member>
  301. <member name="T:Opc.Ua.Client.NamespaceDoc">
  302. <summary>
  303. The <b>Opc.Ua.Client</b> namespace defines classes which can be used to implement a UA client.
  304. These classes manage client side state information, provide higher level abstractions for UA
  305. tasks such as managing sessions/subscriptions and saving/restoring connection information for
  306. later use.
  307. </summary>
  308. <exclude/>
  309. </member>
  310. <member name="T:Opc.Ua.Client.MonitoredItem">
  311. <summary>
  312. A monitored item.
  313. </summary>
  314. </member>
  315. <member name="M:Opc.Ua.Client.MonitoredItem.#ctor">
  316. <summary>
  317. Initializes a new instance of the <see cref="T:Opc.Ua.Client.MonitoredItem"/> class.
  318. </summary>
  319. </member>
  320. <member name="M:Opc.Ua.Client.MonitoredItem.#ctor(System.UInt32)">
  321. <summary>
  322. Initializes a new instance of the <see cref="T:Opc.Ua.Client.MonitoredItem"/> class.
  323. </summary>
  324. <param name="clientHandle">The client handle. The caller must ensure it uniquely identifies the monitored item.</param>
  325. </member>
  326. <member name="M:Opc.Ua.Client.MonitoredItem.#ctor(Opc.Ua.Client.MonitoredItem)">
  327. <summary>
  328. Initializes a new instance of the <see cref="T:Opc.Ua.Client.MonitoredItem"/> class.
  329. </summary>
  330. <param name="template">The template used to specify the monitoring parameters.</param>
  331. </member>
  332. <member name="M:Opc.Ua.Client.MonitoredItem.#ctor(Opc.Ua.Client.MonitoredItem,System.Boolean)">
  333. <summary>
  334. Initializes a new instance of the <see cref="T:Opc.Ua.Client.MonitoredItem"/> class.
  335. </summary>
  336. <param name="template">The template used to specify the monitoring parameters.</param>
  337. <param name="copyEventHandlers">if set to <c>true</c> the event handlers are copied.</param>
  338. </member>
  339. <member name="M:Opc.Ua.Client.MonitoredItem.#ctor(Opc.Ua.Client.MonitoredItem,System.Boolean,System.Boolean)">
  340. <summary>
  341. Initializes a new instance of the <see cref="T:Opc.Ua.Client.MonitoredItem"/> class.
  342. </summary>
  343. <param name="template">The template used to specify the monitoring parameters.</param>
  344. <param name="copyEventHandlers">if set to <c>true</c> the event handlers are copied.</param>
  345. <param name="copyClientHandle">if set to <c>true</c> the clientHandle is of the template copied.</param>
  346. </member>
  347. <member name="M:Opc.Ua.Client.MonitoredItem.Initialize(System.Runtime.Serialization.StreamingContext)">
  348. <summary>
  349. Called by the .NET framework during deserialization.
  350. </summary>
  351. </member>
  352. <member name="M:Opc.Ua.Client.MonitoredItem.Initialize">
  353. <summary>
  354. Sets the private members to default values.
  355. </summary>
  356. </member>
  357. <member name="P:Opc.Ua.Client.MonitoredItem.DisplayName">
  358. <summary>
  359. A display name for the monitored item.
  360. </summary>
  361. </member>
  362. <member name="P:Opc.Ua.Client.MonitoredItem.StartNodeId">
  363. <summary>
  364. The start node for the browse path that identifies the node to monitor.
  365. </summary>
  366. </member>
  367. <member name="P:Opc.Ua.Client.MonitoredItem.RelativePath">
  368. <summary>
  369. The relative path from the browse path to the node to monitor.
  370. </summary>
  371. <remarks>
  372. A null or empty string specifies that the start node id should be monitored.
  373. </remarks>
  374. </member>
  375. <member name="P:Opc.Ua.Client.MonitoredItem.NodeClass">
  376. <summary>
  377. The node class of the node being monitored (affects the type of filter available).
  378. </summary>
  379. </member>
  380. <member name="P:Opc.Ua.Client.MonitoredItem.AttributeId">
  381. <summary>
  382. The attribute to monitor.
  383. </summary>
  384. </member>
  385. <member name="P:Opc.Ua.Client.MonitoredItem.IndexRange">
  386. <summary>
  387. The range of array indexes to monitor.
  388. </summary>
  389. </member>
  390. <member name="P:Opc.Ua.Client.MonitoredItem.Encoding">
  391. <summary>
  392. The encoding to use when returning notifications.
  393. </summary>
  394. </member>
  395. <member name="P:Opc.Ua.Client.MonitoredItem.MonitoringMode">
  396. <summary>
  397. The monitoring mode.
  398. </summary>
  399. </member>
  400. <member name="P:Opc.Ua.Client.MonitoredItem.SamplingInterval">
  401. <summary>
  402. The sampling interval.
  403. </summary>
  404. </member>
  405. <member name="P:Opc.Ua.Client.MonitoredItem.Filter">
  406. <summary>
  407. The filter to use to select values to return.
  408. </summary>
  409. </member>
  410. <member name="P:Opc.Ua.Client.MonitoredItem.QueueSize">
  411. <summary>
  412. The length of the queue used to buffer values.
  413. </summary>
  414. </member>
  415. <member name="P:Opc.Ua.Client.MonitoredItem.DiscardOldest">
  416. <summary>
  417. Whether to discard the oldest entries in the queue when it is full.
  418. </summary>
  419. </member>
  420. <member name="P:Opc.Ua.Client.MonitoredItem.Subscription">
  421. <summary>
  422. The subscription that owns the monitored item.
  423. </summary>
  424. </member>
  425. <member name="P:Opc.Ua.Client.MonitoredItem.Handle">
  426. <summary>
  427. A local handle assigned to the monitored item.
  428. </summary>
  429. </member>
  430. <member name="P:Opc.Ua.Client.MonitoredItem.Created">
  431. <summary>
  432. Whether the item has been created on the server.
  433. </summary>
  434. </member>
  435. <member name="P:Opc.Ua.Client.MonitoredItem.ClientHandle">
  436. <summary>
  437. The identifier assigned by the client.
  438. </summary>
  439. </member>
  440. <member name="P:Opc.Ua.Client.MonitoredItem.ResolvedNodeId">
  441. <summary>
  442. The node id to monitor after applying any relative path.
  443. </summary>
  444. </member>
  445. <member name="P:Opc.Ua.Client.MonitoredItem.AttributesModified">
  446. <summary>
  447. Whether the monitoring attributes have been modified since the item was created.
  448. </summary>
  449. </member>
  450. <member name="P:Opc.Ua.Client.MonitoredItem.Status">
  451. <summary>
  452. The status associated with the monitored item.
  453. </summary>
  454. </member>
  455. <member name="P:Opc.Ua.Client.MonitoredItem.CacheQueueSize">
  456. <summary>
  457. Returns the queue size used by the cache.
  458. </summary>
  459. </member>
  460. <member name="P:Opc.Ua.Client.MonitoredItem.LastValue">
  461. <summary>
  462. The last value or event received from the server.
  463. </summary>
  464. </member>
  465. <member name="M:Opc.Ua.Client.MonitoredItem.DequeueValues">
  466. <summary>
  467. Read all values in the cache queue.
  468. </summary>
  469. </member>
  470. <member name="M:Opc.Ua.Client.MonitoredItem.DequeueEvents">
  471. <summary>
  472. Read all events in the cache queue.
  473. </summary>
  474. </member>
  475. <member name="P:Opc.Ua.Client.MonitoredItem.LastMessage">
  476. <summary>
  477. The last message containing a notification for the item.
  478. </summary>
  479. </member>
  480. <member name="E:Opc.Ua.Client.MonitoredItem.Notification">
  481. <summary>
  482. Raised when a new notification arrives.
  483. </summary>
  484. </member>
  485. <member name="M:Opc.Ua.Client.MonitoredItem.SaveValueInCache(Opc.Ua.IEncodeable)">
  486. <summary>
  487. Saves a data change or event in the cache.
  488. </summary>
  489. </member>
  490. <member name="M:Opc.Ua.Client.MonitoredItem.MemberwiseClone">
  491. <summary>
  492. Creates a deep copy of the object.
  493. </summary>
  494. </member>
  495. <member name="M:Opc.Ua.Client.MonitoredItem.SetError(Opc.Ua.ServiceResult)">
  496. <summary>
  497. Sets the error status for the monitored item.
  498. </summary>
  499. </member>
  500. <member name="M:Opc.Ua.Client.MonitoredItem.SetResolvePathResult(Opc.Ua.BrowsePathResult,System.Int32,Opc.Ua.DiagnosticInfoCollection,Opc.Ua.ResponseHeader)">
  501. <summary>
  502. Updates the object with the results of a translate browse path request.
  503. </summary>
  504. </member>
  505. <member name="M:Opc.Ua.Client.MonitoredItem.SetCreateResult(Opc.Ua.MonitoredItemCreateRequest,Opc.Ua.MonitoredItemCreateResult,System.Int32,Opc.Ua.DiagnosticInfoCollection,Opc.Ua.ResponseHeader)">
  506. <summary>
  507. Updates the object with the results of a create monitored item request.
  508. </summary>
  509. </member>
  510. <member name="M:Opc.Ua.Client.MonitoredItem.SetModifyResult(Opc.Ua.MonitoredItemModifyRequest,Opc.Ua.MonitoredItemModifyResult,System.Int32,Opc.Ua.DiagnosticInfoCollection,Opc.Ua.ResponseHeader)">
  511. <summary>
  512. Updates the object with the results of a modify monitored item request.
  513. </summary>
  514. </member>
  515. <member name="M:Opc.Ua.Client.MonitoredItem.SetDeleteResult(Opc.Ua.StatusCode,System.Int32,Opc.Ua.DiagnosticInfoCollection,Opc.Ua.ResponseHeader)">
  516. <summary>
  517. Updates the object with the results of a modify monitored item request.
  518. </summary>
  519. </member>
  520. <member name="M:Opc.Ua.Client.MonitoredItem.GetFieldName(System.Int32)">
  521. <summary>
  522. Returns the field name the specified SelectClause in the EventFilter.
  523. </summary>
  524. </member>
  525. <member name="M:Opc.Ua.Client.MonitoredItem.GetFieldValue(Opc.Ua.EventFieldList,Opc.Ua.NodeId,System.String,System.UInt32)">
  526. <summary>
  527. Returns value of the field name containing the event type.
  528. </summary>
  529. </member>
  530. <member name="M:Opc.Ua.Client.MonitoredItem.GetFieldValue(Opc.Ua.EventFieldList,Opc.Ua.NodeId,Opc.Ua.QualifiedName)">
  531. <summary>
  532. Returns value of the field name containing the event type.
  533. </summary>
  534. </member>
  535. <member name="M:Opc.Ua.Client.MonitoredItem.GetFieldValue(Opc.Ua.EventFieldList,Opc.Ua.NodeId,System.Collections.Generic.IList{Opc.Ua.QualifiedName},System.UInt32)">
  536. <summary>
  537. Returns value of the field name containing the event type.
  538. </summary>
  539. </member>
  540. <member name="M:Opc.Ua.Client.MonitoredItem.GetEventType(Opc.Ua.EventFieldList)">
  541. <summary>
  542. Returns value of the field name containing the event type.
  543. </summary>
  544. </member>
  545. <member name="M:Opc.Ua.Client.MonitoredItem.GetEventTime(Opc.Ua.EventFieldList)">
  546. <summary>
  547. Returns value of the field name containing the event type.
  548. </summary>
  549. </member>
  550. <member name="M:Opc.Ua.Client.MonitoredItem.GetServiceResult(Opc.Ua.IEncodeable)">
  551. <summary>
  552. The service result for a data change notification.
  553. </summary>
  554. </member>
  555. <member name="M:Opc.Ua.Client.MonitoredItem.GetServiceResult(Opc.Ua.IEncodeable,System.Int32)">
  556. <summary>
  557. The service result for a field in an notification (the field must contain a Status object).
  558. </summary>
  559. </member>
  560. <member name="M:Opc.Ua.Client.MonitoredItem.ValidateFilter(Opc.Ua.NodeClass,Opc.Ua.MonitoringFilter)">
  561. <summary>
  562. Throws an exception if the flter cannot be used with the node class.
  563. </summary>
  564. </member>
  565. <member name="M:Opc.Ua.Client.MonitoredItem.UseDefaultEventFilter">
  566. <summary>
  567. Sets the default event filter.
  568. </summary>
  569. </member>
  570. <member name="T:Opc.Ua.Client.MonitoredItemNotificationEventArgs">
  571. <summary>
  572. The event arguments provided when a new notification message arrives.
  573. </summary>
  574. </member>
  575. <member name="M:Opc.Ua.Client.MonitoredItemNotificationEventArgs.#ctor(Opc.Ua.IEncodeable)">
  576. <summary>
  577. Creates a new instance.
  578. </summary>
  579. </member>
  580. <member name="P:Opc.Ua.Client.MonitoredItemNotificationEventArgs.NotificationValue">
  581. <summary>
  582. The new notification.
  583. </summary>
  584. </member>
  585. <member name="T:Opc.Ua.Client.MonitoredItemNotificationEventHandler">
  586. <summary>
  587. The delegate used to receive monitored item value notifications.
  588. </summary>
  589. </member>
  590. <member name="T:Opc.Ua.Client.MonitoredItemDataCache">
  591. <summary>
  592. An item in the cache
  593. </summary>
  594. </member>
  595. <member name="M:Opc.Ua.Client.MonitoredItemDataCache.#ctor(System.Int32)">
  596. <summary>
  597. Constructs a cache for a monitored item.
  598. </summary>
  599. </member>
  600. <member name="P:Opc.Ua.Client.MonitoredItemDataCache.QueueSize">
  601. <summary>
  602. The size of the queue to maintain.
  603. </summary>
  604. </member>
  605. <member name="P:Opc.Ua.Client.MonitoredItemDataCache.LastValue">
  606. <summary>
  607. The last value received from the server.
  608. </summary>
  609. </member>
  610. <member name="M:Opc.Ua.Client.MonitoredItemDataCache.Publish">
  611. <summary>
  612. Returns all values in the queue.
  613. </summary>
  614. </member>
  615. <member name="M:Opc.Ua.Client.MonitoredItemDataCache.OnNotification(Opc.Ua.MonitoredItemNotification)">
  616. <summary>
  617. Saves a notification in the cache.
  618. </summary>
  619. </member>
  620. <member name="M:Opc.Ua.Client.MonitoredItemDataCache.SetQueueSize(System.Int32)">
  621. <summary>
  622. Changes the queue size.
  623. </summary>
  624. </member>
  625. <member name="T:Opc.Ua.Client.MonitoredItemEventCache">
  626. <summary>
  627. Saves the events received from the srever.
  628. </summary>
  629. </member>
  630. <member name="M:Opc.Ua.Client.MonitoredItemEventCache.#ctor(System.Int32)">
  631. <summary>
  632. Constructs a cache for a monitored item.
  633. </summary>
  634. </member>
  635. <member name="P:Opc.Ua.Client.MonitoredItemEventCache.QueueSize">
  636. <summary>
  637. The size of the queue to maintain.
  638. </summary>
  639. </member>
  640. <member name="P:Opc.Ua.Client.MonitoredItemEventCache.LastEvent">
  641. <summary>
  642. The last event received.
  643. </summary>
  644. </member>
  645. <member name="M:Opc.Ua.Client.MonitoredItemEventCache.Publish">
  646. <summary>
  647. Returns all events in the queue.
  648. </summary>
  649. </member>
  650. <member name="M:Opc.Ua.Client.MonitoredItemEventCache.OnNotification(Opc.Ua.EventFieldList)">
  651. <summary>
  652. Saves a notification in the cache.
  653. </summary>
  654. </member>
  655. <member name="M:Opc.Ua.Client.MonitoredItemEventCache.SetQueueSize(System.Int32)">
  656. <summary>
  657. Changes the queue size.
  658. </summary>
  659. </member>
  660. <member name="T:Opc.Ua.Client.MonitoredItemStatus">
  661. <summary>
  662. The current status of monitored item.
  663. </summary>
  664. </member>
  665. <member name="M:Opc.Ua.Client.MonitoredItemStatus.#ctor">
  666. <summary>
  667. Creates a empty object.
  668. </summary>
  669. </member>
  670. <member name="P:Opc.Ua.Client.MonitoredItemStatus.Id">
  671. <summary>
  672. The identifier assigned by the server.
  673. </summary>
  674. </member>
  675. <member name="P:Opc.Ua.Client.MonitoredItemStatus.Created">
  676. <summary>
  677. Whether the item has been created on the server.
  678. </summary>
  679. </member>
  680. <member name="P:Opc.Ua.Client.MonitoredItemStatus.Error">
  681. <summary>
  682. Any error condition associated with the monitored item.
  683. </summary>
  684. </member>
  685. <member name="P:Opc.Ua.Client.MonitoredItemStatus.NodeId">
  686. <summary>
  687. The node id being monitored.
  688. </summary>
  689. </member>
  690. <member name="P:Opc.Ua.Client.MonitoredItemStatus.AttributeId">
  691. <summary>
  692. The attribute being monitored.
  693. </summary>
  694. </member>
  695. <member name="P:Opc.Ua.Client.MonitoredItemStatus.IndexRange">
  696. <summary>
  697. The range of array indexes to being monitored.
  698. </summary>
  699. </member>
  700. <member name="P:Opc.Ua.Client.MonitoredItemStatus.DataEncoding">
  701. <summary>
  702. The encoding to use when returning notifications.
  703. </summary>
  704. </member>
  705. <member name="P:Opc.Ua.Client.MonitoredItemStatus.MonitoringMode">
  706. <summary>
  707. The monitoring mode.
  708. </summary>
  709. </member>
  710. <member name="P:Opc.Ua.Client.MonitoredItemStatus.ClientHandle">
  711. <summary>
  712. The identifier assigned by the client.
  713. </summary>
  714. </member>
  715. <member name="P:Opc.Ua.Client.MonitoredItemStatus.SamplingInterval">
  716. <summary>
  717. The sampling interval.
  718. </summary>
  719. </member>
  720. <member name="P:Opc.Ua.Client.MonitoredItemStatus.Filter">
  721. <summary>
  722. The filter to use to select values to return.
  723. </summary>
  724. </member>
  725. <member name="P:Opc.Ua.Client.MonitoredItemStatus.QueueSize">
  726. <summary>
  727. The length of the queue used to buffer values.
  728. </summary>
  729. </member>
  730. <member name="P:Opc.Ua.Client.MonitoredItemStatus.DiscardOldest">
  731. <summary>
  732. Whether to discard the oldest entries in the queue when it is full.
  733. </summary>
  734. </member>
  735. <member name="M:Opc.Ua.Client.MonitoredItemStatus.SetMonitoringMode(Opc.Ua.MonitoringMode)">
  736. <summary>
  737. Updates the monitoring mode.
  738. </summary>
  739. </member>
  740. <member name="M:Opc.Ua.Client.MonitoredItemStatus.SetResolvePathResult(Opc.Ua.BrowsePathResult,Opc.Ua.ServiceResult)">
  741. <summary>
  742. Updates the object with the results of a translate browse paths request.
  743. </summary>
  744. </member>
  745. <member name="M:Opc.Ua.Client.MonitoredItemStatus.SetCreateResult(Opc.Ua.MonitoredItemCreateRequest,Opc.Ua.MonitoredItemCreateResult,Opc.Ua.ServiceResult)">
  746. <summary>
  747. Updates the object with the results of a create monitored item request.
  748. </summary>
  749. </member>
  750. <member name="M:Opc.Ua.Client.MonitoredItemStatus.SetModifyResult(Opc.Ua.MonitoredItemModifyRequest,Opc.Ua.MonitoredItemModifyResult,Opc.Ua.ServiceResult)">
  751. <summary>
  752. Updates the object with the results of a modify monitored item request.
  753. </summary>
  754. </member>
  755. <member name="M:Opc.Ua.Client.MonitoredItemStatus.SetDeleteResult(Opc.Ua.ServiceResult)">
  756. <summary>
  757. Updates the object with the results of a delete item request.
  758. </summary>
  759. </member>
  760. <member name="M:Opc.Ua.Client.MonitoredItemStatus.SetError(Opc.Ua.ServiceResult)">
  761. <summary>
  762. Sets the error state for the monitored item status.
  763. </summary>
  764. </member>
  765. <member name="T:Opc.Ua.Client.NodeCache">
  766. <summary>
  767. A client side cache of the server's type model.
  768. </summary>
  769. </member>
  770. <member name="M:Opc.Ua.Client.NodeCache.#ctor(Opc.Ua.Client.Session)">
  771. <summary>
  772. Initializes the object with default values.
  773. </summary>
  774. </member>
  775. <member name="P:Opc.Ua.Client.NodeCache.NamespaceUris">
  776. <summary cref="P:Opc.Ua.INodeTable.NamespaceUris" />
  777. </member>
  778. <member name="P:Opc.Ua.Client.NodeCache.ServerUris">
  779. <summary cref="P:Opc.Ua.INodeTable.ServerUris" />
  780. </member>
  781. <member name="P:Opc.Ua.Client.NodeCache.TypeTree">
  782. <summary cref="P:Opc.Ua.INodeTable.TypeTree" />
  783. </member>
  784. <member name="M:Opc.Ua.Client.NodeCache.Exists(Opc.Ua.ExpandedNodeId)">
  785. <summary cref="M:Opc.Ua.INodeTable.Exists(Opc.Ua.ExpandedNodeId)" />
  786. </member>
  787. <member name="M:Opc.Ua.Client.NodeCache.Find(Opc.Ua.ExpandedNodeId)">
  788. <summary cref="M:Opc.Ua.INodeTable.Find(Opc.Ua.ExpandedNodeId)" />
  789. </member>
  790. <member name="M:Opc.Ua.Client.NodeCache.Find(Opc.Ua.ExpandedNodeId,Opc.Ua.NodeId,System.Boolean,System.Boolean,Opc.Ua.QualifiedName)">
  791. <summary cref="M:Opc.Ua.INodeTable.Find(Opc.Ua.ExpandedNodeId,Opc.Ua.NodeId,System.Boolean,System.Boolean,Opc.Ua.QualifiedName)" />
  792. </member>
  793. <member name="M:Opc.Ua.Client.NodeCache.Find(Opc.Ua.ExpandedNodeId,Opc.Ua.NodeId,System.Boolean,System.Boolean)">
  794. <summary cref="M:Opc.Ua.INodeTable.Find(Opc.Ua.ExpandedNodeId,Opc.Ua.NodeId,System.Boolean,System.Boolean)" />
  795. </member>
  796. <member name="M:Opc.Ua.Client.NodeCache.IsKnown(Opc.Ua.ExpandedNodeId)">
  797. <summary>
  798. Determines whether a node id is a known type id.
  799. </summary>
  800. <param name="typeId">The type extended identifier.</param>
  801. <returns>
  802. <c>true</c> if the specified type id is known; otherwise, <c>false</c>.
  803. </returns>
  804. </member>
  805. <member name="M:Opc.Ua.Client.NodeCache.IsKnown(Opc.Ua.NodeId)">
  806. <summary>
  807. Determines whether a node id is a known type id.
  808. </summary>
  809. <param name="typeId">The type identifier.</param>
  810. <returns>
  811. <c>true</c> if the specified type id is known; otherwise, <c>false</c>.
  812. </returns>
  813. </member>
  814. <member name="M:Opc.Ua.Client.NodeCache.FindSuperType(Opc.Ua.ExpandedNodeId)">
  815. <summary>
  816. Returns the immediate supertype for the type.
  817. </summary>
  818. <param name="typeId">The extended type identifier.</param>
  819. <returns>
  820. A type identifier of the <paramref name="typeId "/>
  821. </returns>
  822. </member>
  823. <member name="M:Opc.Ua.Client.NodeCache.FindSuperType(Opc.Ua.NodeId)">
  824. <summary>
  825. Returns the immediate supertype for the type.
  826. </summary>
  827. <param name="typeId">The type identifier.</param>
  828. <returns>
  829. The immediate supertype idnetyfier for <paramref name="typeId"/>
  830. </returns>
  831. </member>
  832. <member name="M:Opc.Ua.Client.NodeCache.FindSubTypes(Opc.Ua.ExpandedNodeId)">
  833. <summary>
  834. Returns the immediate subtypes for the type.
  835. </summary>
  836. <param name="typeId">The extended type identifier.</param>
  837. <returns>
  838. List of type identifiers for <paramref name="typeId"/>
  839. </returns>
  840. </member>
  841. <member name="M:Opc.Ua.Client.NodeCache.IsTypeOf(Opc.Ua.ExpandedNodeId,Opc.Ua.ExpandedNodeId)">
  842. <summary>
  843. Determines whether a type is a subtype of another type.
  844. </summary>
  845. <param name="subTypeId">The subtype identifier.</param>
  846. <param name="superTypeId">The supertype identifier.</param>
  847. <returns>
  848. <c>true</c> if <paramref name="superTypeId"/> is supertype of <paramref name="subTypeId"/>; otherwise, <c>false</c>.
  849. </returns>
  850. </member>
  851. <member name="M:Opc.Ua.Client.NodeCache.IsTypeOf(Opc.Ua.NodeId,Opc.Ua.NodeId)">
  852. <summary>
  853. Determines whether a type is a subtype of another type.
  854. </summary>
  855. <param name="subTypeId">The subtype identifier.</param>
  856. <param name="superTypeId">The supertype identyfier.</param>
  857. <returns>
  858. <c>true</c> if <paramref name="superTypeId"/> is supertype of <paramref name="subTypeId"/>; otherwise, <c>false</c>.
  859. </returns>
  860. </member>
  861. <member name="M:Opc.Ua.Client.NodeCache.FindReferenceTypeName(Opc.Ua.NodeId)">
  862. <summary>
  863. Returns the qualified name for the reference type id.
  864. </summary>
  865. <param name="referenceTypeId">The reference type</param>
  866. <returns>
  867. A name qualified with a namespace for the reference <paramref name="referenceTypeId"/>.
  868. </returns>
  869. </member>
  870. <member name="M:Opc.Ua.Client.NodeCache.FindReferenceType(Opc.Ua.QualifiedName)">
  871. <summary>
  872. Returns the node identifier for the reference type with the specified browse name.
  873. </summary>
  874. <param name="browseName">Browse name of the reference.</param>
  875. <returns>
  876. The identifier for the <paramref name="browseName"/>
  877. </returns>
  878. </member>
  879. <member name="M:Opc.Ua.Client.NodeCache.IsEncodingOf(Opc.Ua.ExpandedNodeId,Opc.Ua.ExpandedNodeId)">
  880. <summary>
  881. Checks if the identifier <paramref name="encodingId"/> represents a that provides encodings
  882. for the <paramref name="datatypeId "/>.
  883. </summary>
  884. <param name="encodingId">The id the encoding node .</param>
  885. <param name="datatypeId">The id of the DataType node.</param>
  886. <returns>
  887. <c>true</c> if <paramref name="encodingId"/> is encoding of the <paramref name="datatypeId"/>; otherwise, <c>false</c>.
  888. </returns>
  889. </member>
  890. <member name="M:Opc.Ua.Client.NodeCache.IsEncodingFor(Opc.Ua.NodeId,Opc.Ua.ExtensionObject)">
  891. <summary>
  892. Determines if the value contained in an extension object <paramref name="value"/> matches the expected data type.
  893. </summary>
  894. <param name="expectedTypeId">The identifier of the expected type .</param>
  895. <param name="value">The value.</param>
  896. <returns>
  897. <c>true</c> if the value contained in an extension object <paramref name="value"/> matches the
  898. expected data type; otherwise, <c>false</c>.
  899. </returns>
  900. </member>
  901. <member name="M:Opc.Ua.Client.NodeCache.IsEncodingFor(Opc.Ua.NodeId,System.Object)">
  902. <summary>
  903. Determines if the value is an encoding of the <paramref name="value"/>
  904. </summary>
  905. <param name="expectedTypeId">The expected type id.</param>
  906. <param name="value">The value.</param>
  907. <returns>
  908. <c>true</c> the value is an encoding of the <paramref name="value"/>; otherwise, <c>false</c>.
  909. </returns>
  910. </member>
  911. <member name="M:Opc.Ua.Client.NodeCache.FindDataTypeId(Opc.Ua.ExpandedNodeId)">
  912. <summary>
  913. Returns the data type for the specified encoding.
  914. </summary>
  915. <param name="encodingId">The encoding id.</param>
  916. <returns></returns>
  917. </member>
  918. <member name="M:Opc.Ua.Client.NodeCache.FindDataTypeId(Opc.Ua.NodeId)">
  919. <summary>
  920. Returns the data type for the specified encoding.
  921. </summary>
  922. <param name="encodingId">The encoding id.</param>
  923. <returns>
  924. The data type for the <paramref name="encodingId"/>
  925. </returns>
  926. </member>
  927. <member name="M:Opc.Ua.Client.NodeCache.LoadUaDefinedTypes(Opc.Ua.ISystemContext)">
  928. <summary>
  929. Loads the UA defined types into the cache.
  930. </summary>
  931. <param name="context">The context.</param>
  932. </member>
  933. <member name="M:Opc.Ua.Client.NodeCache.Clear">
  934. <summary>
  935. Removes all nodes from the cache.
  936. </summary>
  937. </member>
  938. <member name="M:Opc.Ua.Client.NodeCache.FetchNode(Opc.Ua.ExpandedNodeId)">
  939. <summary>
  940. Fetches a node from the server and updates the cache.
  941. </summary>
  942. </member>
  943. <member name="M:Opc.Ua.Client.NodeCache.FetchSuperTypes(Opc.Ua.ExpandedNodeId)">
  944. <summary>
  945. Adds the supertypes of the node to the cache.
  946. </summary>
  947. </member>
  948. <member name="M:Opc.Ua.Client.NodeCache.FindReferences(Opc.Ua.ExpandedNodeId,Opc.Ua.NodeId,System.Boolean,System.Boolean)">
  949. <summary>
  950. Returns the references of the specified node that meet the criteria specified.
  951. </summary>
  952. </member>
  953. <member name="M:Opc.Ua.Client.NodeCache.GetDisplayText(Opc.Ua.INode)">
  954. <summary>
  955. Returns a display name for a node.
  956. </summary>
  957. </member>
  958. <member name="M:Opc.Ua.Client.NodeCache.GetDisplayText(Opc.Ua.ExpandedNodeId)">
  959. <summary>
  960. Returns a display name for a node.
  961. </summary>
  962. </member>
  963. <member name="M:Opc.Ua.Client.NodeCache.GetDisplayText(Opc.Ua.ReferenceDescription)">
  964. <summary>
  965. Returns a display name for the target of a reference.
  966. </summary>
  967. </member>
  968. <member name="M:Opc.Ua.Client.NodeCache.BuildBrowsePath(Opc.Ua.ILocalNode,System.Collections.Generic.IList{Opc.Ua.QualifiedName})">
  969. <summary>
  970. Builds the relative path from a type to a node.
  971. </summary>
  972. </member>
  973. <member name="T:Opc.Ua.Client.ReverseConnectManager">
  974. <summary>
  975. The implementation of a reverse connect client manager.
  976. </summary>
  977. <remarks>
  978. This reverse connect manager allows to register for reverse connections
  979. with various strategies:
  980. i) take any connection.
  981. ii) filter for a specific application Uri and Url scheme.
  982. iii) filter for the Url.
  983. Second, any filter can be combined with the Once or Always flag.
  984. </remarks>
  985. </member>
  986. <member name="F:Opc.Ua.Client.ReverseConnectManager.DefaultWaitTimeout">
  987. <summary>
  988. A default value for reverse hello configurations, if undefined.
  989. </summary>
  990. <remarks>
  991. This value is used as wait timeout if the value is undefined by a caller.
  992. </remarks>
  993. </member>
  994. <member name="T:Opc.Ua.Client.ReverseConnectManager.ReverseConnectManagerState">
  995. <summary>
  996. Internal state of the reverse connect manager.
  997. </summary>
  998. </member>
  999. <member name="T:Opc.Ua.Client.ReverseConnectManager.ReverseConnectHostState">
  1000. <summary>
  1001. Internal state of the reverse connect host.
  1002. </summary>
  1003. </member>
  1004. <member name="T:Opc.Ua.Client.ReverseConnectManager.ReverseConnectStrategy">
  1005. <summary>
  1006. Specify the strategy for the reverse connect registration.
  1007. </summary>
  1008. </member>
  1009. <member name="F:Opc.Ua.Client.ReverseConnectManager.ReverseConnectStrategy.Undefined">
  1010. <summary>
  1011. Undefined strategy, defaults to Once.
  1012. </summary>
  1013. </member>
  1014. <member name="F:Opc.Ua.Client.ReverseConnectManager.ReverseConnectStrategy.Once">
  1015. <summary>
  1016. Remove entry after reverse connect callback.
  1017. </summary>
  1018. </member>
  1019. <member name="F:Opc.Ua.Client.ReverseConnectManager.ReverseConnectStrategy.Always">
  1020. <summary>
  1021. Always callback on matching url or uri.
  1022. </summary>
  1023. </member>
  1024. <member name="F:Opc.Ua.Client.ReverseConnectManager.ReverseConnectStrategy.Any">
  1025. <summary>
  1026. Flag for masking any connection.
  1027. </summary>
  1028. </member>
  1029. <member name="F:Opc.Ua.Client.ReverseConnectManager.ReverseConnectStrategy.AnyOnce">
  1030. <summary>
  1031. Respond to any incoming reverse connection,
  1032. remove entry after reverse connect callback.
  1033. </summary>
  1034. </member>
  1035. <member name="F:Opc.Ua.Client.ReverseConnectManager.ReverseConnectStrategy.AnyAlways">
  1036. <summary>
  1037. Respond to any incoming reverse connection,
  1038. always callback.
  1039. </summary>
  1040. </member>
  1041. <member name="T:Opc.Ua.Client.ReverseConnectManager.ReverseConnectInfo">
  1042. <summary>
  1043. Entry for a client reverse connect registration.
  1044. </summary>
  1045. </member>
  1046. <member name="T:Opc.Ua.Client.ReverseConnectManager.Registration">
  1047. <summary>
  1048. Record to store information on a client
  1049. registration for a reverse connect event.
  1050. </summary>
  1051. </member>
  1052. <member name="M:Opc.Ua.Client.ReverseConnectManager.Registration.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,System.Uri,System.EventHandler{Opc.Ua.ConnectionWaitingEventArgs})">
  1053. <summary>
  1054. Register with the server certificate.
  1055. </summary>
  1056. <param name="serverCertificate"></param>
  1057. <param name="endpointUrl"></param>
  1058. <param name="onConnectionWaiting"></param>
  1059. </member>
  1060. <member name="M:Opc.Ua.Client.ReverseConnectManager.#ctor">
  1061. <summary>
  1062. Initializes the object with default values.
  1063. </summary>
  1064. </member>
  1065. <member name="M:Opc.Ua.Client.ReverseConnectManager.Dispose">
  1066. <summary>
  1067. Dispose implementation.
  1068. </summary>
  1069. </member>
  1070. <member name="M:Opc.Ua.Client.ReverseConnectManager.Dispose(System.Boolean)">
  1071. <summary>
  1072. An overrideable version of the Dispose.
  1073. </summary>
  1074. <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
  1075. </member>
  1076. <member name="M:Opc.Ua.Client.ReverseConnectManager.OnConfigurationChanged(System.Object,Opc.Ua.ConfigurationWatcherEventArgs)">
  1077. <summary>
  1078. Raised when the configuration changes.
  1079. </summary>
  1080. <param name="sender">The sender.</param>
  1081. <param name="args">The <see cref="T:Opc.Ua.ConfigurationWatcherEventArgs"/> instance containing the event data.</param>
  1082. </member>
  1083. <member name="M:Opc.Ua.Client.ReverseConnectManager.OnUpdateConfiguration(Opc.Ua.ApplicationConfiguration)">
  1084. <summary>
  1085. Called when the configuration is changed on disk.
  1086. </summary>
  1087. <param name="configuration">The configuration.</param>
  1088. </member>
  1089. <member name="M:Opc.Ua.Client.ReverseConnectManager.OnUpdateConfiguration(Opc.Ua.ReverseConnectClientConfiguration)">
  1090. <summary>
  1091. Called when the reverse connect configuration is changed.
  1092. </summary>
  1093. <remarks>
  1094. An empty configuration or null stops service on all configured endpoints.
  1095. </remarks>
  1096. <param name="configuration">The client endpoint configuration.</param>
  1097. </member>
  1098. <member name="M:Opc.Ua.Client.ReverseConnectManager.OpenHosts">
  1099. <summary>
  1100. Open host ports.
  1101. </summary>
  1102. </member>
  1103. <member name="M:Opc.Ua.Client.ReverseConnectManager.CloseHosts">
  1104. <summary>
  1105. Close host ports.
  1106. </summary>
  1107. </member>
  1108. <member name="M:Opc.Ua.Client.ReverseConnectManager.DisposeHosts">
  1109. <summary>
  1110. Dispose the hosts;
  1111. </summary>
  1112. </member>
  1113. <member name="M:Opc.Ua.Client.ReverseConnectManager.AddEndpoint(System.Uri)">
  1114. <summary>
  1115. Add endpoint for reverse connection.
  1116. </summary>
  1117. <param name="endpointUrl"></param>
  1118. </member>
  1119. <member name="M:Opc.Ua.Client.ReverseConnectManager.StartService(Opc.Ua.ApplicationConfiguration)">
  1120. <summary>
  1121. Starts the server application.
  1122. </summary>
  1123. <param name="configuration">The configuration.</param>
  1124. </member>
  1125. <member name="M:Opc.Ua.Client.ReverseConnectManager.StartService(Opc.Ua.ReverseConnectClientConfiguration)">
  1126. <summary>
  1127. Starts the server application.
  1128. </summary>
  1129. <param name="configuration">The configuration.</param>
  1130. </member>
  1131. <member name="M:Opc.Ua.Client.ReverseConnectManager.ClearWaitingConnections">
  1132. <summary>
  1133. Clears all waiting reverse connectino handlers.
  1134. </summary>
  1135. </member>
  1136. <member name="M:Opc.Ua.Client.ReverseConnectManager.WaitForConnection(System.Uri,System.String,System.Threading.CancellationToken)">
  1137. <summary>
  1138. Helper to wait for a reverse connection.
  1139. </summary>
  1140. <param name="endpointUrl"></param>
  1141. <param name="serverUri"></param>
  1142. <param name="ct"></param>
  1143. </member>
  1144. <member name="M:Opc.Ua.Client.ReverseConnectManager.RegisterWaitingConnection(System.Uri,System.String,System.EventHandler{Opc.Ua.ConnectionWaitingEventArgs},Opc.Ua.Client.ReverseConnectManager.ReverseConnectStrategy)">
  1145. <summary>
  1146. Register for a waiting reverse connection.
  1147. </summary>
  1148. <param name="endpointUrl">The endpoint Url of the reverse connection.</param>
  1149. <param name="serverUri">Optional. The server application Uri of the reverse connection.</param>
  1150. <param name="onConnectionWaiting">The callback</param>
  1151. <param name="reverseConnectStrategy">The reverse connect callback strategy.</param>
  1152. </member>
  1153. <member name="M:Opc.Ua.Client.ReverseConnectManager.UnregisterWaitingConnection(System.Int32)">
  1154. <summary>
  1155. Unregister reverse connection callback.
  1156. </summary>
  1157. <param name="hashCode">The hashcode returned by the registration.</param>
  1158. </member>
  1159. <member name="M:Opc.Ua.Client.ReverseConnectManager.StopService">
  1160. <summary>
  1161. Called before the server stops
  1162. </summary>
  1163. </member>
  1164. <member name="M:Opc.Ua.Client.ReverseConnectManager.StartService">
  1165. <summary>
  1166. Called to start hosting the reverse connect ports.
  1167. </summary>
  1168. </member>
  1169. <member name="M:Opc.Ua.Client.ReverseConnectManager.ClearEndpoints(System.Boolean)">
  1170. <summary>
  1171. Remove configuration endpoints from list.
  1172. </summary>
  1173. </member>
  1174. <member name="M:Opc.Ua.Client.ReverseConnectManager.AddEndpointInternal(System.Uri,System.Boolean)">
  1175. <summary>
  1176. Add endpoint for reverse connection.
  1177. </summary>
  1178. <param name="endpointUrl">The endpoint Url of the reverse connect client endpoint.</param>
  1179. <param name="configEntry">Tf this is an entry in the application configuration.</param>
  1180. </member>
  1181. <member name="M:Opc.Ua.Client.ReverseConnectManager.OnConnectionWaiting(System.Object,Opc.Ua.ConnectionWaitingEventArgs)">
  1182. <summary>
  1183. Raised when a reverse connection is waiting,
  1184. finds and calls a waiting connection.
  1185. </summary>
  1186. </member>
  1187. <member name="M:Opc.Ua.Client.ReverseConnectManager.MatchRegistration(System.Object,Opc.Ua.ConnectionWaitingEventArgs)">
  1188. <summary>
  1189. Match the waiting connection with a registration, callback registration,
  1190. return if connection is accepted in event.
  1191. </summary>
  1192. <returns>true if a match was found.</returns>
  1193. </member>
  1194. <member name="M:Opc.Ua.Client.ReverseConnectManager.OnConnectionStatusChanged(System.Object,Opc.Ua.ConnectionStatusEventArgs)">
  1195. <summary>
  1196. Raised when a connection status changes.
  1197. </summary>
  1198. </member>
  1199. <member name="M:Opc.Ua.Client.ReverseConnectManager.CancelAndRenewTokenSource">
  1200. <summary>
  1201. Renew the cancellation token after use.
  1202. </summary>
  1203. </member>
  1204. <member name="T:Opc.Ua.Client.Session">
  1205. <summary>
  1206. Manages a session with a server.
  1207. </summary>
  1208. </member>
  1209. <member name="M:Opc.Ua.Client.Session.#ctor(Opc.Ua.ISessionChannel,Opc.Ua.ApplicationConfiguration,Opc.Ua.ConfiguredEndpoint)">
  1210. <summary>
  1211. Constructs a new instance of the <see cref="T:Opc.Ua.Client.Session"/> class.
  1212. </summary>
  1213. <param name="channel">The channel used to communicate with the server.</param>
  1214. <param name="configuration">The configuration for the client application.</param>
  1215. <param name="endpoint">The endpoint use to initialize the channel.</param>
  1216. </member>
  1217. <member name="M:Opc.Ua.Client.Session.#ctor(Opc.Ua.ITransportChannel,Opc.Ua.ApplicationConfiguration,Opc.Ua.ConfiguredEndpoint,System.Security.Cryptography.X509Certificates.X509Certificate2,Opc.Ua.EndpointDescriptionCollection,Opc.Ua.StringCollection)">
  1218. <summary>
  1219. Constructs a new instance of the <see cref="T:Opc.Ua.Client.Session"/> class.
  1220. </summary>
  1221. <param name="channel">The channel used to communicate with the server.</param>
  1222. <param name="configuration">The configuration for the client application.</param>
  1223. <param name="endpoint">The endpoint used to initialize the channel.</param>
  1224. <param name="clientCertificate">The certificate to use for the client.</param>
  1225. <param name="availableEndpoints">The list of available endpoints returned by server in GetEndpoints() response.</param>
  1226. <param name="discoveryProfileUris">The value of profileUris used in GetEndpoints() request.</param>
  1227. <remarks>
  1228. The application configuration is used to look up the certificate if none is provided.
  1229. The clientCertificate must have the private key. This will require that the certificate
  1230. be loaded from a certicate store. Converting a DER encoded blob to a X509Certificate2
  1231. will not include a private key.
  1232. The <i>availableEndpoints</i> and <i>discoveryProfileUris</i> parameters are used to validate
  1233. that the list of EndpointDescriptions returned at GetEndpoints matches the list returned at CreateSession.
  1234. </remarks>
  1235. </member>
  1236. <member name="M:Opc.Ua.Client.Session.#ctor(Opc.Ua.ITransportChannel,Opc.Ua.Client.Session,System.Boolean)">
  1237. <summary>
  1238. Initializes a new instance of the <see cref="T:Opc.Ua.Client.Session"/> class.
  1239. </summary>
  1240. <param name="channel">The channel.</param>
  1241. <param name="template">The template session.</param>
  1242. <param name="copyEventHandlers">if set to <c>true</c> the event handlers are copied.</param>
  1243. </member>
  1244. <member name="M:Opc.Ua.Client.Session.Initialize(Opc.Ua.ITransportChannel,Opc.Ua.ApplicationConfiguration,Opc.Ua.ConfiguredEndpoint,System.Security.Cryptography.X509Certificates.X509Certificate2)">
  1245. <summary>
  1246. Initializes the channel.
  1247. </summary>
  1248. </member>
  1249. <member name="M:Opc.Ua.Client.Session.Initialize">
  1250. <summary>
  1251. Sets the object members to default values.
  1252. </summary>
  1253. </member>
  1254. <member name="M:Opc.Ua.Client.Session.ValidateClientConfiguration(Opc.Ua.ApplicationConfiguration)">
  1255. <summary>
  1256. Check if all required configuration fields are populated.
  1257. </summary>
  1258. </member>
  1259. <member name="M:Opc.Ua.Client.Session.ValidateServerNonce(Opc.Ua.IUserIdentity,System.Byte[],System.String,System.Byte[],Opc.Ua.MessageSecurityMode)">
  1260. <summary>
  1261. Validates the server nonce and security parameters of user identity.
  1262. </summary>
  1263. </member>
  1264. <member name="M:Opc.Ua.Client.Session.Dispose(System.Boolean)">
  1265. <summary>
  1266. Closes the session and the underlying channel.
  1267. </summary>
  1268. </member>
  1269. <member name="E:Opc.Ua.Client.Session.KeepAlive">
  1270. <summary>
  1271. Raised when a keep alive arrives from the server or an error is detected.
  1272. </summary>
  1273. <remarks>
  1274. Once a session is created a timer will periodically read the server state and current time.
  1275. If this read operation succeeds this event will be raised each time the keep alive period elapses.
  1276. If an error is detected (KeepAliveStopped == true) then this event will be raised as well.
  1277. </remarks>
  1278. </member>
  1279. <member name="E:Opc.Ua.Client.Session.Notification">
  1280. <summary>
  1281. Raised when a notification message arrives in a publish response.
  1282. </summary>
  1283. <remarks>
  1284. All publish requests are managed by the Session object. When a response arrives it is
  1285. validated and passed to the appropriate Subscription object and this event is raised.
  1286. </remarks>
  1287. </member>
  1288. <member name="E:Opc.Ua.Client.Session.PublishError">
  1289. <summary>
  1290. Raised when an exception occurs while processing a publish response.
  1291. </summary>
  1292. <remarks>
  1293. Exceptions in a publish response are not necessarily fatal and the Session will
  1294. attempt to recover by issuing Republish requests if missing messages are detected.
  1295. That said, timeout errors may be a symptom of a OperationTimeout that is too short
  1296. when compared to the shortest PublishingInterval/KeepAliveCount amount the current
  1297. Subscriptions. The OperationTimeout should be twice the minimum value for
  1298. PublishingInterval*KeepAliveCount.
  1299. </remarks>
  1300. </member>
  1301. <member name="E:Opc.Ua.Client.Session.SubscriptionsChanged">
  1302. <summary>
  1303. Raised when a subscription is added or removed
  1304. </summary>
  1305. </member>
  1306. <member name="E:Opc.Ua.Client.Session.SessionClosing">
  1307. <summary>
  1308. Raised to indicate the session is closing.
  1309. </summary>
  1310. </member>
  1311. <member name="P:Opc.Ua.Client.Session.ConfiguredEndpoint">
  1312. <summary>
  1313. Gets the endpoint used to connect to the server.
  1314. </summary>
  1315. </member>
  1316. <member name="P:Opc.Ua.Client.Session.SessionName">
  1317. <summary>
  1318. Gets the name assigned to the session.
  1319. </summary>
  1320. </member>
  1321. <member name="P:Opc.Ua.Client.Session.SessionTimeout">
  1322. <summary>
  1323. Gets the period for wich the server will maintain the session if there is no communication from the client.
  1324. </summary>
  1325. </member>
  1326. <member name="P:Opc.Ua.Client.Session.Handle">
  1327. <summary>
  1328. Gets the local handle assigned to the session
  1329. </summary>
  1330. </member>
  1331. <member name="P:Opc.Ua.Client.Session.Identity">
  1332. <summary>
  1333. Gets the user identity currently used for the session.
  1334. </summary>
  1335. </member>
  1336. <member name="P:Opc.Ua.Client.Session.IdentityHistory">
  1337. <summary>
  1338. Gets a list of user identities that can be used to connect to the server.
  1339. </summary>
  1340. </member>
  1341. <member name="P:Opc.Ua.Client.Session.NamespaceUris">
  1342. <summary>
  1343. Gets the table of namespace uris known to the server.
  1344. </summary>
  1345. </member>
  1346. <member name="P:Opc.Ua.Client.Session.ServerUris">
  1347. <summary>
  1348. Gest the table of remote server uris known to the server.
  1349. </summary>
  1350. </member>
  1351. <member name="P:Opc.Ua.Client.Session.SystemContext">
  1352. <summary>
  1353. Gets the system context for use with the session.
  1354. </summary>
  1355. </member>
  1356. <member name="P:Opc.Ua.Client.Session.Factory">
  1357. <summary>
  1358. Gets the factory used to create encodeable objects that the server understands.
  1359. </summary>
  1360. </member>
  1361. <member name="P:Opc.Ua.Client.Session.TypeTree">
  1362. <summary>
  1363. Gets the cache of the server's type tree.
  1364. </summary>
  1365. </member>
  1366. <member name="P:Opc.Ua.Client.Session.NodeCache">
  1367. <summary>
  1368. Gets the cache of nodes fetched from the server.
  1369. </summary>
  1370. </member>
  1371. <member name="P:Opc.Ua.Client.Session.FilterContext">
  1372. <summary>
  1373. Gets the context to use for filter operations.
  1374. </summary>
  1375. </member>
  1376. <member name="P:Opc.Ua.Client.Session.PreferredLocales">
  1377. <summary>
  1378. Gets the locales that the server should use when returning localized text.
  1379. </summary>
  1380. </member>
  1381. <member name="P:Opc.Ua.Client.Session.DataTypeSystem">
  1382. <summary>
  1383. Gets the data type system dictionaries in use.
  1384. </summary>
  1385. </member>
  1386. <member name="P:Opc.Ua.Client.Session.Subscriptions">
  1387. <summary>
  1388. Gets the subscriptions owned by the session.
  1389. </summary>
  1390. </member>
  1391. <member name="P:Opc.Ua.Client.Session.SubscriptionCount">
  1392. <summary>
  1393. Gets the number of subscriptions owned by the session.
  1394. </summary>
  1395. </member>
  1396. <member name="P:Opc.Ua.Client.Session.DefaultSubscription">
  1397. <summary>
  1398. Gets or Sets the default subscription for the session.
  1399. </summary>
  1400. </member>
  1401. <member name="P:Opc.Ua.Client.Session.KeepAliveInterval">
  1402. <summary>
  1403. Gets or Sets how frequently the server is pinged to see if communication is still working.
  1404. </summary>
  1405. <remarks>
  1406. This interval controls how much time elaspes before a communication error is detected.
  1407. If everything is ok the KeepAlive event will be raised each time this period elapses.
  1408. </remarks>
  1409. </member>
  1410. <member name="P:Opc.Ua.Client.Session.KeepAliveStopped">
  1411. <summary>
  1412. Returns true if the session is not receiving keep alives.
  1413. </summary>
  1414. <remarks>
  1415. Set to true if the server does not respond for 2 times the KeepAliveInterval.
  1416. Set to false is communication recovers.
  1417. </remarks>
  1418. </member>
  1419. <member name="P:Opc.Ua.Client.Session.LastKeepAliveTime">
  1420. <summary>
  1421. Gets the time of the last keep alive.
  1422. </summary>
  1423. </member>
  1424. <member name="P:Opc.Ua.Client.Session.OutstandingRequestCount">
  1425. <summary>
  1426. Gets the number of outstanding publish or keep alive requests.
  1427. </summary>
  1428. </member>
  1429. <member name="P:Opc.Ua.Client.Session.DefunctRequestCount">
  1430. <summary>
  1431. Gets the number of outstanding publish or keep alive requests which appear to be missing.
  1432. </summary>
  1433. </member>
  1434. <member name="P:Opc.Ua.Client.Session.GoodPublishRequestCount">
  1435. <summary>
  1436. Gets the number of good outstanding publish requests.
  1437. </summary>
  1438. </member>
  1439. <member name="M:Opc.Ua.Client.Session.Create(Opc.Ua.ApplicationConfiguration,Opc.Ua.ConfiguredEndpoint,System.Boolean,System.String,System.UInt32,Opc.Ua.IUserIdentity,System.Collections.Generic.IList{System.String})">
  1440. <summary>
  1441. Creates a new communication session with a server by invoking the CreateSession service
  1442. </summary>
  1443. <param name="configuration">The configuration for the client application.</param>
  1444. <param name="endpoint">The endpoint for the server.</param>
  1445. <param name="updateBeforeConnect">If set to <c>true</c> the discovery endpoint is used to update the endpoint description before connecting.</param>
  1446. <param name="sessionName">The name to assign to the session.</param>
  1447. <param name="sessionTimeout">The timeout period for the session.</param>
  1448. <param name="identity">The identity.</param>
  1449. <param name="preferredLocales">The user identity to associate with the session.</param>
  1450. <returns>The new session object</returns>
  1451. </member>
  1452. <member name="M:Opc.Ua.Client.Session.Create(Opc.Ua.ApplicationConfiguration,Opc.Ua.ConfiguredEndpoint,System.Boolean,System.Boolean,System.String,System.UInt32,Opc.Ua.IUserIdentity,System.Collections.Generic.IList{System.String})">
  1453. <summary>
  1454. Creates a new communication session with a server by invoking the CreateSession service
  1455. </summary>
  1456. <param name="configuration">The configuration for the client application.</param>
  1457. <param name="endpoint">The endpoint for the server.</param>
  1458. <param name="updateBeforeConnect">If set to <c>true</c> the discovery endpoint is used to update the endpoint description before connecting.</param>
  1459. <param name="checkDomain">If set to <c>true</c> then the domain in the certificate must match the endpoint used.</param>
  1460. <param name="sessionName">The name to assign to the session.</param>
  1461. <param name="sessionTimeout">The timeout period for the session.</param>
  1462. <param name="identity">The user identity to associate with the session.</param>
  1463. <param name="preferredLocales">The preferred locales.</param>
  1464. <returns>The new session object.</returns>
  1465. </member>
  1466. <member name="M:Opc.Ua.Client.Session.Create(Opc.Ua.ApplicationConfiguration,Opc.Ua.ITransportWaitingConnection,Opc.Ua.ConfiguredEndpoint,System.Boolean,System.Boolean,System.String,System.UInt32,Opc.Ua.IUserIdentity,System.Collections.Generic.IList{System.String})">
  1467. <summary>
  1468. Creates a new communication session with a server using a reverse connection.
  1469. </summary>
  1470. <param name="configuration">The configuration for the client application.</param>
  1471. <param name="connection">The client endpoint for the reverse connect.</param>
  1472. <param name="endpoint">The endpoint for the server.</param>
  1473. <param name="updateBeforeConnect">If set to <c>true</c> the discovery endpoint is used to update the endpoint description before connecting.</param>
  1474. <param name="checkDomain">If set to <c>true</c> then the domain in the certificate must match the endpoint used.</param>
  1475. <param name="sessionName">The name to assign to the session.</param>
  1476. <param name="sessionTimeout">The timeout period for the session.</param>
  1477. <param name="identity">The user identity to associate with the session.</param>
  1478. <param name="preferredLocales">The preferred locales.</param>
  1479. <returns>The new session object.</returns>
  1480. </member>
  1481. <member name="M:Opc.Ua.Client.Session.Create(Opc.Ua.ApplicationConfiguration,Opc.Ua.Client.ReverseConnectManager,Opc.Ua.ConfiguredEndpoint,System.Boolean,System.Boolean,System.String,System.UInt32,Opc.Ua.IUserIdentity,System.Collections.Generic.IList{System.String},System.Threading.CancellationToken)">
  1482. <summary>
  1483. Creates a new communication session with a server using a reverse connect manager.
  1484. </summary>
  1485. <param name="configuration">The configuration for the client application.</param>
  1486. <param name="reverseConnectManager">The reverse connect manager for the client connection.</param>
  1487. <param name="endpoint">The endpoint for the server.</param>
  1488. <param name="updateBeforeConnect">If set to <c>true</c> the discovery endpoint is used to update the endpoint description before connecting.</param>
  1489. <param name="checkDomain">If set to <c>true</c> then the domain in the certificate must match the endpoint used.</param>
  1490. <param name="sessionName">The name to assign to the session.</param>
  1491. <param name="sessionTimeout">The timeout period for the session.</param>
  1492. <param name="userIdentity">The user identity to associate with the session.</param>
  1493. <param name="preferredLocales">The preferred locales.</param>
  1494. <param name="ct">The cancellation token.</param>
  1495. <returns>The new session object.</returns>
  1496. </member>
  1497. <member name="M:Opc.Ua.Client.Session.Recreate(Opc.Ua.Client.Session)">
  1498. <summary>
  1499. Recreates a session based on a specified template.
  1500. </summary>
  1501. <param name="template">The Session object to use as template</param>
  1502. <returns>The new session object.</returns>
  1503. </member>
  1504. <member name="M:Opc.Ua.Client.Session.Recreate(Opc.Ua.Client.Session,Opc.Ua.ITransportWaitingConnection)">
  1505. <summary>
  1506. Recreates a session based on a specified template.
  1507. </summary>
  1508. <param name="template">The Session object to use as template</param>
  1509. <param name="connection">The waiting reverse connection.</param>
  1510. <returns>The new session object.</returns>
  1511. </member>
  1512. <member name="T:Opc.Ua.Client.Session.RenewUserIdentityEventHandler">
  1513. <summary>
  1514. Used to handle renews of user identity tokens before reconnect.
  1515. </summary>
  1516. </member>
  1517. <member name="E:Opc.Ua.Client.Session.RenewUserIdentity">
  1518. <summary>
  1519. Raised before a reconnect operation completes.
  1520. </summary>
  1521. </member>
  1522. <member name="M:Opc.Ua.Client.Session.Reconnect">
  1523. <summary>
  1524. Reconnects to the server after a network failure.
  1525. </summary>
  1526. </member>
  1527. <member name="M:Opc.Ua.Client.Session.Reconnect(Opc.Ua.ITransportWaitingConnection)">
  1528. <summary>
  1529. Reconnects to the server after a network failure using a waiting connection.
  1530. </summary>
  1531. </member>
  1532. <member name="M:Opc.Ua.Client.Session.Save(System.String)">
  1533. <summary>
  1534. Saves all the subscriptions of the session.
  1535. </summary>
  1536. <param name="filePath">The file path.</param>
  1537. </member>
  1538. <member name="M:Opc.Ua.Client.Session.Save(System.String,System.Collections.Generic.IEnumerable{Opc.Ua.Client.Subscription})">
  1539. <summary>
  1540. Saves a set of subscriptions.
  1541. </summary>
  1542. </member>
  1543. <member name="M:Opc.Ua.Client.Session.Load(System.String)">
  1544. <summary>
  1545. Load the list of subscriptions saved in a file.
  1546. </summary>
  1547. <param name="filePath">The file path.</param>
  1548. <returns>The list of loaded subscriptions</returns>
  1549. </member>
  1550. <member name="M:Opc.Ua.Client.Session.FetchNamespaceTables">
  1551. <summary>
  1552. Updates the local copy of the server's namespace uri and server uri tables.
  1553. </summary>
  1554. </member>
  1555. <member name="M:Opc.Ua.Client.Session.FetchTypeTree(Opc.Ua.ExpandedNodeId)">
  1556. <summary>
  1557. Updates the cache with the type and its subtypes.
  1558. </summary>
  1559. <remarks>
  1560. This method can be used to ensure the TypeTree is populated.
  1561. </remarks>
  1562. </member>
  1563. <member name="M:Opc.Ua.Client.Session.ReadAvailableEncodings(Opc.Ua.NodeId)">
  1564. <summary>
  1565. Returns the available encodings for a node
  1566. </summary>
  1567. <param name="variableId">The variable node.</param>
  1568. <returns></returns>
  1569. </member>
  1570. <member name="M:Opc.Ua.Client.Session.FindDataDescription(Opc.Ua.NodeId)">
  1571. <summary>
  1572. Returns the data description for the encoding.
  1573. </summary>
  1574. <param name="encodingId">The encoding Id.</param>
  1575. <returns></returns>
  1576. </member>
  1577. <member name="M:Opc.Ua.Client.Session.FindDataDictionary(Opc.Ua.NodeId)">
  1578. <summary>
  1579. Returns the data dictionary that contains the description.
  1580. </summary>
  1581. <param name="descriptionId">The description id.</param>
  1582. <returns></returns>
  1583. </member>
  1584. <member name="M:Opc.Ua.Client.Session.LoadDataDictionary(Opc.Ua.ReferenceDescription,System.Boolean)">
  1585. <summary>
  1586. Returns the data dictionary that contains the description.
  1587. </summary>
  1588. <param name="dictionaryNode">The dictionary id.</param>
  1589. <param name="forceReload"></param>
  1590. <returns>The dictionary.</returns>
  1591. </member>
  1592. <member name="M:Opc.Ua.Client.Session.LoadDataTypeSystem(Opc.Ua.NodeId)">
  1593. <summary>
  1594. Loads all dictionaries of the OPC binary or Xml schema type system.
  1595. </summary>
  1596. <param name="dataTypeSystem">The type system.</param>
  1597. <returns></returns>
  1598. </member>
  1599. <member name="M:Opc.Ua.Client.Session.ReadNode(Opc.Ua.NodeId)">
  1600. <summary>
  1601. Reads the values for the node attributes and returns a node object.
  1602. </summary>
  1603. <param name="nodeId">The nodeId.</param>
  1604. <returns></returns>
  1605. </member>
  1606. <member name="M:Opc.Ua.Client.Session.ReadValue(Opc.Ua.NodeId)">
  1607. <summary>
  1608. Reads the value for a node.
  1609. </summary>
  1610. <param name="nodeId">The node Id.</param>
  1611. <returns></returns>
  1612. </member>
  1613. <member name="M:Opc.Ua.Client.Session.ReadValue(Opc.Ua.NodeId,System.Type)">
  1614. <summary>
  1615. Reads the value for a node an checks that it is the specified type.
  1616. </summary>
  1617. <param name="nodeId">The node id.</param>
  1618. <param name="expectedType">The expected type.</param>
  1619. <returns></returns>
  1620. </member>
  1621. <member name="M:Opc.Ua.Client.Session.FetchReferences(Opc.Ua.NodeId)">
  1622. <summary>
  1623. Fetches all references for the specified node.
  1624. </summary>
  1625. <param name="nodeId">The node id.</param>
  1626. <returns></returns>
  1627. </member>
  1628. <member name="M:Opc.Ua.Client.Session.Open(System.String,Opc.Ua.IUserIdentity)">
  1629. <summary>
  1630. Establishes a session with the server.
  1631. </summary>
  1632. <param name="sessionName">The name to assign to the session.</param>
  1633. <param name="identity">The user identity.</param>
  1634. </member>
  1635. <member name="M:Opc.Ua.Client.Session.Open(System.String,System.UInt32,Opc.Ua.IUserIdentity,System.Collections.Generic.IList{System.String})">
  1636. <summary>
  1637. Establishes a session with the server.
  1638. </summary>
  1639. <param name="sessionName">The name to assign to the session.</param>
  1640. <param name="sessionTimeout">The session timeout.</param>
  1641. <param name="identity">The user identity.</param>
  1642. <param name="preferredLocales">The list of preferred locales.</param>
  1643. </member>
  1644. <member name="M:Opc.Ua.Client.Session.Open(System.String,System.UInt32,Opc.Ua.IUserIdentity,System.Collections.Generic.IList{System.String},System.Boolean)">
  1645. <summary>
  1646. Establishes a session with the server.
  1647. </summary>
  1648. <param name="sessionName">The name to assign to the session.</param>
  1649. <param name="sessionTimeout">The session timeout.</param>
  1650. <param name="identity">The user identity.</param>
  1651. <param name="preferredLocales">The list of preferred locales.</param>
  1652. <param name="checkDomain">If set to <c>true</c> then the domain in the certificate must match the endpoint used.</param>
  1653. </member>
  1654. <member name="M:Opc.Ua.Client.Session.ChangePreferredLocales(Opc.Ua.StringCollection)">
  1655. <summary>
  1656. Updates the preferred locales used for the session.
  1657. </summary>
  1658. <param name="preferredLocales">The preferred locales.</param>
  1659. </member>
  1660. <member name="M:Opc.Ua.Client.Session.UpdateSession(Opc.Ua.IUserIdentity,Opc.Ua.StringCollection)">
  1661. <summary>
  1662. Updates the user identity and/or locales used for the session.
  1663. </summary>
  1664. <param name="identity">The user identity.</param>
  1665. <param name="preferredLocales">The preferred locales.</param>
  1666. </member>
  1667. <member name="M:Opc.Ua.Client.Session.FindComponentIds(Opc.Ua.NodeId,System.Collections.Generic.IList{System.String},Opc.Ua.NodeIdCollection@,System.Collections.Generic.List{Opc.Ua.ServiceResult}@)">
  1668. <summary>
  1669. Finds the NodeIds for the components for an instance.
  1670. </summary>
  1671. </member>
  1672. <member name="M:Opc.Ua.Client.Session.ReadValues(System.Collections.Generic.IList{Opc.Ua.NodeId},System.Collections.Generic.IList{System.Type},System.Collections.Generic.List{System.Object}@,System.Collections.Generic.List{Opc.Ua.ServiceResult}@)">
  1673. <summary>
  1674. Reads the values for a set of variables.
  1675. </summary>
  1676. <param name="variableIds">The variable ids.</param>
  1677. <param name="expectedTypes">The expected types.</param>
  1678. <param name="values">The list of returned values.</param>
  1679. <param name="errors">The list of returned errors.</param>
  1680. </member>
  1681. <member name="M:Opc.Ua.Client.Session.ReadDisplayName(System.Collections.Generic.IList{Opc.Ua.NodeId},System.Collections.Generic.List{System.String}@,System.Collections.Generic.List{Opc.Ua.ServiceResult}@)">
  1682. <summary>
  1683. Reads the display name for a set of Nodes.
  1684. </summary>
  1685. </member>
  1686. <member name="M:Opc.Ua.Client.Session.Close">
  1687. <summary>
  1688. Disconnects from the server and frees any network resources.
  1689. </summary>
  1690. </member>
  1691. <member name="M:Opc.Ua.Client.Session.Close(System.Int32)">
  1692. <summary>
  1693. Disconnects from the server and frees any network resources with the specified timeout.
  1694. </summary>
  1695. </member>
  1696. <member name="M:Opc.Ua.Client.Session.AddSubscription(Opc.Ua.Client.Subscription)">
  1697. <summary>
  1698. Adds a subscription to the session.
  1699. </summary>
  1700. <param name="subscription">The subscription to add.</param>
  1701. <returns></returns>
  1702. </member>
  1703. <member name="M:Opc.Ua.Client.Session.RemoveSubscription(Opc.Ua.Client.Subscription)">
  1704. <summary>
  1705. Removes a subscription from the session.
  1706. </summary>
  1707. <param name="subscription">The subscription to remove.</param>
  1708. <returns></returns>
  1709. </member>
  1710. <member name="M:Opc.Ua.Client.Session.RemoveSubscriptions(System.Collections.Generic.IEnumerable{Opc.Ua.Client.Subscription})">
  1711. <summary>
  1712. Removes a list of subscriptions from the sessiont.
  1713. </summary>
  1714. <param name="subscriptions">The list of subscriptions to remove.</param>
  1715. <returns></returns>
  1716. </member>
  1717. <member name="M:Opc.Ua.Client.Session.Browse(Opc.Ua.RequestHeader,Opc.Ua.ViewDescription,Opc.Ua.NodeId,System.UInt32,Opc.Ua.BrowseDirection,Opc.Ua.NodeId,System.Boolean,System.UInt32,System.Byte[]@,Opc.Ua.ReferenceDescriptionCollection@)">
  1718. <summary>
  1719. Invokes the Browse service.
  1720. </summary>
  1721. <param name="requestHeader">The request header.</param>
  1722. <param name="view">The view to browse.</param>
  1723. <param name="nodeToBrowse">The node to browse.</param>
  1724. <param name="maxResultsToReturn">The maximum number of returned values.</param>
  1725. <param name="browseDirection">The browse direction.</param>
  1726. <param name="referenceTypeId">The reference type id.</param>
  1727. <param name="includeSubtypes">If set to <c>true</c> the subtypes of the ReferenceType will be included in the browse.</param>
  1728. <param name="nodeClassMask">The node class mask.</param>
  1729. <param name="continuationPoint">The continuation point.</param>
  1730. <param name="references">The list of node references.</param>
  1731. <returns></returns>
  1732. </member>
  1733. <member name="M:Opc.Ua.Client.Session.BeginBrowse(Opc.Ua.RequestHeader,Opc.Ua.ViewDescription,Opc.Ua.NodeId,System.UInt32,Opc.Ua.BrowseDirection,Opc.Ua.NodeId,System.Boolean,System.UInt32,System.AsyncCallback,System.Object)">
  1734. <summary>
  1735. Begins an asynchronous invocation of the Browse service.
  1736. </summary>
  1737. <param name="requestHeader">The request header.</param>
  1738. <param name="view">The view to browse.</param>
  1739. <param name="nodeToBrowse">The node to browse.</param>
  1740. <param name="maxResultsToReturn">The maximum number of returned values..</param>
  1741. <param name="browseDirection">The browse direction.</param>
  1742. <param name="referenceTypeId">The reference type id.</param>
  1743. <param name="includeSubtypes">If set to <c>true</c> the subtypes of the ReferenceType will be included in the browse.</param>
  1744. <param name="nodeClassMask">The node class mask.</param>
  1745. <param name="callback">The callback.</param>
  1746. <param name="asyncState"></param>
  1747. <returns></returns>
  1748. </member>
  1749. <member name="M:Opc.Ua.Client.Session.EndBrowse(System.IAsyncResult,System.Byte[]@,Opc.Ua.ReferenceDescriptionCollection@)">
  1750. <summary>
  1751. Finishes an asynchronous invocation of the Browse service.
  1752. </summary>
  1753. <param name="result">The result.</param>
  1754. <param name="continuationPoint">The continuation point.</param>
  1755. <param name="references">The list of node references.</param>
  1756. <returns></returns>
  1757. </member>
  1758. <member name="M:Opc.Ua.Client.Session.BrowseNext(Opc.Ua.RequestHeader,System.Boolean,System.Byte[],System.Byte[]@,Opc.Ua.ReferenceDescriptionCollection@)">
  1759. <summary>
  1760. Invokes the BrowseNext service.
  1761. </summary>
  1762. </member>
  1763. <member name="M:Opc.Ua.Client.Session.BeginBrowseNext(Opc.Ua.RequestHeader,System.Boolean,System.Byte[],System.AsyncCallback,System.Object)">
  1764. <summary>
  1765. Begins an asynchronous invocation of the BrowseNext service.
  1766. </summary>
  1767. </member>
  1768. <member name="M:Opc.Ua.Client.Session.EndBrowseNext(System.IAsyncResult,System.Byte[]@,Opc.Ua.ReferenceDescriptionCollection@)">
  1769. <summary>
  1770. Finishes an asynchronous invocation of the BrowseNext service.
  1771. </summary>
  1772. </member>
  1773. <member name="M:Opc.Ua.Client.Session.Call(Opc.Ua.NodeId,Opc.Ua.NodeId,System.Object[])">
  1774. <summary>
  1775. Calls the specified method and returns the output arguments.
  1776. </summary>
  1777. <param name="objectId">The NodeId of the object that provides the method.</param>
  1778. <param name="methodId">The NodeId of the method to call.</param>
  1779. <param name="args">The input arguments.</param>
  1780. <returns>The list of output argument values.</returns>
  1781. </member>
  1782. <member name="M:Opc.Ua.Client.Session.GetSoftwareCertificates">
  1783. <summary>
  1784. Returns the software certificates assigned to the application.
  1785. </summary>
  1786. </member>
  1787. <member name="M:Opc.Ua.Client.Session.OnApplicationCertificateError(System.Byte[],Opc.Ua.ServiceResult)">
  1788. <summary>
  1789. Handles an error when validating the application instance certificate provided by the server.
  1790. </summary>
  1791. </member>
  1792. <member name="M:Opc.Ua.Client.Session.OnSoftwareCertificateError(Opc.Ua.SignedSoftwareCertificate,Opc.Ua.ServiceResult)">
  1793. <summary>
  1794. Handles an error when validating software certificates provided by the server.
  1795. </summary>
  1796. </member>
  1797. <member name="M:Opc.Ua.Client.Session.ValidateSoftwareCertificates(System.Collections.Generic.List{Opc.Ua.SoftwareCertificate})">
  1798. <summary>
  1799. Inspects the software certificates provided by the server.
  1800. </summary>
  1801. </member>
  1802. <member name="M:Opc.Ua.Client.Session.StartKeepAliveTimer">
  1803. <summary>
  1804. Starts a timer to check that the connection to the server is still available.
  1805. </summary>
  1806. </member>
  1807. <member name="M:Opc.Ua.Client.Session.RemoveRequest(System.IAsyncResult,System.UInt32,System.UInt32)">
  1808. <summary>
  1809. Removes a completed async request.
  1810. </summary>
  1811. </member>
  1812. <member name="M:Opc.Ua.Client.Session.AsyncRequestStarted(System.IAsyncResult,System.UInt32,System.UInt32)">
  1813. <summary>
  1814. Adds a new async request.
  1815. </summary>
  1816. </member>
  1817. <member name="M:Opc.Ua.Client.Session.AsyncRequestCompleted(System.IAsyncResult,System.UInt32,System.UInt32)">
  1818. <summary>
  1819. Removes a completed async request.
  1820. </summary>
  1821. </member>
  1822. <member name="M:Opc.Ua.Client.Session.OnKeepAlive(System.Object)">
  1823. <summary>
  1824. Sends a keep alive by reading from the server.
  1825. </summary>
  1826. </member>
  1827. <member name="M:Opc.Ua.Client.Session.OnKeepAliveComplete(System.IAsyncResult)">
  1828. <summary>
  1829. Checks if a notification has arrived. Sends a publish if it has not.
  1830. </summary>
  1831. </member>
  1832. <member name="M:Opc.Ua.Client.Session.OnKeepAlive(Opc.Ua.ServerState,System.DateTime)">
  1833. <summary>
  1834. Called when the server returns a keep alive response.
  1835. </summary>
  1836. </member>
  1837. <member name="M:Opc.Ua.Client.Session.OnKeepAliveError(Opc.Ua.ServiceResult)">
  1838. <summary>
  1839. Called when a error occurs during a keep alive.
  1840. </summary>
  1841. </member>
  1842. <member name="M:Opc.Ua.Client.Session.BeginPublish(System.Int32)">
  1843. <summary>
  1844. Sends an additional publish request.
  1845. </summary>
  1846. </member>
  1847. <member name="M:Opc.Ua.Client.Session.OnPublishComplete(System.IAsyncResult)">
  1848. <summary>
  1849. Completes an asynchronous publish operation.
  1850. </summary>
  1851. </member>
  1852. <member name="M:Opc.Ua.Client.Session.Republish(System.UInt32,System.UInt32)">
  1853. <summary>
  1854. Sends a republish request.
  1855. </summary>
  1856. </member>
  1857. <member name="M:Opc.Ua.Client.Session.ProcessPublishResponse(Opc.Ua.ResponseHeader,System.UInt32,Opc.Ua.UInt32Collection,System.Boolean,Opc.Ua.NotificationMessage)">
  1858. <summary>
  1859. Processes the response from a publish request.
  1860. </summary>
  1861. </member>
  1862. <member name="M:Opc.Ua.Client.Session.OnRaisePublishNotification(System.Object)">
  1863. <summary>
  1864. Raises an event indicating that publish has returned a notification.
  1865. </summary>
  1866. </member>
  1867. <member name="M:Opc.Ua.Client.Session.DeleteSubscription(System.UInt32)">
  1868. <summary>
  1869. Invokes a DeleteSubscriptions call for the specified subscriptionId.
  1870. </summary>
  1871. </member>
  1872. <member name="M:Opc.Ua.Client.Session.LoadCertificate(Opc.Ua.ApplicationConfiguration)">
  1873. <summary>
  1874. Load certificate chain for connection.
  1875. </summary>
  1876. </member>
  1877. <member name="M:Opc.Ua.Client.Session.LoadCertificateChain(Opc.Ua.ApplicationConfiguration,System.Security.Cryptography.X509Certificates.X509Certificate2)">
  1878. <summary>
  1879. Load certificate chain for connection.
  1880. </summary>
  1881. </member>
  1882. <member name="T:Opc.Ua.Client.KeepAliveEventArgs">
  1883. <summary>
  1884. The event arguments provided when a keep alive response arrives.
  1885. </summary>
  1886. </member>
  1887. <member name="M:Opc.Ua.Client.KeepAliveEventArgs.#ctor(Opc.Ua.ServiceResult,Opc.Ua.ServerState,System.DateTime)">
  1888. <summary>
  1889. Creates a new instance.
  1890. </summary>
  1891. </member>
  1892. <member name="P:Opc.Ua.Client.KeepAliveEventArgs.Status">
  1893. <summary>
  1894. Gets the status associated with the keep alive operation.
  1895. </summary>
  1896. </member>
  1897. <member name="P:Opc.Ua.Client.KeepAliveEventArgs.CurrentState">
  1898. <summary>
  1899. Gets the current server state.
  1900. </summary>
  1901. </member>
  1902. <member name="P:Opc.Ua.Client.KeepAliveEventArgs.CurrentTime">
  1903. <summary>
  1904. Gets the current server time.
  1905. </summary>
  1906. </member>
  1907. <member name="P:Opc.Ua.Client.KeepAliveEventArgs.CancelKeepAlive">
  1908. <summary>
  1909. Gets or sets a flag indicating whether the session should send another keep alive.
  1910. </summary>
  1911. </member>
  1912. <member name="T:Opc.Ua.Client.KeepAliveEventHandler">
  1913. <summary>
  1914. The delegate used to receive keep alive notifications.
  1915. </summary>
  1916. </member>
  1917. <member name="T:Opc.Ua.Client.NotificationEventArgs">
  1918. <summary>
  1919. Represents the event arguments provided when a new notification message arrives.
  1920. </summary>
  1921. </member>
  1922. <member name="M:Opc.Ua.Client.NotificationEventArgs.#ctor(Opc.Ua.Client.Subscription,Opc.Ua.NotificationMessage,System.Collections.Generic.IList{System.String})">
  1923. <summary>
  1924. Creates a new instance.
  1925. </summary>
  1926. </member>
  1927. <member name="P:Opc.Ua.Client.NotificationEventArgs.Subscription">
  1928. <summary>
  1929. Gets the subscription that the notification applies to.
  1930. </summary>
  1931. </member>
  1932. <member name="P:Opc.Ua.Client.NotificationEventArgs.NotificationMessage">
  1933. <summary>
  1934. Gets the notification message.
  1935. </summary>
  1936. </member>
  1937. <member name="P:Opc.Ua.Client.NotificationEventArgs.StringTable">
  1938. <summary>
  1939. Gets the string table returned with the notification message.
  1940. </summary>
  1941. </member>
  1942. <member name="T:Opc.Ua.Client.NotificationEventHandler">
  1943. <summary>
  1944. The delegate used to receive publish notifications.
  1945. </summary>
  1946. </member>
  1947. <member name="T:Opc.Ua.Client.PublishErrorEventArgs">
  1948. <summary>
  1949. Represents the event arguments provided when a publish error occurs.
  1950. </summary>
  1951. </member>
  1952. <member name="M:Opc.Ua.Client.PublishErrorEventArgs.#ctor(Opc.Ua.ServiceResult)">
  1953. <summary>
  1954. Creates a new instance.
  1955. </summary>
  1956. </member>
  1957. <member name="M:Opc.Ua.Client.PublishErrorEventArgs.#ctor(Opc.Ua.ServiceResult,System.UInt32,System.UInt32)">
  1958. <summary>
  1959. Creates a new instance.
  1960. </summary>
  1961. </member>
  1962. <member name="P:Opc.Ua.Client.PublishErrorEventArgs.Status">
  1963. <summary>
  1964. Gets the status associated with the keep alive operation.
  1965. </summary>
  1966. </member>
  1967. <member name="P:Opc.Ua.Client.PublishErrorEventArgs.SubscriptionId">
  1968. <summary>
  1969. Gets the subscription with the message that could not be republished.
  1970. </summary>
  1971. </member>
  1972. <member name="P:Opc.Ua.Client.PublishErrorEventArgs.SequenceNumber">
  1973. <summary>
  1974. Gets the sequence number for the message that could not be republished.
  1975. </summary>
  1976. </member>
  1977. <member name="T:Opc.Ua.Client.PublishErrorEventHandler">
  1978. <summary>
  1979. The delegate used to receive pubish error notifications.
  1980. </summary>
  1981. </member>
  1982. <member name="T:Opc.Ua.Client.SessionReconnectHandler">
  1983. <summary>
  1984. Attempts to reconnect to the server.
  1985. </summary>
  1986. </member>
  1987. <member name="M:Opc.Ua.Client.SessionReconnectHandler.Dispose">
  1988. <summary>
  1989. Frees any unmanaged resources.
  1990. </summary>
  1991. </member>
  1992. <member name="M:Opc.Ua.Client.SessionReconnectHandler.Dispose(System.Boolean)">
  1993. <summary>
  1994. An overrideable version of the Dispose.
  1995. </summary>
  1996. </member>
  1997. <member name="P:Opc.Ua.Client.SessionReconnectHandler.Session">
  1998. <summary>
  1999. Gets the session managed by the handler.
  2000. </summary>
  2001. <value>The session.</value>
  2002. </member>
  2003. <member name="M:Opc.Ua.Client.SessionReconnectHandler.BeginReconnect(Opc.Ua.Client.Session,System.Int32,System.EventHandler)">
  2004. <summary>
  2005. Begins the reconnect process.
  2006. </summary>
  2007. </member>
  2008. <member name="M:Opc.Ua.Client.SessionReconnectHandler.BeginReconnect(Opc.Ua.Client.Session,Opc.Ua.Client.ReverseConnectManager,System.Int32,System.EventHandler)">
  2009. <summary>
  2010. Begins the reconnect process using a reverse connection.
  2011. </summary>
  2012. </member>
  2013. <member name="M:Opc.Ua.Client.SessionReconnectHandler.OnReconnect(System.Object)">
  2014. <summary>
  2015. Called when the reconnect timer expires.
  2016. </summary>
  2017. </member>
  2018. <member name="M:Opc.Ua.Client.SessionReconnectHandler.DoReconnect">
  2019. <summary>
  2020. Reconnects to the server.
  2021. </summary>
  2022. </member>
  2023. <member name="T:Opc.Ua.Client.Subscription">
  2024. <summary>
  2025. A subscription
  2026. </summary>
  2027. </member>
  2028. <member name="M:Opc.Ua.Client.Subscription.#ctor">
  2029. <summary>
  2030. Creates a empty object.
  2031. </summary>
  2032. </member>
  2033. <member name="M:Opc.Ua.Client.Subscription.#ctor(Opc.Ua.Client.Subscription)">
  2034. <summary>
  2035. Initializes the subscription from a template.
  2036. </summary>
  2037. </member>
  2038. <member name="M:Opc.Ua.Client.Subscription.#ctor(Opc.Ua.Client.Subscription,System.Boolean)">
  2039. <summary>
  2040. Initializes the subscription from a template.
  2041. </summary>
  2042. <param name="template">The template.</param>
  2043. <param name="copyEventHandlers">if set to <c>true</c> the event handlers are copied.</param>
  2044. </member>
  2045. <member name="M:Opc.Ua.Client.Subscription.Initialize(System.Runtime.Serialization.StreamingContext)">
  2046. <summary>
  2047. Called by the .NET framework during deserialization.
  2048. </summary>
  2049. </member>
  2050. <member name="M:Opc.Ua.Client.Subscription.Initialize">
  2051. <summary>
  2052. Sets the private members to default values.
  2053. </summary>
  2054. </member>
  2055. <member name="M:Opc.Ua.Client.Subscription.Dispose">
  2056. <summary>
  2057. Frees any unmanaged resources.
  2058. </summary>
  2059. </member>
  2060. <member name="M:Opc.Ua.Client.Subscription.Dispose(System.Boolean)">
  2061. <summary>
  2062. An overrideable version of the Dispose.
  2063. </summary>
  2064. </member>
  2065. <member name="E:Opc.Ua.Client.Subscription.StateChanged">
  2066. <summary>
  2067. Raised to indicate that the state of the subscription has changed.
  2068. </summary>
  2069. </member>
  2070. <member name="E:Opc.Ua.Client.Subscription.PublishStatusChanged">
  2071. <summary>
  2072. Raised to indicate the publishing state for the subscription has stopped or resumed (see PublishingStopped property).
  2073. </summary>
  2074. </member>
  2075. <member name="P:Opc.Ua.Client.Subscription.DisplayName">
  2076. <summary>
  2077. A display name for the subscription.
  2078. </summary>
  2079. </member>
  2080. <member name="P:Opc.Ua.Client.Subscription.PublishingInterval">
  2081. <summary>
  2082. The publishing interval.
  2083. </summary>
  2084. </member>
  2085. <member name="P:Opc.Ua.Client.Subscription.KeepAliveCount">
  2086. <summary>
  2087. The keep alive count.
  2088. </summary>
  2089. </member>
  2090. <member name="P:Opc.Ua.Client.Subscription.LifetimeCount">
  2091. <summary>
  2092. The maximum number of notifications per publish request.
  2093. </summary>
  2094. </member>
  2095. <member name="P:Opc.Ua.Client.Subscription.MaxNotificationsPerPublish">
  2096. <summary>
  2097. The maximum number of notifications per publish request.
  2098. </summary>
  2099. </member>
  2100. <member name="P:Opc.Ua.Client.Subscription.PublishingEnabled">
  2101. <summary>
  2102. Whether publishing is enabled.
  2103. </summary>
  2104. </member>
  2105. <member name="P:Opc.Ua.Client.Subscription.Priority">
  2106. <summary>
  2107. The priority assigned to subscription.
  2108. </summary>
  2109. </member>
  2110. <member name="P:Opc.Ua.Client.Subscription.TimestampsToReturn">
  2111. <summary>
  2112. The timestamps to return with the notification messages.
  2113. </summary>
  2114. </member>
  2115. <member name="P:Opc.Ua.Client.Subscription.MaxMessageCount">
  2116. <summary>
  2117. The maximum number of messages to keep in the internal cache.
  2118. </summary>
  2119. </member>
  2120. <member name="P:Opc.Ua.Client.Subscription.DefaultItem">
  2121. <summary>
  2122. The default monitored item.
  2123. </summary>
  2124. </member>
  2125. <member name="P:Opc.Ua.Client.Subscription.MinLifetimeInterval">
  2126. <summary>
  2127. The minimum lifetime for subscriptions in milliseconds.
  2128. </summary>
  2129. </member>
  2130. <member name="P:Opc.Ua.Client.Subscription.DisableMonitoredItemCache">
  2131. <summary>
  2132. Gets or sets a value indicating whether the notifications are cached within the monitored items.
  2133. </summary>
  2134. <value>
  2135. <c>true</c> if monitored item cache is disabled; otherwise, <c>false</c>.
  2136. </value>
  2137. <remarks>
  2138. Applications must process the Session.Notication event if this is set to true.
  2139. This flag improves performance by eliminating the processing involved in updating the cache.
  2140. </remarks>
  2141. </member>
  2142. <member name="P:Opc.Ua.Client.Subscription.FastDataChangeCallback">
  2143. <summary>
  2144. Gets or sets the fast data change callback.
  2145. </summary>
  2146. <value>The fast data change callback.</value>
  2147. <remarks>
  2148. Only one callback is allowed at a time but it is more efficient to call than an event.
  2149. </remarks>
  2150. </member>
  2151. <member name="P:Opc.Ua.Client.Subscription.FastEventCallback">
  2152. <summary>
  2153. Gets or sets the fast event callback.
  2154. </summary>
  2155. <value>The fast event callback.</value>
  2156. <remarks>
  2157. Only one callback is allowed at a time but it is more efficient to call than an event.
  2158. </remarks>
  2159. </member>
  2160. <member name="P:Opc.Ua.Client.Subscription.MonitoredItems">
  2161. <summary>
  2162. The items to monitor.
  2163. </summary>
  2164. </member>
  2165. <member name="P:Opc.Ua.Client.Subscription.SavedMonitoredItems">
  2166. <summary>
  2167. Allows the list of monitored items to be saved/restored when the object is serialized.
  2168. </summary>
  2169. </member>
  2170. <member name="P:Opc.Ua.Client.Subscription.ChangesPending">
  2171. <summary>
  2172. Returns true if the subscription has changes that need to be applied.
  2173. </summary>
  2174. </member>
  2175. <member name="P:Opc.Ua.Client.Subscription.MonitoredItemCount">
  2176. <summary>
  2177. Returns the number of monitored items.
  2178. </summary>
  2179. </member>
  2180. <member name="P:Opc.Ua.Client.Subscription.Session">
  2181. <summary>
  2182. The session that owns the subscription item.
  2183. </summary>
  2184. </member>
  2185. <member name="P:Opc.Ua.Client.Subscription.Handle">
  2186. <summary>
  2187. A local handle assigned to the subscription
  2188. </summary>
  2189. </member>
  2190. <member name="P:Opc.Ua.Client.Subscription.Id">
  2191. <summary>
  2192. The unique identifier assigned by the server.
  2193. </summary>
  2194. </member>
  2195. <member name="P:Opc.Ua.Client.Subscription.Created">
  2196. <summary>
  2197. Whether the subscription has been created on the server.
  2198. </summary>
  2199. </member>
  2200. <member name="P:Opc.Ua.Client.Subscription.CurrentPublishingInterval">
  2201. <summary>
  2202. The current publishing interval.
  2203. </summary>
  2204. </member>
  2205. <member name="P:Opc.Ua.Client.Subscription.CurrentKeepAliveCount">
  2206. <summary>
  2207. The current keep alive count.
  2208. </summary>
  2209. </member>
  2210. <member name="P:Opc.Ua.Client.Subscription.CurrentLifetimeCount">
  2211. <summary>
  2212. The current lifetime count.
  2213. </summary>
  2214. </member>
  2215. <member name="P:Opc.Ua.Client.Subscription.CurrentPublishingEnabled">
  2216. <summary>
  2217. Whether publishing is currently enabled.
  2218. </summary>
  2219. </member>
  2220. <member name="P:Opc.Ua.Client.Subscription.CurrentPriority">
  2221. <summary>
  2222. The priority assigned to subscription when it was created.
  2223. </summary>
  2224. </member>
  2225. <member name="P:Opc.Ua.Client.Subscription.PublishTime">
  2226. <summary>
  2227. The when that the last notification received was published.
  2228. </summary>
  2229. </member>
  2230. <member name="P:Opc.Ua.Client.Subscription.LastNotificationTime">
  2231. <summary>
  2232. The when that the last notification was received.
  2233. </summary>
  2234. </member>
  2235. <member name="P:Opc.Ua.Client.Subscription.SequenceNumber">
  2236. <summary>
  2237. The sequence number assigned to the last notification message.
  2238. </summary>
  2239. </member>
  2240. <member name="P:Opc.Ua.Client.Subscription.NotificationCount">
  2241. <summary>
  2242. The number of notifications contained in the last notification message.
  2243. </summary>
  2244. </member>
  2245. <member name="P:Opc.Ua.Client.Subscription.LastNotification">
  2246. <summary>
  2247. The last notification received from the server.
  2248. </summary>
  2249. </member>
  2250. <member name="P:Opc.Ua.Client.Subscription.Notifications">
  2251. <summary>
  2252. The cached notifications.
  2253. </summary>
  2254. </member>
  2255. <member name="P:Opc.Ua.Client.Subscription.AvailableSequenceNumbers">
  2256. <summary>
  2257. The sequence numbers that are available for republish requests.
  2258. </summary>
  2259. </member>
  2260. <member name="M:Opc.Ua.Client.Subscription.ChangesCompleted">
  2261. <summary>
  2262. Sends a notification that the state of the subscription has changed.
  2263. </summary>
  2264. </member>
  2265. <member name="P:Opc.Ua.Client.Subscription.PublishingStopped">
  2266. <summary>
  2267. Returns true if the subscription is not receiving publishes.
  2268. </summary>
  2269. </member>
  2270. <member name="M:Opc.Ua.Client.Subscription.AdjustCounts(System.UInt32@,System.UInt32@)">
  2271. <summary>
  2272. Ensures sensible values for the counts.
  2273. </summary>
  2274. </member>
  2275. <member name="M:Opc.Ua.Client.Subscription.Create">
  2276. <summary>
  2277. Creates a subscription on the server.
  2278. </summary>
  2279. </member>
  2280. <member name="M:Opc.Ua.Client.Subscription.StartKeepAliveTimer">
  2281. <summary>
  2282. Starts a timer to ensure publish requests are sent frequently enough to detect network interruptions.
  2283. </summary>
  2284. </member>
  2285. <member name="M:Opc.Ua.Client.Subscription.OnKeepAlive(System.Object)">
  2286. <summary>
  2287. Checks if a notification has arrived. Sends a publish if it has not.
  2288. </summary>
  2289. </member>
  2290. <member name="M:Opc.Ua.Client.Subscription.TraceState(System.String)">
  2291. <summary>
  2292. Dumps the current state of the session queue.
  2293. </summary>
  2294. </member>
  2295. <member name="M:Opc.Ua.Client.Subscription.Delete(System.Boolean)">
  2296. <summary>
  2297. Deletes a subscription on the server.
  2298. </summary>
  2299. </member>
  2300. <member name="M:Opc.Ua.Client.Subscription.Modify">
  2301. <summary>
  2302. Modifies a subscription on the server.
  2303. </summary>
  2304. </member>
  2305. <member name="M:Opc.Ua.Client.Subscription.SetPublishingMode(System.Boolean)">
  2306. <summary>
  2307. Changes the publishing enabled state for the subscription.
  2308. </summary>
  2309. </member>
  2310. <member name="M:Opc.Ua.Client.Subscription.Republish(System.UInt32)">
  2311. <summary>
  2312. Republishes the specified notification message.
  2313. </summary>
  2314. </member>
  2315. <member name="M:Opc.Ua.Client.Subscription.ApplyChanges">
  2316. <summary>
  2317. Applies any changes to the subscription items.
  2318. </summary>
  2319. </member>
  2320. <member name="M:Opc.Ua.Client.Subscription.ResolveItemNodeIds">
  2321. <summary>
  2322. Resolves all relative paths to nodes on the server.
  2323. </summary>
  2324. </member>
  2325. <member name="M:Opc.Ua.Client.Subscription.CreateItems">
  2326. <summary>
  2327. Creates all items that have not already been created.
  2328. </summary>
  2329. </member>
  2330. <member name="M:Opc.Ua.Client.Subscription.ModifyItems">
  2331. <summary>
  2332. Modies all items that have been changed.
  2333. </summary>
  2334. </member>
  2335. <member name="M:Opc.Ua.Client.Subscription.DeleteItems">
  2336. <summary>
  2337. Deletes all items that have been marked for deletion.
  2338. </summary>
  2339. </member>
  2340. <member name="M:Opc.Ua.Client.Subscription.SetMonitoringMode(Opc.Ua.MonitoringMode,System.Collections.Generic.IList{Opc.Ua.Client.MonitoredItem})">
  2341. <summary>
  2342. Deletes all items that have been marked for deletion.
  2343. </summary>
  2344. </member>
  2345. <member name="M:Opc.Ua.Client.Subscription.SaveMessageInCache(System.Collections.Generic.IList{System.UInt32},Opc.Ua.NotificationMessage,System.Collections.Generic.IList{System.String})">
  2346. <summary>
  2347. Adds the notification message to internal cache.
  2348. </summary>
  2349. </member>
  2350. <member name="M:Opc.Ua.Client.Subscription.OnMessageReceived(System.Object)">
  2351. <summary>
  2352. Processes the incoming messages.
  2353. </summary>
  2354. </member>
  2355. <member name="P:Opc.Ua.Client.Subscription.OutstandingMessageWorkers">
  2356. <summary>
  2357. Get the number of outstanding message workers
  2358. </summary>
  2359. </member>
  2360. <member name="M:Opc.Ua.Client.Subscription.AddItem(Opc.Ua.Client.MonitoredItem)">
  2361. <summary>
  2362. Adds an item to the subscription.
  2363. </summary>
  2364. </member>
  2365. <member name="M:Opc.Ua.Client.Subscription.AddItems(System.Collections.Generic.IEnumerable{Opc.Ua.Client.MonitoredItem})">
  2366. <summary>
  2367. Adds an item to the subscription.
  2368. </summary>
  2369. </member>
  2370. <member name="M:Opc.Ua.Client.Subscription.RemoveItem(Opc.Ua.Client.MonitoredItem)">
  2371. <summary>
  2372. Removes an item from the subscription.
  2373. </summary>
  2374. </member>
  2375. <member name="M:Opc.Ua.Client.Subscription.RemoveItems(System.Collections.Generic.IEnumerable{Opc.Ua.Client.MonitoredItem})">
  2376. <summary>
  2377. Removes an item from the subscription.
  2378. </summary>
  2379. </member>
  2380. <member name="M:Opc.Ua.Client.Subscription.FindItemByClientHandle(System.UInt32)">
  2381. <summary>
  2382. Returns the monitored item identified by the client handle.
  2383. </summary>
  2384. </member>
  2385. <member name="M:Opc.Ua.Client.Subscription.ConditionRefresh">
  2386. <summary>
  2387. Tells the server to refresh all conditions being monitored by the subscription.
  2388. </summary>
  2389. </member>
  2390. <member name="M:Opc.Ua.Client.Subscription.VerifySubscriptionState(System.Boolean)">
  2391. <summary>
  2392. Throws an exception if the subscription is not in the correct state.
  2393. </summary>
  2394. </member>
  2395. <member name="M:Opc.Ua.Client.Subscription.SaveDataChange(Opc.Ua.NotificationMessage,Opc.Ua.DataChangeNotification,System.Collections.Generic.IList{System.String})">
  2396. <summary>
  2397. Saves a data change in the monitored item cache.
  2398. </summary>
  2399. </member>
  2400. <member name="M:Opc.Ua.Client.Subscription.SaveEvents(Opc.Ua.NotificationMessage,Opc.Ua.EventNotificationList,System.Collections.Generic.IList{System.String})">
  2401. <summary>
  2402. Saves events in the monitored item cache.
  2403. </summary>
  2404. </member>
  2405. <member name="T:Opc.Ua.Client.Subscription.IncomingMessage">
  2406. <summary>
  2407. A message received from the server cached until is processed or discarded.
  2408. </summary>
  2409. </member>
  2410. <member name="T:Opc.Ua.Client.SubscriptionChangeMask">
  2411. <summary>
  2412. Flags indicating what has changed in a subscription.
  2413. </summary>
  2414. </member>
  2415. <member name="F:Opc.Ua.Client.SubscriptionChangeMask.None">
  2416. <summary>
  2417. The subscription has not changed.
  2418. </summary>
  2419. </member>
  2420. <member name="F:Opc.Ua.Client.SubscriptionChangeMask.Created">
  2421. <summary>
  2422. The subscription was created on the server.
  2423. </summary>
  2424. </member>
  2425. <member name="F:Opc.Ua.Client.SubscriptionChangeMask.Deleted">
  2426. <summary>
  2427. The subscription was deleted on the server.
  2428. </summary>
  2429. </member>
  2430. <member name="F:Opc.Ua.Client.SubscriptionChangeMask.Modified">
  2431. <summary>
  2432. The subscription was modified on the server.
  2433. </summary>
  2434. </member>
  2435. <member name="F:Opc.Ua.Client.SubscriptionChangeMask.ItemsAdded">
  2436. <summary>
  2437. Monitored items were added to the subscription (but not created on the server)
  2438. </summary>
  2439. </member>
  2440. <member name="F:Opc.Ua.Client.SubscriptionChangeMask.ItemsRemoved">
  2441. <summary>
  2442. Monitored items were removed to the subscription (but not deleted on the server)
  2443. </summary>
  2444. </member>
  2445. <member name="F:Opc.Ua.Client.SubscriptionChangeMask.ItemsCreated">
  2446. <summary>
  2447. Monitored items were created on the server.
  2448. </summary>
  2449. </member>
  2450. <member name="F:Opc.Ua.Client.SubscriptionChangeMask.ItemsDeleted">
  2451. <summary>
  2452. Monitored items were deleted on the server.
  2453. </summary>
  2454. </member>
  2455. <member name="F:Opc.Ua.Client.SubscriptionChangeMask.ItemsModified">
  2456. <summary>
  2457. Monitored items were modified on the server.
  2458. </summary>
  2459. </member>
  2460. <member name="T:Opc.Ua.Client.FastDataChangeNotificationEventHandler">
  2461. <summary>
  2462. The delegate used to receive data change notifications via a direct function call instead of a .NET Event.
  2463. </summary>
  2464. </member>
  2465. <member name="T:Opc.Ua.Client.FastEventNotificationEventHandler">
  2466. <summary>
  2467. The delegate used to receive event notifications via a direct function call instead of a .NET Event.
  2468. </summary>
  2469. </member>
  2470. <member name="T:Opc.Ua.Client.SubscriptionStateChangedEventArgs">
  2471. <summary>
  2472. The event arguments provided when the state of a subscription changes.
  2473. </summary>
  2474. </member>
  2475. <member name="M:Opc.Ua.Client.SubscriptionStateChangedEventArgs.#ctor(Opc.Ua.Client.SubscriptionChangeMask)">
  2476. <summary>
  2477. Creates a new instance.
  2478. </summary>
  2479. </member>
  2480. <member name="P:Opc.Ua.Client.SubscriptionStateChangedEventArgs.Status">
  2481. <summary>
  2482. The changes that have affected the subscription.
  2483. </summary>
  2484. </member>
  2485. <member name="T:Opc.Ua.Client.SubscriptionStateChangedEventHandler">
  2486. <summary>
  2487. The delegate used to receive subscription state change notifications.
  2488. </summary>
  2489. </member>
  2490. <member name="T:Opc.Ua.Client.SubscriptionCollection">
  2491. <summary>
  2492. A collection of subscriptions.
  2493. </summary>
  2494. </member>
  2495. <member name="M:Opc.Ua.Client.SubscriptionCollection.#ctor">
  2496. <summary>
  2497. Initializes an empty collection.
  2498. </summary>
  2499. </member>
  2500. <member name="M:Opc.Ua.Client.SubscriptionCollection.#ctor(System.Collections.Generic.IEnumerable{Opc.Ua.Client.Subscription})">
  2501. <summary>
  2502. Initializes the collection from another collection.
  2503. </summary>
  2504. <param name="collection">The existing collection to use as the basis of creating this collection</param>
  2505. </member>
  2506. <member name="M:Opc.Ua.Client.SubscriptionCollection.#ctor(System.Int32)">
  2507. <summary>
  2508. Initializes the collection with the specified capacity.
  2509. </summary>
  2510. <param name="capacity">The max. capacity of the collection</param>
  2511. </member>
  2512. </members>
  2513. </doc>