You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

217 lines
11 KiB

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Nancy.Hosting.Self</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Nancy.Hosting.Self.IgnoredHeaders">
  8. <summary>
  9. A helper class that checks for a header against a list of headers that should be ignored
  10. when populating the headers of an <see cref="T:System.Net.HttpListenerResponse"/> object.
  11. </summary>
  12. </member>
  13. <member name="M:Nancy.Hosting.Self.IgnoredHeaders.IsIgnored(System.String)">
  14. <summary>
  15. Determines if a header is ignored when populating the headers of an
  16. <see cref="T:System.Net.HttpListenerResponse"/> object.
  17. </summary>
  18. <param name="headerName">The name of the header.</param>
  19. <returns><c>true</c> if the header is ignored; otherwise, <c>false</c>.</returns>
  20. </member>
  21. <member name="T:Nancy.Hosting.Self.UrlReservations">
  22. <summary>
  23. Configuration for automatic url reservation creation
  24. </summary>
  25. </member>
  26. <member name="P:Nancy.Hosting.Self.UrlReservations.CreateAutomatically">
  27. <summary>
  28. Gets or sets a value indicating whether url reservations
  29. are automatically created when necessary.
  30. Defaults to false.
  31. </summary>
  32. </member>
  33. <member name="P:Nancy.Hosting.Self.UrlReservations.User">
  34. <summary>
  35. Gets or sets a value for the user to use to create the url reservations for.
  36. Defaults to the "Everyone" group.
  37. </summary>
  38. </member>
  39. <member name="T:Nancy.Hosting.Self.UacHelper">
  40. <summary>
  41. Helpers for UAC
  42. </summary>
  43. </member>
  44. <member name="M:Nancy.Hosting.Self.UacHelper.RunElevated(System.String,System.String)">
  45. <summary>
  46. Run an executable elevated
  47. </summary>
  48. <param name="file">File to execute</param>
  49. <param name="args">Arguments to pass to the executable</param>
  50. <returns>True if successful, false otherwise</returns>
  51. </member>
  52. <member name="T:Nancy.Hosting.Self.HostConfiguration">
  53. <summary>
  54. Host configuration for the self host
  55. </summary>
  56. </member>
  57. <member name="P:Nancy.Hosting.Self.HostConfiguration.RewriteLocalhost">
  58. <summary>
  59. Gets or sets a property that determines if localhost uris are
  60. rewritten to htp://+:port/ style uris to allow for listening on
  61. all ports, but requiring either a url reservation, or admin
  62. access
  63. Defaults to true.
  64. </summary>
  65. </member>
  66. <member name="P:Nancy.Hosting.Self.HostConfiguration.UrlReservations">
  67. <summary>
  68. Configuration around automatically creating url reservations
  69. </summary>
  70. </member>
  71. <member name="P:Nancy.Hosting.Self.HostConfiguration.AllowChunkedEncoding">
  72. <summary>
  73. Gets or sets a property that determines if Transfer-Encoding: Chunked is allowed
  74. for the response instead of Content-Length (default: true).
  75. </summary>
  76. </member>
  77. <member name="P:Nancy.Hosting.Self.HostConfiguration.UnhandledExceptionCallback">
  78. <summary>
  79. Gets or sets a property that provides a callback to be called
  80. if there's an unhandled exception in the self host.
  81. Note: this will *not* be called for normal nancy Exceptions
  82. that are handled by the Nancy handlers.
  83. Defaults to writing to debug out.
  84. </summary>
  85. </member>
  86. <member name="P:Nancy.Hosting.Self.HostConfiguration.EnableClientCertificates">
  87. <summary>
  88. Gets or sets a property that determines whether client certificates
  89. are enabled or not.
  90. When set to true the self host will request a client certificate if the
  91. request is running over SSL.
  92. Defaults to false.
  93. </summary>
  94. </member>
  95. <member name="P:Nancy.Hosting.Self.HostConfiguration.AllowAuthorityFallback">
  96. <summary>
  97. Gets or sets a property determining if base uri matching can fall back to just
  98. using Authority (Schema + Host + Port) as base uri if it cannot match anything in
  99. the known list. This should only be set to True if you have issues with port forwarding
  100. (e.g. on Azure).
  101. </summary>
  102. </member>
  103. <member name="T:Nancy.Hosting.Self.NancyHost">
  104. <summary>
  105. Allows to host Nancy server inside any application - console or windows service.
  106. </summary>
  107. <remarks>
  108. NancyHost uses <see cref="T:System.Net.HttpListener"/> internally. Therefore, it requires full .net 4.0 profile (not client profile)
  109. to run. <see cref="M:Nancy.Hosting.Self.NancyHost.Start"/> will launch a thread that will listen for requests and then process them. Each request is processed in
  110. its own execution thread. NancyHost needs <see cref="T:System.SerializableAttribute"/> in order to be used from another appdomain under
  111. mono. Working with AppDomains is necessary if you want to unload the dependencies that come with NancyHost.
  112. </remarks>
  113. </member>
  114. <member name="M:Nancy.Hosting.Self.NancyHost.#ctor(System.Uri[])">
  115. <summary>
  116. Initializes a new instance of the <see cref="T:Nancy.Hosting.Self.NancyHost"/> class for the specified <paramref name="baseUris"/>.
  117. Uses the default configuration
  118. </summary>
  119. <param name="baseUris">The <see cref="T:System.Uri"/>s that the host will listen to.</param>
  120. </member>
  121. <member name="M:Nancy.Hosting.Self.NancyHost.#ctor(Nancy.Hosting.Self.HostConfiguration,System.Uri[])">
  122. <summary>
  123. Initializes a new instance of the <see cref="T:Nancy.Hosting.Self.NancyHost"/> class for the specified <paramref name="baseUris"/>.
  124. Uses the specified configuration.
  125. </summary>
  126. <param name="baseUris">The <see cref="T:System.Uri"/>s that the host will listen to.</param>
  127. <param name="configuration">Configuration to use</param>
  128. </member>
  129. <member name="M:Nancy.Hosting.Self.NancyHost.#ctor(Nancy.Bootstrapper.INancyBootstrapper,System.Uri[])">
  130. <summary>
  131. Initializes a new instance of the <see cref="T:Nancy.Hosting.Self.NancyHost"/> class for the specified <paramref name="baseUris"/>, using
  132. the provided <paramref name="bootstrapper"/>.
  133. Uses the default configuration
  134. </summary>
  135. <param name="bootstrapper">The bootstrapper that should be used to handle the request.</param>
  136. <param name="baseUris">The <see cref="T:System.Uri"/>s that the host will listen to.</param>
  137. </member>
  138. <member name="M:Nancy.Hosting.Self.NancyHost.#ctor(Nancy.Bootstrapper.INancyBootstrapper,Nancy.Hosting.Self.HostConfiguration,System.Uri[])">
  139. <summary>
  140. Initializes a new instance of the <see cref="T:Nancy.Hosting.Self.NancyHost"/> class for the specified <paramref name="baseUris"/>, using
  141. the provided <paramref name="bootstrapper"/>.
  142. Uses the specified configuration.
  143. </summary>
  144. <param name="bootstrapper">The bootstrapper that should be used to handle the request.</param>
  145. <param name="configuration">Configuration to use</param>
  146. <param name="baseUris">The <see cref="T:System.Uri"/>s that the host will listen to.</param>
  147. </member>
  148. <member name="M:Nancy.Hosting.Self.NancyHost.#ctor(System.Uri,Nancy.Bootstrapper.INancyBootstrapper)">
  149. <summary>
  150. Initializes a new instance of the <see cref="T:Nancy.Hosting.Self.NancyHost"/> class for the specified <paramref name="baseUri"/>, using
  151. the provided <paramref name="bootstrapper"/>.
  152. Uses the default configuration
  153. </summary>
  154. <param name="baseUri">The <see cref="T:System.Uri"/> that the host will listen to.</param>
  155. <param name="bootstrapper">The bootstrapper that should be used to handle the request.</param>
  156. </member>
  157. <member name="M:Nancy.Hosting.Self.NancyHost.#ctor(System.Uri,Nancy.Bootstrapper.INancyBootstrapper,Nancy.Hosting.Self.HostConfiguration)">
  158. <summary>
  159. Initializes a new instance of the <see cref="T:Nancy.Hosting.Self.NancyHost"/> class for the specified <paramref name="baseUri"/>, using
  160. the provided <paramref name="bootstrapper"/>.
  161. Uses the specified configuration.
  162. </summary>
  163. <param name="baseUri">The <see cref="T:System.Uri"/> that the host will listen to.</param>
  164. <param name="bootstrapper">The bootstrapper that should be used to handle the request.</param>
  165. <param name="configuration">Configuration to use</param>
  166. </member>
  167. <member name="M:Nancy.Hosting.Self.NancyHost.Dispose">
  168. <summary>
  169. Stops the host if it is running.
  170. </summary>
  171. </member>
  172. <member name="M:Nancy.Hosting.Self.NancyHost.Start">
  173. <summary>
  174. Start listening for incoming requests with the given configuration
  175. </summary>
  176. </member>
  177. <member name="M:Nancy.Hosting.Self.NancyHost.Stop">
  178. <summary>
  179. Stop listening for incoming requests.
  180. </summary>
  181. </member>
  182. <member name="T:Nancy.Hosting.Self.NetSh">
  183. <summary>
  184. Executes NetSh commands
  185. </summary>
  186. </member>
  187. <member name="M:Nancy.Hosting.Self.NetSh.AddUrlAcl(System.String,System.String)">
  188. <summary>
  189. Add a url reservation
  190. </summary>
  191. <param name="url">Url to add</param>
  192. <param name="user">User to add the reservation for</param>
  193. <returns>True if successful, false otherwise.</returns>
  194. </member>
  195. <member name="T:Nancy.Hosting.Self.AutomaticUrlReservationCreationFailureException">
  196. <summary>
  197. Exception for when automatic address reservation creation fails.
  198. Provides the user with manual instructions.
  199. </summary>
  200. </member>
  201. <member name="P:Nancy.Hosting.Self.AutomaticUrlReservationCreationFailureException.Message">
  202. <summary>
  203. Gets a message that describes the current exception.
  204. </summary>
  205. <returns>
  206. The error message that explains the reason for the exception, or an empty string("").
  207. </returns>
  208. <filterpriority>1</filterpriority>
  209. </member>
  210. <member name="T:Nancy.Hosting.Self.UriExtensions">
  211. <summary>
  212. Extension methods for working with <see cref="T:System.Uri"/> instances.
  213. </summary>
  214. </member>
  215. </members>
  216. </doc>