2
0

Makaretu.Dns.Multicast.xml 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Makaretu.Dns.Multicast</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Makaretu.Dns.MessageEventArgs">
  8. <summary>
  9. The event data for <see cref="E:Makaretu.Dns.MulticastService.QueryReceived"/> or
  10. <see cref="E:Makaretu.Dns.MulticastService.AnswerReceived"/>.
  11. </summary>
  12. </member>
  13. <member name="P:Makaretu.Dns.MessageEventArgs.Message">
  14. <summary>
  15. The DNS message.
  16. </summary>
  17. <value>
  18. The received message.
  19. </value>
  20. </member>
  21. <member name="P:Makaretu.Dns.MessageEventArgs.RemoteEndPoint">
  22. <summary>
  23. The DNS message sender endpoint.
  24. </summary>
  25. <value>
  26. The endpoint from the message was received.
  27. </value>
  28. </member>
  29. <member name="P:Makaretu.Dns.MessageEventArgs.IsLegacyUnicast">
  30. <summary>
  31. Determines if the sender is using legacy unicast DNS.
  32. </summary>
  33. <value>
  34. <b>false</b> if the sender is using port 5353.
  35. </value>
  36. </member>
  37. <member name="T:Makaretu.Dns.MulticastClient">
  38. <summary>
  39. Performs the magic to send and receive datagrams over multicast
  40. sockets.
  41. </summary>
  42. </member>
  43. <member name="F:Makaretu.Dns.MulticastClient.MulticastPort">
  44. <summary>
  45. The port number assigned to Multicast DNS.
  46. </summary>
  47. <value>
  48. Port number 5353.
  49. </value>
  50. </member>
  51. <member name="T:Makaretu.Dns.MulticastService">
  52. <summary>
  53. Muticast Domain Name Service.
  54. </summary>
  55. <remarks>
  56. Sends and receives DNS queries and answers via the multicast mechachism
  57. defined in <see href="https://tools.ietf.org/html/rfc6762"/>.
  58. <para>
  59. Use <see cref="M:Makaretu.Dns.MulticastService.Start"/> to start listening for multicast messages.
  60. One of the events, <see cref="E:Makaretu.Dns.MulticastService.QueryReceived"/> or <see cref="E:Makaretu.Dns.MulticastService.AnswerReceived"/>, is
  61. raised when a <see cref="T:Makaretu.Dns.Message"/> is received.
  62. </para>
  63. </remarks>
  64. </member>
  65. <member name="F:Makaretu.Dns.MulticastService.sentMessages">
  66. <summary>
  67. Recently sent messages.
  68. </summary>
  69. </member>
  70. <member name="F:Makaretu.Dns.MulticastService.receivedMessages">
  71. <summary>
  72. Recently received messages.
  73. </summary>
  74. </member>
  75. <member name="F:Makaretu.Dns.MulticastService.client">
  76. <summary>
  77. The multicast client.
  78. </summary>
  79. </member>
  80. <member name="F:Makaretu.Dns.MulticastService.unicastClientIp4">
  81. <summary>
  82. Use to send unicast IPv4 answers.
  83. </summary>
  84. </member>
  85. <member name="F:Makaretu.Dns.MulticastService.unicastClientIp6">
  86. <summary>
  87. Use to send unicast IPv6 answers.
  88. </summary>
  89. </member>
  90. <member name="F:Makaretu.Dns.MulticastService.networkInterfacesFilter">
  91. <summary>
  92. Function used for listening filtered network interfaces.
  93. </summary>
  94. </member>
  95. <member name="M:Makaretu.Dns.MulticastService.#cctor">
  96. <summary>
  97. Set the default TTLs.
  98. </summary>
  99. <seealso cref="F:Makaretu.Dns.ResourceRecord.DefaultTTL"/>
  100. <seealso cref="F:Makaretu.Dns.ResourceRecord.DefaultHostTTL"/>
  101. </member>
  102. <member name="E:Makaretu.Dns.MulticastService.QueryReceived">
  103. <summary>
  104. Raised when any local MDNS service sends a query.
  105. </summary>
  106. <value>
  107. Contains the query <see cref="T:Makaretu.Dns.Message"/>.
  108. </value>
  109. <remarks>
  110. Any exception throw by the event handler is simply logged and
  111. then forgotten.
  112. </remarks>
  113. <seealso cref="M:Makaretu.Dns.MulticastService.SendQuery(Makaretu.Dns.Message)"/>
  114. </member>
  115. <member name="E:Makaretu.Dns.MulticastService.AnswerReceived">
  116. <summary>
  117. Raised when any link-local MDNS service responds to a query.
  118. </summary>
  119. <value>
  120. Contains the answer <see cref="T:Makaretu.Dns.Message"/>.
  121. </value>
  122. <remarks>
  123. Any exception throw by the event handler is simply logged and
  124. then forgotten.
  125. </remarks>
  126. </member>
  127. <member name="E:Makaretu.Dns.MulticastService.MalformedMessage">
  128. <summary>
  129. Raised when a DNS message is received that cannot be decoded.
  130. </summary>
  131. <value>
  132. The DNS message as a byte array.
  133. </value>
  134. </member>
  135. <member name="E:Makaretu.Dns.MulticastService.NetworkInterfaceDiscovered">
  136. <summary>
  137. Raised when one or more network interfaces are discovered.
  138. </summary>
  139. <value>
  140. Contains the network interface(s).
  141. </value>
  142. </member>
  143. <member name="M:Makaretu.Dns.MulticastService.#ctor(System.Func{System.Collections.Generic.IEnumerable{System.Net.NetworkInformation.NetworkInterface},System.Collections.Generic.IEnumerable{System.Net.NetworkInformation.NetworkInterface}})">
  144. <summary>
  145. Create a new instance of the <see cref="T:Makaretu.Dns.MulticastService"/> class.
  146. </summary>
  147. <param name="filter">
  148. Multicast listener will be bound to result of filtering function.
  149. </param>
  150. </member>
  151. <member name="P:Makaretu.Dns.MulticastService.UseIpv4">
  152. <summary>
  153. Send and receive on IPv4.
  154. </summary>
  155. <value>
  156. Defaults to <b>true</b> if the OS supports it.
  157. </value>
  158. </member>
  159. <member name="P:Makaretu.Dns.MulticastService.UseIpv6">
  160. <summary>
  161. Send and receive on IPv6.
  162. </summary>
  163. <value>
  164. Defaults to <b>true</b> if the OS supports it.
  165. </value>
  166. </member>
  167. <member name="P:Makaretu.Dns.MulticastService.IgnoreDuplicateMessages">
  168. <summary>
  169. Determines if received messages are checked for duplicates.
  170. </summary>
  171. <value>
  172. <b>true</b> to ignore duplicate messages. Defaults to <b>true</b>.
  173. </value>
  174. <remarks>
  175. When set, a message that has been received within the last minute
  176. will be ignored.
  177. </remarks>
  178. </member>
  179. <member name="P:Makaretu.Dns.MulticastService.NetworkInterfaceDiscoveryInterval">
  180. <summary>
  181. The interval for discovering network interfaces.
  182. </summary>
  183. <value>
  184. Default is 2 minutes.
  185. </value>
  186. <remarks>
  187. When the interval is reached a task is started to discover any
  188. new network interfaces.
  189. </remarks>
  190. <seealso cref="E:Makaretu.Dns.MulticastService.NetworkInterfaceDiscovered"/>
  191. </member>
  192. <member name="M:Makaretu.Dns.MulticastService.GetNetworkInterfaces">
  193. <summary>
  194. Get the network interfaces that are useable.
  195. </summary>
  196. <returns>
  197. A sequence of <see cref="T:System.Net.NetworkInformation.NetworkInterface"/>.
  198. </returns>
  199. <remarks>
  200. The following filters are applied
  201. <list type="bullet">
  202. <item><description>interface is enabled</description></item>
  203. <item><description>interface is not a loopback</description></item>
  204. </list>
  205. <para>
  206. If no network interface is operational, then the loopback interface(s)
  207. are included (127.0.0.1 and/or ::1).
  208. </para>
  209. </remarks>
  210. </member>
  211. <member name="M:Makaretu.Dns.MulticastService.GetIPAddresses">
  212. <summary>
  213. Get the IP addresses of the local machine.
  214. </summary>
  215. <returns>
  216. A sequence of IP addresses of the local machine.
  217. </returns>
  218. <remarks>
  219. The loopback addresses (127.0.0.1 and ::1) are NOT included in the
  220. returned sequences.
  221. </remarks>
  222. </member>
  223. <member name="M:Makaretu.Dns.MulticastService.GetLinkLocalAddresses">
  224. <summary>
  225. Get the link local IP addresses of the local machine.
  226. </summary>
  227. <returns>
  228. A sequence of IP addresses.
  229. </returns>
  230. <remarks>
  231. All IPv4 addresses are considered link local.
  232. </remarks>
  233. <seealso href="https://en.wikipedia.org/wiki/Link-local_address"/>
  234. </member>
  235. <member name="M:Makaretu.Dns.MulticastService.Start">
  236. <summary>
  237. Start the service.
  238. </summary>
  239. </member>
  240. <member name="M:Makaretu.Dns.MulticastService.Stop">
  241. <summary>
  242. Stop the service.
  243. </summary>
  244. <remarks>
  245. Clears all the event handlers.
  246. </remarks>
  247. </member>
  248. <member name="M:Makaretu.Dns.MulticastService.ResolveAsync(Makaretu.Dns.Message,System.Threading.CancellationToken)">
  249. <inheritdoc />
  250. </member>
  251. <member name="M:Makaretu.Dns.MulticastService.SendQuery(Makaretu.Dns.DomainName,Makaretu.Dns.DnsClass,Makaretu.Dns.DnsType)">
  252. <summary>
  253. Ask for answers about a name.
  254. </summary>
  255. <param name="name">
  256. A domain name that should end with ".local", e.g. "myservice.local".
  257. </param>
  258. <param name="klass">
  259. The class, defaults to <see cref="F:Makaretu.Dns.DnsClass.IN"/>.
  260. </param>
  261. <param name="type">
  262. The question type, defaults to <see cref="F:Makaretu.Dns.DnsType.ANY"/>.
  263. </param>
  264. <remarks>
  265. Answers to any query are obtained on the <see cref="E:Makaretu.Dns.MulticastService.AnswerReceived"/>
  266. event.
  267. </remarks>
  268. <exception cref="T:System.InvalidOperationException">
  269. When the service has not started.
  270. </exception>
  271. </member>
  272. <member name="M:Makaretu.Dns.MulticastService.SendUnicastQuery(Makaretu.Dns.DomainName,Makaretu.Dns.DnsClass,Makaretu.Dns.DnsType)">
  273. <summary>
  274. Ask for answers about a name and accept unicast and/or broadcast response.
  275. </summary>
  276. <param name="name">
  277. A domain name that should end with ".local", e.g. "myservice.local".
  278. </param>
  279. <param name="klass">
  280. The class, defaults to <see cref="F:Makaretu.Dns.DnsClass.IN"/>.
  281. </param>
  282. <param name="type">
  283. The question type, defaults to <see cref="F:Makaretu.Dns.DnsType.ANY"/>.
  284. </param>
  285. <remarks>
  286. Send a "QU" question (unicast). The most significat bit of the Class is set.
  287. Answers to any query are obtained on the <see cref="E:Makaretu.Dns.MulticastService.AnswerReceived"/>
  288. event.
  289. </remarks>
  290. <exception cref="T:System.InvalidOperationException">
  291. When the service has not started.
  292. </exception>
  293. </member>
  294. <member name="M:Makaretu.Dns.MulticastService.SendQuery(Makaretu.Dns.Message)">
  295. <summary>
  296. Ask for answers.
  297. </summary>
  298. <param name="msg">
  299. A query message.
  300. </param>
  301. <remarks>
  302. Answers to any query are obtained on the <see cref="E:Makaretu.Dns.MulticastService.AnswerReceived"/>
  303. event.
  304. </remarks>
  305. <exception cref="T:System.InvalidOperationException">
  306. When the service has not started.
  307. </exception>
  308. <exception cref="T:System.ArgumentOutOfRangeException">
  309. When the serialised <paramref name="msg"/> is too large.
  310. </exception>
  311. </member>
  312. <member name="M:Makaretu.Dns.MulticastService.SendAnswer(Makaretu.Dns.Message,System.Boolean)">
  313. <summary>
  314. Send an answer to a query.
  315. </summary>
  316. <param name="answer">
  317. The answer message.
  318. </param>
  319. <param name="checkDuplicate">
  320. If <b>true</b>, then if the same <paramref name="answer"/> was
  321. recently sent it will not be sent again.
  322. </param>
  323. <exception cref="T:System.InvalidOperationException">
  324. When the service has not started.
  325. </exception>
  326. <exception cref="T:System.ArgumentOutOfRangeException">
  327. When the serialised <paramref name="answer"/> is too large.
  328. </exception>
  329. <remarks>
  330. <para>
  331. The <see cref="P:Makaretu.Dns.Message.AA"/> flag is set to true,
  332. the <see cref="P:Makaretu.Dns.Message.Id"/> set to zero and any questions are removed.
  333. </para>
  334. <para>
  335. The <paramref name="answer"/> is <see cref="M:Makaretu.Dns.Message.Truncate(System.Int32)">truncated</see>
  336. if exceeds the maximum packet length.
  337. </para>
  338. <para>
  339. <paramref name="checkDuplicate"/> should always be <b>true</b> except
  340. when <see href="https://tools.ietf.org/html/rfc6762#section-8.1">answering a probe</see>.
  341. </para>
  342. <note type="caution">
  343. If possible the <see cref="M:Makaretu.Dns.MulticastService.SendAnswer(Makaretu.Dns.Message,Makaretu.Dns.MessageEventArgs,System.Boolean)"/>
  344. method should be used, so that legacy unicast queries are supported.
  345. </note>
  346. </remarks>
  347. <see cref="E:Makaretu.Dns.MulticastService.QueryReceived"/>
  348. <seealso cref="M:Makaretu.Dns.Message.CreateResponse"/>
  349. </member>
  350. <member name="M:Makaretu.Dns.MulticastService.SendAnswer(Makaretu.Dns.Message,Makaretu.Dns.MessageEventArgs,System.Boolean)">
  351. <summary>
  352. Send an answer to a query.
  353. </summary>
  354. <param name="answer">
  355. The answer message.
  356. </param>
  357. <param name="query">
  358. The query that is being answered.
  359. </param>
  360. <param name="checkDuplicate">
  361. If <b>true</b>, then if the same <paramref name="answer"/> was
  362. recently sent it will not be sent again.
  363. </param>
  364. <exception cref="T:System.InvalidOperationException">
  365. When the service has not started.
  366. </exception>
  367. <exception cref="T:System.ArgumentOutOfRangeException">
  368. When the serialised <paramref name="answer"/> is too large.
  369. </exception>
  370. <remarks>
  371. <para>
  372. If the <paramref name="query"/> is a standard multicast query (sent to port 5353), then
  373. <see cref="M:Makaretu.Dns.MulticastService.SendAnswer(Makaretu.Dns.Message,System.Boolean)"/> is called.
  374. </para>
  375. <para>
  376. Otherwise a legacy unicast reponse is sent to sender's end point.
  377. The <see cref="P:Makaretu.Dns.Message.AA"/> flag is set to true,
  378. the <see cref="P:Makaretu.Dns.Message.Id"/> is set to query's ID,
  379. the <see cref="P:Makaretu.Dns.Message.Questions"/> is set to the query's questions,
  380. and all resource record TTLs have a max value of 10 seconds.
  381. </para>
  382. <para>
  383. The <paramref name="answer"/> is <see cref="M:Makaretu.Dns.Message.Truncate(System.Int32)">truncated</see>
  384. if exceeds the maximum packet length.
  385. </para>
  386. <para>
  387. <paramref name="checkDuplicate"/> should always be <b>true</b> except
  388. when <see href="https://tools.ietf.org/html/rfc6762#section-8.1">answering a probe</see>.
  389. </para>
  390. </remarks>
  391. </member>
  392. <member name="M:Makaretu.Dns.MulticastService.OnDnsMessage(System.Object,System.Net.Sockets.UdpReceiveResult)">
  393. <summary>
  394. Called by the MulticastClient when a DNS message is received.
  395. </summary>
  396. <param name="sender">
  397. The <see cref="T:Makaretu.Dns.MulticastClient"/> that got the message.
  398. </param>
  399. <param name="result">
  400. The received message <see cref="T:System.Net.Sockets.UdpReceiveResult"/>.
  401. </param>
  402. <remarks>
  403. Decodes the <paramref name="result"/> and then raises
  404. either the <see cref="E:Makaretu.Dns.MulticastService.QueryReceived"/> or <see cref="E:Makaretu.Dns.MulticastService.AnswerReceived"/> event.
  405. <para>
  406. Multicast DNS messages received with an OPCODE or RCODE other than zero
  407. are silently ignored.
  408. </para>
  409. <para>
  410. If the message cannot be decoded, then the <see cref="E:Makaretu.Dns.MulticastService.MalformedMessage"/>
  411. event is raised.
  412. </para>
  413. </remarks>
  414. </member>
  415. <member name="M:Makaretu.Dns.MulticastService.Dispose(System.Boolean)">
  416. <inheritdoc />
  417. </member>
  418. <member name="M:Makaretu.Dns.MulticastService.Dispose">
  419. <inheritdoc />
  420. </member>
  421. <member name="T:Makaretu.Dns.NetworkInterfaceEventArgs">
  422. <summary>
  423. The event data for <see cref="E:Makaretu.Dns.MulticastService.NetworkInterfaceDiscovered"/>.
  424. </summary>
  425. </member>
  426. <member name="P:Makaretu.Dns.NetworkInterfaceEventArgs.NetworkInterfaces">
  427. <summary>
  428. The sequece of detected network interfaces.
  429. </summary>
  430. <value>
  431. A sequence of network interfaces.
  432. </value>
  433. </member>
  434. <member name="T:Makaretu.Dns.RecentMessages">
  435. <summary>
  436. Maintains a sequence of recent messages.
  437. </summary>
  438. <remarks>
  439. <b>RecentMessages</b> is used to determine if a message has already been
  440. processed within the specified <see cref="P:Makaretu.Dns.RecentMessages.Interval"/>.
  441. </remarks>
  442. </member>
  443. <member name="F:Makaretu.Dns.RecentMessages.Messages">
  444. <summary>
  445. Recent messages.
  446. </summary>
  447. <value>
  448. The key is the Base64 encoding of the MD5 hash of
  449. a message and the value is when the message was seen.
  450. </value>
  451. </member>
  452. <member name="P:Makaretu.Dns.RecentMessages.Interval">
  453. <summary>
  454. The time interval used to determine if a message is recent.
  455. </summary>
  456. </member>
  457. <member name="M:Makaretu.Dns.RecentMessages.TryAdd(System.Byte[])">
  458. <summary>
  459. Try adding a message to the recent message list.
  460. </summary>
  461. <param name="message">
  462. The binary representation of a message.
  463. </param>
  464. <returns>
  465. <b>true</b> if the message, did not already exist; otherwise,
  466. <b>false</b> the message exists within the <see cref="P:Makaretu.Dns.RecentMessages.Interval"/>.
  467. </returns>
  468. </member>
  469. <member name="M:Makaretu.Dns.RecentMessages.Prune">
  470. <summary>
  471. Remove any messages that are stale.
  472. </summary>
  473. <returns>
  474. The number messages that were pruned.
  475. </returns>
  476. <remarks>
  477. Anything older than an <see cref="P:Makaretu.Dns.RecentMessages.Interval"/> ago is removed.
  478. </remarks>
  479. </member>
  480. <member name="M:Makaretu.Dns.RecentMessages.GetId(System.Byte[])">
  481. <summary>
  482. Gets a unique ID for a message.
  483. </summary>
  484. <param name="message">
  485. The binary representation of a message.
  486. </param>
  487. <returns>
  488. The Base64 encoding of the MD5 hash of the <paramref name="message"/>.
  489. </returns>
  490. </member>
  491. <member name="T:Makaretu.Dns.ServiceDiscovery">
  492. <summary>
  493. DNS based Service Discovery is a way of using standard DNS programming interfaces, servers,
  494. and packet formats to browse the network for services.
  495. </summary>
  496. <seealso href="https://tools.ietf.org/html/rfc6763">RFC 6763 DNS-Based Service Discovery</seealso>
  497. </member>
  498. <member name="F:Makaretu.Dns.ServiceDiscovery.ServiceName">
  499. <summary>
  500. The service discovery service name.
  501. </summary>
  502. <value>
  503. The service name used to enumerate other services.
  504. </value>
  505. </member>
  506. <member name="M:Makaretu.Dns.ServiceDiscovery.#ctor">
  507. <summary>
  508. Creates a new instance of the <see cref="T:Makaretu.Dns.ServiceDiscovery"/> class.
  509. </summary>
  510. </member>
  511. <member name="M:Makaretu.Dns.ServiceDiscovery.#ctor(Makaretu.Dns.MulticastService)">
  512. <summary>
  513. Creates a new instance of the <see cref="T:Makaretu.Dns.ServiceDiscovery"/> class with
  514. the specified <see cref="T:Makaretu.Dns.MulticastService"/>.
  515. </summary>
  516. <param name="mdns">
  517. The underlaying <see cref="T:Makaretu.Dns.MulticastService"/> to use.
  518. </param>
  519. </member>
  520. <member name="P:Makaretu.Dns.ServiceDiscovery.Mdns">
  521. <summary>
  522. Gets the multicasting service.
  523. </summary>
  524. <value>
  525. Is used to send and recieve multicast <see cref="T:Makaretu.Dns.Message">DNS messages</see>.
  526. </value>
  527. </member>
  528. <member name="P:Makaretu.Dns.ServiceDiscovery.AnswersContainsAdditionalRecords">
  529. <summary>
  530. Add the additional records into the answers.
  531. </summary>
  532. <value>
  533. Defaults to <b>false</b>.
  534. </value>
  535. <remarks>
  536. Some malformed systems, such as js-ipfs and go-ipfs, only examine
  537. the <see cref="P:Makaretu.Dns.Message.Answers"/> and not the <see cref="P:Makaretu.Dns.Message.AdditionalRecords"/>.
  538. Setting this to <b>true</b>, will move the additional records
  539. into the answers.
  540. <para>
  541. This never done for DNS-SD answers.
  542. </para>
  543. </remarks>
  544. </member>
  545. <member name="P:Makaretu.Dns.ServiceDiscovery.NameServer">
  546. <summary>
  547. Gets the name server.
  548. </summary>
  549. <value>
  550. Is used to answer questions.
  551. </value>
  552. </member>
  553. <member name="E:Makaretu.Dns.ServiceDiscovery.ServiceDiscovered">
  554. <summary>
  555. Raised when a DNS-SD response is received.
  556. </summary>
  557. <value>
  558. Contains the service name.
  559. </value>
  560. <remarks>
  561. <b>ServiceDiscovery</b> passively monitors the network for any answers
  562. to a DNS-SD query. When an anwser is received this event is raised.
  563. <para>
  564. Use <see cref="M:Makaretu.Dns.ServiceDiscovery.QueryAllServices"/> to initiate a DNS-SD question.
  565. </para>
  566. </remarks>
  567. </member>
  568. <member name="E:Makaretu.Dns.ServiceDiscovery.ServiceInstanceDiscovered">
  569. <summary>
  570. Raised when a servive instance is discovered.
  571. </summary>
  572. <value>
  573. Contains the service instance name.
  574. </value>
  575. <remarks>
  576. <b>ServiceDiscovery</b> passively monitors the network for any answers.
  577. When an answer containing a PTR to a service instance is received
  578. this event is raised.
  579. </remarks>
  580. </member>
  581. <member name="E:Makaretu.Dns.ServiceDiscovery.ServiceInstanceShutdown">
  582. <summary>
  583. Raised when a servive instance is shutting down.
  584. </summary>
  585. <value>
  586. Contains the service instance name.
  587. </value>
  588. <remarks>
  589. <b>ServiceDiscovery</b> passively monitors the network for any answers.
  590. When an answer containing a PTR to a service instance with a
  591. TTL of zero is received this event is raised.
  592. </remarks>
  593. </member>
  594. <member name="M:Makaretu.Dns.ServiceDiscovery.QueryAllServices">
  595. <summary>
  596. Asks other MDNS services to send their service names.
  597. </summary>
  598. <remarks>
  599. When an answer is received the <see cref="E:Makaretu.Dns.ServiceDiscovery.ServiceDiscovered"/> event is raised.
  600. </remarks>
  601. </member>
  602. <member name="M:Makaretu.Dns.ServiceDiscovery.QueryUnicastAllServices">
  603. <summary>
  604. Asks other MDNS services to send their service names;
  605. accepts unicast and/or broadcast answers.
  606. </summary>
  607. <remarks>
  608. When an answer is received the <see cref="E:Makaretu.Dns.ServiceDiscovery.ServiceDiscovered"/> event is raised.
  609. </remarks>
  610. </member>
  611. <member name="M:Makaretu.Dns.ServiceDiscovery.QueryServiceInstances(Makaretu.Dns.DomainName)">
  612. <summary>
  613. Asks instances of the specified service to send details.
  614. </summary>
  615. <param name="service">
  616. The service name to query. Typically of the form "_<i>service</i>._tcp".
  617. </param>
  618. <remarks>
  619. When an answer is received the <see cref="E:Makaretu.Dns.ServiceDiscovery.ServiceInstanceDiscovered"/> event is raised.
  620. </remarks>
  621. <seealso cref="P:Makaretu.Dns.ServiceProfile.ServiceName"/>
  622. </member>
  623. <member name="M:Makaretu.Dns.ServiceDiscovery.QueryServiceInstances(Makaretu.Dns.DomainName,System.String)">
  624. <summary>
  625. Asks instances of the specified service with the subtype to send details.
  626. </summary>
  627. <param name="service">
  628. The service name to query. Typically of the form "_<i>service</i>._tcp".
  629. </param>
  630. <param name="subtype">
  631. The feature that is needed.
  632. </param>
  633. <remarks>
  634. When an answer is received the <see cref="E:Makaretu.Dns.ServiceDiscovery.ServiceInstanceDiscovered"/> event is raised.
  635. </remarks>
  636. <seealso cref="P:Makaretu.Dns.ServiceProfile.ServiceName"/>
  637. </member>
  638. <member name="M:Makaretu.Dns.ServiceDiscovery.QueryUnicastServiceInstances(Makaretu.Dns.DomainName)">
  639. <summary>
  640. Asks instances of the specified service to send details.
  641. accepts unicast and/or broadcast answers.
  642. </summary>
  643. <param name="service">
  644. The service name to query. Typically of the form "_<i>service</i>._tcp".
  645. </param>
  646. <remarks>
  647. When an answer is received the <see cref="E:Makaretu.Dns.ServiceDiscovery.ServiceInstanceDiscovered"/> event is raised.
  648. </remarks>
  649. <seealso cref="P:Makaretu.Dns.ServiceProfile.ServiceName"/>
  650. </member>
  651. <member name="M:Makaretu.Dns.ServiceDiscovery.Advertise(Makaretu.Dns.ServiceProfile)">
  652. <summary>
  653. Advertise a service profile.
  654. </summary>
  655. <param name="service">
  656. The service profile.
  657. </param>
  658. <remarks>
  659. Any queries for the service or service instance will be answered with
  660. information from the profile.
  661. <para>
  662. Besides adding the profile's resource records to the <see cref="T:Makaretu.Dns.Resolving.Catalog"/> PTR records are
  663. created to support DNS-SD and reverse address mapping (DNS address lookup).
  664. </para>
  665. </remarks>
  666. </member>
  667. <member name="M:Makaretu.Dns.ServiceDiscovery.Announce(Makaretu.Dns.ServiceProfile)">
  668. <summary>
  669. Sends an unsolicited MDNS response describing the
  670. service profile.
  671. </summary>
  672. <param name="profile">
  673. The profile to describe.
  674. </param>
  675. <remarks>
  676. Sends a MDNS response <see cref="T:Makaretu.Dns.Message"/> containing the pointer
  677. and resource records of the <paramref name="profile"/>.
  678. <para>
  679. To provide increased robustness against packet loss,
  680. two unsolicited responses are sent one second apart.
  681. </para>
  682. </remarks>
  683. </member>
  684. <member name="M:Makaretu.Dns.ServiceDiscovery.Unadvertise(Makaretu.Dns.ServiceProfile)">
  685. <summary>
  686. Sends a goodbye message for the provided
  687. profile and removes its pointer from the name sever.
  688. </summary>
  689. <param name="profile">The profile to send a goodbye message for.</param>
  690. </member>
  691. <member name="M:Makaretu.Dns.ServiceDiscovery.Unadvertise">
  692. <summary>
  693. Sends a goodbye message for each anounced service.
  694. </summary>
  695. </member>
  696. <member name="M:Makaretu.Dns.ServiceDiscovery.Dispose(System.Boolean)">
  697. <inheritdoc />
  698. </member>
  699. <member name="M:Makaretu.Dns.ServiceDiscovery.Dispose">
  700. <inheritdoc />
  701. </member>
  702. <member name="T:Makaretu.Dns.ServiceInstanceDiscoveryEventArgs">
  703. <summary>
  704. The event data for <see cref="E:Makaretu.Dns.ServiceDiscovery.ServiceInstanceDiscovered"/>.
  705. </summary>
  706. </member>
  707. <member name="P:Makaretu.Dns.ServiceInstanceDiscoveryEventArgs.ServiceInstanceName">
  708. <summary>
  709. The fully qualified name of the service instance.
  710. </summary>
  711. <value>
  712. Typically of the form "<i>instance</i>._<i>service</i>._tcp.local".
  713. </value>
  714. <seealso cref="P:Makaretu.Dns.ServiceProfile.FullyQualifiedName"/>
  715. </member>
  716. <member name="T:Makaretu.Dns.ServiceInstanceShutdownEventArgs">
  717. <summary>
  718. The event data for <see cref="E:Makaretu.Dns.ServiceDiscovery.ServiceInstanceShutdown"/>.
  719. </summary>
  720. </member>
  721. <member name="P:Makaretu.Dns.ServiceInstanceShutdownEventArgs.ServiceInstanceName">
  722. <summary>
  723. The fully qualified name of the service instance.
  724. </summary>
  725. <value>
  726. Typically of the form "<i>instance</i>._<i>service</i>._tcp.local".
  727. </value>
  728. <seealso cref="P:Makaretu.Dns.ServiceProfile.FullyQualifiedName"/>
  729. </member>
  730. <member name="T:Makaretu.Dns.ServiceProfile">
  731. <summary>
  732. Defines a specific service that can be discovered.
  733. </summary>
  734. <seealso cref="M:Makaretu.Dns.ServiceDiscovery.Advertise(Makaretu.Dns.ServiceProfile)"/>
  735. </member>
  736. <member name="M:Makaretu.Dns.ServiceProfile.#ctor">
  737. <summary>
  738. Creates a new instance of the <see cref="T:Makaretu.Dns.ServiceProfile"/> class.
  739. </summary>
  740. <remarks>
  741. All details must be filled in by the caller, especially the <see cref="P:Makaretu.Dns.ServiceProfile.Resources"/>.
  742. </remarks>
  743. </member>
  744. <member name="M:Makaretu.Dns.ServiceProfile.#ctor(Makaretu.Dns.DomainName,Makaretu.Dns.DomainName,System.UInt16,System.Collections.Generic.IEnumerable{System.Net.IPAddress})">
  745. <summary>
  746. Creates a new instance of the <see cref="T:Makaretu.Dns.ServiceProfile"/> class
  747. with the specified details.
  748. </summary>
  749. <param name="instanceName">
  750. A unique identifier for the specific service instance.
  751. </param>
  752. <param name="serviceName">
  753. The <see cref="P:Makaretu.Dns.ServiceProfile.ServiceName">name</see> of the service.
  754. </param>
  755. <param name="port">
  756. The TCP/UDP port of the service.
  757. </param>
  758. <param name="addresses">
  759. The IP addresses of the specific service instance. If <b>null</b> then
  760. <see cref="M:Makaretu.Dns.MulticastService.GetIPAddresses"/> is used.
  761. </param>
  762. <remarks>
  763. The SRV, TXT and A/AAAA resoruce records are added to the <see cref="P:Makaretu.Dns.ServiceProfile.Resources"/>.
  764. </remarks>
  765. </member>
  766. <member name="P:Makaretu.Dns.ServiceProfile.Domain">
  767. <summary>
  768. The top level domain (TLD) name of the service.
  769. </summary>
  770. <value>
  771. Always "local".
  772. </value>
  773. </member>
  774. <member name="P:Makaretu.Dns.ServiceProfile.ServiceName">
  775. <summary>
  776. A unique name for the service.
  777. </summary>
  778. <value>
  779. Typically of the form "_<i>service</i>._tcp".
  780. </value>
  781. <remarks>
  782. It consists of a pair of DNS labels, following the
  783. <see href="https://www.ietf.org/rfc/rfc2782.txt">SRV records</see> convention.
  784. The first label of the pair is an underscore character (_) followed by
  785. the <see href="https://tools.ietf.org/html/rfc6335">service name</see>.
  786. The second label is either "_tcp" (for application
  787. protocols that run over TCP) or "_udp" (for all others).
  788. </remarks>
  789. </member>
  790. <member name="P:Makaretu.Dns.ServiceProfile.InstanceName">
  791. <summary>
  792. A unique identifier for the service instance.
  793. </summary>
  794. <value>
  795. Some unique value.
  796. </value>
  797. </member>
  798. <member name="P:Makaretu.Dns.ServiceProfile.QualifiedServiceName">
  799. <summary>
  800. The service name and domain.
  801. </summary>
  802. <value>
  803. Typically of the form "_<i>service</i>._tcp.local".
  804. </value>
  805. </member>
  806. <member name="P:Makaretu.Dns.ServiceProfile.HostName">
  807. <summary>
  808. The fully qualified name of the instance's host.
  809. </summary>
  810. <remarks>
  811. This can be used to query the address records (A and AAAA)
  812. of the service instance.
  813. </remarks>
  814. </member>
  815. <member name="P:Makaretu.Dns.ServiceProfile.FullyQualifiedName">
  816. <summary>
  817. The instance name, service name and domain.
  818. </summary>
  819. <value>
  820. <see cref="P:Makaretu.Dns.ServiceProfile.InstanceName"/>.<see cref="P:Makaretu.Dns.ServiceProfile.ServiceName"/>.<see cref="P:Makaretu.Dns.ServiceProfile.Domain"/>
  821. </value>
  822. </member>
  823. <member name="P:Makaretu.Dns.ServiceProfile.Resources">
  824. <summary>
  825. DNS resource records that are used to locate the service instance.
  826. </summary>
  827. <value>
  828. More infomation about the service.
  829. </value>
  830. <remarks>
  831. All records should have the <see cref="P:Makaretu.Dns.ResourceRecord.Name"/> equal
  832. to the <see cref="P:Makaretu.Dns.ServiceProfile.FullyQualifiedName"/> or the <see cref="P:Makaretu.Dns.ServiceProfile.HostName"/>.
  833. <para>
  834. At a minimum the <see cref="T:Makaretu.Dns.SRVRecord"/> and <see cref="T:Makaretu.Dns.TXTRecord"/>
  835. records must be present.
  836. Typically <see cref="T:Makaretu.Dns.AddressRecord">address records</see>
  837. are also present and are associaed with <see cref="P:Makaretu.Dns.ServiceProfile.HostName"/>.
  838. </para>
  839. </remarks>
  840. </member>
  841. <member name="P:Makaretu.Dns.ServiceProfile.Subtypes">
  842. <summary>
  843. A list of service features implemented by the service instance.
  844. </summary>
  845. <value>
  846. The default is an empty list.
  847. </value>
  848. <seealso href="https://tools.ietf.org/html/rfc6763#section-7.1"/>
  849. </member>
  850. <member name="M:Makaretu.Dns.ServiceProfile.AddProperty(System.String,System.String)">
  851. <summary>
  852. Add a property of the service to the <see cref="T:Makaretu.Dns.TXTRecord"/>.
  853. </summary>
  854. <param name="key">
  855. The name of the property.
  856. </param>
  857. <param name="value">
  858. The value of the property.
  859. </param>
  860. </member>
  861. </members>
  862. </doc>