NamedPipeServerStream.xml 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <Type Name="NamedPipeServerStream" FullName="System.IO.Pipes.NamedPipeServerStream">
  3. <TypeSignature Language="C#" Value="public sealed class NamedPipeServerStream : System.IO.Pipes.PipeStream" />
  4. <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit NamedPipeServerStream extends System.IO.Pipes.PipeStream" />
  5. <AssemblyInfo>
  6. <AssemblyName>System.Core</AssemblyName>
  7. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  8. </AssemblyInfo>
  9. <Base>
  10. <BaseTypeName>System.IO.Pipes.PipeStream</BaseTypeName>
  11. </Base>
  12. <Interfaces />
  13. <Attributes>
  14. <Attribute>
  15. <AttributeName>System.MonoTODO("working only on win32 right now")</AttributeName>
  16. </Attribute>
  17. </Attributes>
  18. <Docs>
  19. <remarks>
  20. <attribution license="cc4" from="Microsoft" modified="false" />
  21. <para>Named pipes provide one-way or duplex pipes for communication between a pipe server and one or more pipe clients. Named pipes can be used for interprocess communication locally or over a network. A single pipe name can be shared by multiple <see cref="T:System.IO.Pipes.NamedPipeClientStream" /> objects.</para>
  22. <para>Any process can act as either a named pipe server or client, or both.</para>
  23. <block subset="none" type="note">
  24. <para>For winxppro and win2kserver, a maximum of 10 pipes can simultaneously connect over the network.</para>
  25. </block>
  26. </remarks>
  27. <summary>
  28. <attribution license="cc4" from="Microsoft" modified="false" />
  29. <para>Exposes a <see cref="T:System.IO.Stream" /> around a named pipe, supporting both synchronous and asynchronous read and write operations.</para>
  30. </summary>
  31. </Docs>
  32. <Members>
  33. <Member MemberName=".ctor">
  34. <MemberSignature Language="C#" Value="public NamedPipeServerStream (string pipeName);" />
  35. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string pipeName) cil managed" />
  36. <MemberType>Constructor</MemberType>
  37. <AssemblyInfo>
  38. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  39. </AssemblyInfo>
  40. <Parameters>
  41. <Parameter Name="pipeName" Type="System.String" />
  42. </Parameters>
  43. <Docs>
  44. <remarks>
  45. <attribution license="cc4" from="Microsoft" modified="false" />
  46. <para>This constructor creates a <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> object that has the following characteristics:</para>
  47. <list type="bullet">
  48. <item>
  49. <para>A default pipe direction of <see cref="F:System.IO.Pipes.PipeDirection.InOut" />. </para>
  50. </item>
  51. <item>
  52. <para>The maximum number of server instances that share the same name set to 1. </para>
  53. </item>
  54. <item>
  55. <para>A <see cref="T:System.IO.Pipes.PipeTransmissionMode" /> value of <see cref="F:System.IO.Pipes.PipeTransmissionMode.Byte" />. </para>
  56. </item>
  57. <item>
  58. <para>A <see cref="T:System.IO.Pipes.PipeOptions" /> value of <see cref="F:System.IO.Pipes.PipeOptions.None" />.</para>
  59. </item>
  60. <item>
  61. <para>Default input and output buffer sizes. </para>
  62. </item>
  63. <item>
  64. <para>No pipe security. </para>
  65. </item>
  66. <item>
  67. <para>A <see cref="T:System.IO.HandleInheritability" /> value of <see cref="F:System.IO.HandleInheritability.None" />. </para>
  68. </item>
  69. <item>
  70. <para>No specified additional <see cref="T:System.IO.Pipes.PipeAccessRights" />.</para>
  71. </item>
  72. </list>
  73. </remarks>
  74. <summary>
  75. <attribution license="cc4" from="Microsoft" modified="false" />
  76. <para>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> class with the specified pipe name.</para>
  77. </summary>
  78. <param name="pipeName">
  79. <attribution license="cc4" from="Microsoft" modified="false" />The name of the pipe.</param>
  80. </Docs>
  81. </Member>
  82. <Member MemberName=".ctor">
  83. <MemberSignature Language="C#" Value="public NamedPipeServerStream (string pipeName, System.IO.Pipes.PipeDirection direction);" />
  84. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string pipeName, valuetype System.IO.Pipes.PipeDirection direction) cil managed" />
  85. <MemberType>Constructor</MemberType>
  86. <AssemblyInfo>
  87. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  88. </AssemblyInfo>
  89. <Parameters>
  90. <Parameter Name="pipeName" Type="System.String" />
  91. <Parameter Name="direction" Type="System.IO.Pipes.PipeDirection" />
  92. </Parameters>
  93. <Docs>
  94. <remarks>
  95. <attribution license="cc4" from="Microsoft" modified="false" />
  96. <para>This constructor creates a <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> object that has the following characteristics:</para>
  97. <list type="bullet">
  98. <item>
  99. <para>A <see cref="T:System.IO.Pipes.PipeTransmissionMode" /> value of <see cref="F:System.IO.Pipes.PipeTransmissionMode.Byte" />. </para>
  100. </item>
  101. <item>
  102. <para>A <see cref="T:System.IO.Pipes.PipeOptions" /> value of <see cref="F:System.IO.Pipes.PipeOptions.None" />. </para>
  103. </item>
  104. <item>
  105. <para>Default input and output buffer sizes. </para>
  106. </item>
  107. <item>
  108. <para>No pipe security. </para>
  109. </item>
  110. <item>
  111. <para>A <see cref="T:System.IO.HandleInheritability" /> value of <see cref="F:System.IO.HandleInheritability.None" />. </para>
  112. </item>
  113. <item>
  114. <para>No specified additional <see cref="T:System.IO.Pipes.PipeAccessRights" />.</para>
  115. </item>
  116. </list>
  117. </remarks>
  118. <summary>
  119. <attribution license="cc4" from="Microsoft" modified="false" />
  120. <para>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> class with the specified pipe name and pipe direction.</para>
  121. </summary>
  122. <param name="pipeName">
  123. <attribution license="cc4" from="Microsoft" modified="false" />The name of the pipe.</param>
  124. <param name="direction">
  125. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines the direction of the pipe.</param>
  126. </Docs>
  127. </Member>
  128. <Member MemberName=".ctor">
  129. <MemberSignature Language="C#" Value="public NamedPipeServerStream (string pipeName, System.IO.Pipes.PipeDirection direction, int maxNumberOfServerInstances);" />
  130. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string pipeName, valuetype System.IO.Pipes.PipeDirection direction, int32 maxNumberOfServerInstances) cil managed" />
  131. <MemberType>Constructor</MemberType>
  132. <AssemblyInfo>
  133. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  134. </AssemblyInfo>
  135. <Parameters>
  136. <Parameter Name="pipeName" Type="System.String" />
  137. <Parameter Name="direction" Type="System.IO.Pipes.PipeDirection" />
  138. <Parameter Name="maxNumberOfServerInstances" Type="System.Int32" />
  139. </Parameters>
  140. <Docs>
  141. <remarks>
  142. <attribution license="cc4" from="Microsoft" modified="false" />
  143. <para>This constructor creates a <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> object that has the following characteristics:</para>
  144. <list type="bullet">
  145. <item>
  146. <para>A default value of 1 for the maximum number of server instances that share the same name. </para>
  147. </item>
  148. <item>
  149. <para>A default <see cref="T:System.IO.Pipes.PipeTransmissionMode" /> value of <see cref="F:System.IO.Pipes.PipeTransmissionMode.Byte" />. </para>
  150. </item>
  151. <item>
  152. <para>A <see cref="T:System.IO.Pipes.PipeOptions" /> value of <see cref="F:System.IO.Pipes.PipeOptions.None" />. </para>
  153. </item>
  154. <item>
  155. <para>Default input and output buffer sizes. </para>
  156. </item>
  157. <item>
  158. <para>No pipe security. </para>
  159. </item>
  160. <item>
  161. <para>A <see cref="T:System.IO.HandleInheritability" /> value of <see cref="F:System.IO.HandleInheritability.None" />. </para>
  162. </item>
  163. <item>
  164. <para>No specified additional <see cref="T:System.IO.Pipes.PipeAccessRights" />.</para>
  165. </item>
  166. </list>
  167. </remarks>
  168. <summary>
  169. <attribution license="cc4" from="Microsoft" modified="false" />
  170. <para>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> class with the specified pipe name, pipe direction, and maximum number of server instances.</para>
  171. </summary>
  172. <param name="pipeName">
  173. <attribution license="cc4" from="Microsoft" modified="false" />The name of the pipe.</param>
  174. <param name="direction">
  175. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines the direction of the pipe.</param>
  176. <param name="maxNumberOfServerInstances">
  177. <attribution license="cc4" from="Microsoft" modified="false" />The maximum number of server instances that share the same name. You can pass <see cref="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances" /> for this value.</param>
  178. </Docs>
  179. </Member>
  180. <Member MemberName=".ctor">
  181. <MemberSignature Language="C#" Value="public NamedPipeServerStream (System.IO.Pipes.PipeDirection direction, bool isAsync, bool isConnected, Microsoft.Win32.SafeHandles.SafePipeHandle safePipeHandle);" />
  182. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.IO.Pipes.PipeDirection direction, bool isAsync, bool isConnected, class Microsoft.Win32.SafeHandles.SafePipeHandle safePipeHandle) cil managed" />
  183. <MemberType>Constructor</MemberType>
  184. <AssemblyInfo>
  185. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  186. </AssemblyInfo>
  187. <Parameters>
  188. <Parameter Name="direction" Type="System.IO.Pipes.PipeDirection" />
  189. <Parameter Name="isAsync" Type="System.Boolean" />
  190. <Parameter Name="isConnected" Type="System.Boolean" />
  191. <Parameter Name="safePipeHandle" Type="Microsoft.Win32.SafeHandles.SafePipeHandle" />
  192. </Parameters>
  193. <Docs>
  194. <remarks>To be added.</remarks>
  195. <summary>
  196. <attribution license="cc4" from="Microsoft" modified="false" />
  197. <para>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> class from the specified pipe handle.</para>
  198. </summary>
  199. <param name="direction">
  200. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines the direction of the pipe.</param>
  201. <param name="isAsync">
  202. <attribution license="cc4" from="Microsoft" modified="false" />true to indicate that the handle was opened asynchronously; otherwise, false.</param>
  203. <param name="isConnected">
  204. <attribution license="cc4" from="Microsoft" modified="false" />true to indicate that the pipe is connected; otherwise, false.</param>
  205. <param name="safePipeHandle">
  206. <attribution license="cc4" from="Microsoft" modified="false" />A safe handle for the pipe that this <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> object will encapsulate.</param>
  207. </Docs>
  208. </Member>
  209. <Member MemberName=".ctor">
  210. <MemberSignature Language="C#" Value="public NamedPipeServerStream (string pipeName, System.IO.Pipes.PipeDirection direction, int maxNumberOfServerInstances, System.IO.Pipes.PipeTransmissionMode transmissionMode);" />
  211. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string pipeName, valuetype System.IO.Pipes.PipeDirection direction, int32 maxNumberOfServerInstances, valuetype System.IO.Pipes.PipeTransmissionMode transmissionMode) cil managed" />
  212. <MemberType>Constructor</MemberType>
  213. <AssemblyInfo>
  214. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  215. </AssemblyInfo>
  216. <Parameters>
  217. <Parameter Name="pipeName" Type="System.String" />
  218. <Parameter Name="direction" Type="System.IO.Pipes.PipeDirection" />
  219. <Parameter Name="maxNumberOfServerInstances" Type="System.Int32" />
  220. <Parameter Name="transmissionMode" Type="System.IO.Pipes.PipeTransmissionMode" />
  221. </Parameters>
  222. <Docs>
  223. <remarks>
  224. <attribution license="cc4" from="Microsoft" modified="false" />
  225. <para>This constructor creates a <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> object that has the following characteristics:</para>
  226. <list type="bullet">
  227. <item>
  228. <para>A default <see cref="T:System.IO.Pipes.PipeOptions" /> value of <see cref="F:System.IO.Pipes.PipeOptions.None" />. </para>
  229. </item>
  230. <item>
  231. <para>Default input and output buffer sizes. </para>
  232. </item>
  233. <item>
  234. <para>No pipe security. </para>
  235. </item>
  236. <item>
  237. <para>A <see cref="T:System.IO.HandleInheritability" /> value of <see cref="F:System.IO.HandleInheritability.None" />. </para>
  238. </item>
  239. <item>
  240. <para>No specified additional <see cref="T:System.IO.Pipes.PipeAccessRights" />.</para>
  241. </item>
  242. </list>
  243. </remarks>
  244. <summary>
  245. <attribution license="cc4" from="Microsoft" modified="false" />
  246. <para>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> class with the specified pipe name, pipe direction, maximum number of server instances, and transmission mode.</para>
  247. </summary>
  248. <param name="pipeName">
  249. <attribution license="cc4" from="Microsoft" modified="false" />The name of the pipe.</param>
  250. <param name="direction">
  251. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines the direction of the pipe.</param>
  252. <param name="maxNumberOfServerInstances">
  253. <attribution license="cc4" from="Microsoft" modified="false" />The maximum number of server instances that share the same name. You can pass <see cref="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances" /> for this value.</param>
  254. <param name="transmissionMode">
  255. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines the transmission mode of the pipe.</param>
  256. </Docs>
  257. </Member>
  258. <Member MemberName=".ctor">
  259. <MemberSignature Language="C#" Value="public NamedPipeServerStream (string pipeName, System.IO.Pipes.PipeDirection direction, int maxNumberOfServerInstances, System.IO.Pipes.PipeTransmissionMode transmissionMode, System.IO.Pipes.PipeOptions options);" />
  260. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string pipeName, valuetype System.IO.Pipes.PipeDirection direction, int32 maxNumberOfServerInstances, valuetype System.IO.Pipes.PipeTransmissionMode transmissionMode, valuetype System.IO.Pipes.PipeOptions options) cil managed" />
  261. <MemberType>Constructor</MemberType>
  262. <AssemblyInfo>
  263. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  264. </AssemblyInfo>
  265. <Parameters>
  266. <Parameter Name="pipeName" Type="System.String" />
  267. <Parameter Name="direction" Type="System.IO.Pipes.PipeDirection" />
  268. <Parameter Name="maxNumberOfServerInstances" Type="System.Int32" />
  269. <Parameter Name="transmissionMode" Type="System.IO.Pipes.PipeTransmissionMode" />
  270. <Parameter Name="options" Type="System.IO.Pipes.PipeOptions" />
  271. </Parameters>
  272. <Docs>
  273. <remarks>
  274. <attribution license="cc4" from="Microsoft" modified="false" />
  275. <para>This constructor creates a <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> object that has the following characteristics:</para>
  276. <list type="bullet">
  277. <item>
  278. <para>Default input and output buffer sizes. </para>
  279. </item>
  280. <item>
  281. <para>No pipe security. </para>
  282. </item>
  283. <item>
  284. <para>A <see cref="T:System.IO.HandleInheritability" /> value of <see cref="F:System.IO.HandleInheritability.None" />. </para>
  285. </item>
  286. <item>
  287. <para>No specified additional <see cref="T:System.IO.Pipes.PipeAccessRights" />.</para>
  288. </item>
  289. </list>
  290. </remarks>
  291. <summary>
  292. <attribution license="cc4" from="Microsoft" modified="false" />
  293. <para>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> class with the specified pipe name, pipe direction, maximum number of server instances, transmission mode, and pipe options.</para>
  294. </summary>
  295. <param name="pipeName">
  296. <attribution license="cc4" from="Microsoft" modified="false" />The name of the pipe.</param>
  297. <param name="direction">
  298. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines the direction of the pipe.</param>
  299. <param name="maxNumberOfServerInstances">
  300. <attribution license="cc4" from="Microsoft" modified="false" />The maximum number of server instances that share the same name. You can pass <see cref="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances" /> for this value.</param>
  301. <param name="transmissionMode">
  302. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines the transmission mode of the pipe.</param>
  303. <param name="options">
  304. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines how to open or create the pipe.</param>
  305. </Docs>
  306. </Member>
  307. <Member MemberName=".ctor">
  308. <MemberSignature Language="C#" Value="public NamedPipeServerStream (string pipeName, System.IO.Pipes.PipeDirection direction, int maxNumberOfServerInstances, System.IO.Pipes.PipeTransmissionMode transmissionMode, System.IO.Pipes.PipeOptions options, int inBufferSize, int outBufferSize);" />
  309. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string pipeName, valuetype System.IO.Pipes.PipeDirection direction, int32 maxNumberOfServerInstances, valuetype System.IO.Pipes.PipeTransmissionMode transmissionMode, valuetype System.IO.Pipes.PipeOptions options, int32 inBufferSize, int32 outBufferSize) cil managed" />
  310. <MemberType>Constructor</MemberType>
  311. <AssemblyInfo>
  312. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  313. </AssemblyInfo>
  314. <Parameters>
  315. <Parameter Name="pipeName" Type="System.String" />
  316. <Parameter Name="direction" Type="System.IO.Pipes.PipeDirection" />
  317. <Parameter Name="maxNumberOfServerInstances" Type="System.Int32" />
  318. <Parameter Name="transmissionMode" Type="System.IO.Pipes.PipeTransmissionMode" />
  319. <Parameter Name="options" Type="System.IO.Pipes.PipeOptions" />
  320. <Parameter Name="inBufferSize" Type="System.Int32" />
  321. <Parameter Name="outBufferSize" Type="System.Int32" />
  322. </Parameters>
  323. <Docs>
  324. <remarks>
  325. <attribution license="cc4" from="Microsoft" modified="false" />
  326. <para>This constructor creates a <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> object that has the following characteristics:</para>
  327. <list type="bullet">
  328. <item>
  329. <para>No additional pipe security. </para>
  330. </item>
  331. <item>
  332. <para>A default <see cref="T:System.IO.HandleInheritability" /> value of <see cref="F:System.IO.HandleInheritability.None" />. </para>
  333. </item>
  334. <item>
  335. <para>No specified additional <see cref="T:System.IO.Pipes.PipeAccessRights" />.</para>
  336. </item>
  337. </list>
  338. </remarks>
  339. <summary>
  340. <attribution license="cc4" from="Microsoft" modified="false" />
  341. <para>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> class with the specified pipe name, pipe direction, maximum number of server instances, transmission mode, pipe options, and recommended in and out buffer sizes.</para>
  342. </summary>
  343. <param name="pipeName">
  344. <attribution license="cc4" from="Microsoft" modified="false" />The name of the pipe.</param>
  345. <param name="direction">
  346. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines the direction of the pipe.</param>
  347. <param name="maxNumberOfServerInstances">
  348. <attribution license="cc4" from="Microsoft" modified="false" />The maximum number of server instances that share the same name. You can pass <see cref="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances" /> for this value.</param>
  349. <param name="transmissionMode">
  350. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines the transmission mode of the pipe.</param>
  351. <param name="options">
  352. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines how to open or create the pipe.</param>
  353. <param name="inBufferSize">
  354. <attribution license="cc4" from="Microsoft" modified="false" />A positive value greater than 0 that indicates the input buffer size.</param>
  355. <param name="outBufferSize">
  356. <attribution license="cc4" from="Microsoft" modified="false" />A positive value greater than 0 that indicates the output buffer size.</param>
  357. </Docs>
  358. </Member>
  359. <Member MemberName=".ctor">
  360. <MemberSignature Language="C#" Value="public NamedPipeServerStream (string pipeName, System.IO.Pipes.PipeDirection direction, int maxNumberOfServerInstances, System.IO.Pipes.PipeTransmissionMode transmissionMode, System.IO.Pipes.PipeOptions options, int inBufferSize, int outBufferSize, System.IO.Pipes.PipeSecurity pipeSecurity);" />
  361. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string pipeName, valuetype System.IO.Pipes.PipeDirection direction, int32 maxNumberOfServerInstances, valuetype System.IO.Pipes.PipeTransmissionMode transmissionMode, valuetype System.IO.Pipes.PipeOptions options, int32 inBufferSize, int32 outBufferSize, class System.IO.Pipes.PipeSecurity pipeSecurity) cil managed" />
  362. <MemberType>Constructor</MemberType>
  363. <AssemblyInfo>
  364. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  365. </AssemblyInfo>
  366. <Parameters>
  367. <Parameter Name="pipeName" Type="System.String" />
  368. <Parameter Name="direction" Type="System.IO.Pipes.PipeDirection" />
  369. <Parameter Name="maxNumberOfServerInstances" Type="System.Int32" />
  370. <Parameter Name="transmissionMode" Type="System.IO.Pipes.PipeTransmissionMode" />
  371. <Parameter Name="options" Type="System.IO.Pipes.PipeOptions" />
  372. <Parameter Name="inBufferSize" Type="System.Int32" />
  373. <Parameter Name="outBufferSize" Type="System.Int32" />
  374. <Parameter Name="pipeSecurity" Type="System.IO.Pipes.PipeSecurity" />
  375. </Parameters>
  376. <Docs>
  377. <remarks>
  378. <attribution license="cc4" from="Microsoft" modified="false" />
  379. <para>This constructor creates a <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> object that has the following characteristics:</para>
  380. <list type="bullet">
  381. <item>
  382. <para>A default <see cref="T:System.IO.HandleInheritability" /> value of <see cref="F:System.IO.HandleInheritability.None" />. </para>
  383. </item>
  384. <item>
  385. <para>No specified additional <see cref="T:System.IO.Pipes.PipeAccessRights" />.</para>
  386. </item>
  387. </list>
  388. </remarks>
  389. <summary>
  390. <attribution license="cc4" from="Microsoft" modified="false" />
  391. <para>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> class with the specified pipe name, pipe direction, maximum number of server instances, transmission mode, pipe options, recommended in and out buffer sizes, and pipe security.</para>
  392. </summary>
  393. <param name="pipeName">
  394. <attribution license="cc4" from="Microsoft" modified="false" />The name of the pipe.</param>
  395. <param name="direction">
  396. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines the direction of the pipe.</param>
  397. <param name="maxNumberOfServerInstances">
  398. <attribution license="cc4" from="Microsoft" modified="false" />The maximum number of server instances that share the same name. You can pass <see cref="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances" /> for this value.</param>
  399. <param name="transmissionMode">
  400. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines the transmission mode of the pipe.</param>
  401. <param name="options">
  402. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines how to open or create the pipe.</param>
  403. <param name="inBufferSize">
  404. <attribution license="cc4" from="Microsoft" modified="false" />A positive value greater than 0 that indicates the input buffer size.</param>
  405. <param name="outBufferSize">
  406. <attribution license="cc4" from="Microsoft" modified="false" />A positive value greater than 0 that indicates the output buffer size.</param>
  407. <param name="pipeSecurity">
  408. <attribution license="cc4" from="Microsoft" modified="false" />An object that determines the access control and audit security for the pipe.</param>
  409. </Docs>
  410. </Member>
  411. <Member MemberName=".ctor">
  412. <MemberSignature Language="C#" Value="public NamedPipeServerStream (string pipeName, System.IO.Pipes.PipeDirection direction, int maxNumberOfServerInstances, System.IO.Pipes.PipeTransmissionMode transmissionMode, System.IO.Pipes.PipeOptions options, int inBufferSize, int outBufferSize, System.IO.Pipes.PipeSecurity pipeSecurity, System.IO.HandleInheritability inheritability);" />
  413. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string pipeName, valuetype System.IO.Pipes.PipeDirection direction, int32 maxNumberOfServerInstances, valuetype System.IO.Pipes.PipeTransmissionMode transmissionMode, valuetype System.IO.Pipes.PipeOptions options, int32 inBufferSize, int32 outBufferSize, class System.IO.Pipes.PipeSecurity pipeSecurity, valuetype System.IO.HandleInheritability inheritability) cil managed" />
  414. <MemberType>Constructor</MemberType>
  415. <AssemblyInfo>
  416. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  417. </AssemblyInfo>
  418. <Parameters>
  419. <Parameter Name="pipeName" Type="System.String" />
  420. <Parameter Name="direction" Type="System.IO.Pipes.PipeDirection" />
  421. <Parameter Name="maxNumberOfServerInstances" Type="System.Int32" />
  422. <Parameter Name="transmissionMode" Type="System.IO.Pipes.PipeTransmissionMode" />
  423. <Parameter Name="options" Type="System.IO.Pipes.PipeOptions" />
  424. <Parameter Name="inBufferSize" Type="System.Int32" />
  425. <Parameter Name="outBufferSize" Type="System.Int32" />
  426. <Parameter Name="pipeSecurity" Type="System.IO.Pipes.PipeSecurity" />
  427. <Parameter Name="inheritability" Type="System.IO.HandleInheritability" />
  428. </Parameters>
  429. <Docs>
  430. <remarks>
  431. <attribution license="cc4" from="Microsoft" modified="false" />
  432. <para>This constructor creates a <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> object that has no specified additional <see cref="T:System.IO.Pipes.PipeAccessRights" />.</para>
  433. </remarks>
  434. <summary>
  435. <attribution license="cc4" from="Microsoft" modified="false" />
  436. <para>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> class with the specified pipe name, pipe direction, maximum number of server instances, transmission mode, pipe options, recommended in and out buffer sizes, pipe security, and inheritability mode.</para>
  437. </summary>
  438. <param name="pipeName">
  439. <attribution license="cc4" from="Microsoft" modified="false" />The name of the pipe.</param>
  440. <param name="direction">
  441. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines the direction of the pipe.</param>
  442. <param name="maxNumberOfServerInstances">
  443. <attribution license="cc4" from="Microsoft" modified="false" />The maximum number of server instances that share the same name. You can pass <see cref="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances" /> for this value.</param>
  444. <param name="transmissionMode">
  445. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines the transmission mode of the pipe.</param>
  446. <param name="options">
  447. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines how to open or create the pipe.</param>
  448. <param name="inBufferSize">
  449. <attribution license="cc4" from="Microsoft" modified="false" />A positive value greater than 0 that indicates the input buffer size.</param>
  450. <param name="outBufferSize">
  451. <attribution license="cc4" from="Microsoft" modified="false" />A positive value greater than 0 that indicates the output buffer size.</param>
  452. <param name="pipeSecurity">
  453. <attribution license="cc4" from="Microsoft" modified="false" />An object that determines the access control and audit security for the pipe.</param>
  454. <param name="inheritability">
  455. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines whether the underlying handle can be inherited by child processes.</param>
  456. </Docs>
  457. </Member>
  458. <Member MemberName=".ctor">
  459. <MemberSignature Language="C#" Value="public NamedPipeServerStream (string pipeName, System.IO.Pipes.PipeDirection direction, int maxNumberOfServerInstances, System.IO.Pipes.PipeTransmissionMode transmissionMode, System.IO.Pipes.PipeOptions options, int inBufferSize, int outBufferSize, System.IO.Pipes.PipeSecurity pipeSecurity, System.IO.HandleInheritability inheritability, System.IO.Pipes.PipeAccessRights additionalAccessRights);" />
  460. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string pipeName, valuetype System.IO.Pipes.PipeDirection direction, int32 maxNumberOfServerInstances, valuetype System.IO.Pipes.PipeTransmissionMode transmissionMode, valuetype System.IO.Pipes.PipeOptions options, int32 inBufferSize, int32 outBufferSize, class System.IO.Pipes.PipeSecurity pipeSecurity, valuetype System.IO.HandleInheritability inheritability, valuetype System.IO.Pipes.PipeAccessRights additionalAccessRights) cil managed" />
  461. <MemberType>Constructor</MemberType>
  462. <AssemblyInfo>
  463. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  464. </AssemblyInfo>
  465. <Attributes>
  466. <Attribute>
  467. <AttributeName>System.MonoTODO</AttributeName>
  468. </Attribute>
  469. </Attributes>
  470. <Parameters>
  471. <Parameter Name="pipeName" Type="System.String" />
  472. <Parameter Name="direction" Type="System.IO.Pipes.PipeDirection" />
  473. <Parameter Name="maxNumberOfServerInstances" Type="System.Int32" />
  474. <Parameter Name="transmissionMode" Type="System.IO.Pipes.PipeTransmissionMode" />
  475. <Parameter Name="options" Type="System.IO.Pipes.PipeOptions" />
  476. <Parameter Name="inBufferSize" Type="System.Int32" />
  477. <Parameter Name="outBufferSize" Type="System.Int32" />
  478. <Parameter Name="pipeSecurity" Type="System.IO.Pipes.PipeSecurity" />
  479. <Parameter Name="inheritability" Type="System.IO.HandleInheritability" />
  480. <Parameter Name="additionalAccessRights" Type="System.IO.Pipes.PipeAccessRights" />
  481. </Parameters>
  482. <Docs>
  483. <remarks>To be added.</remarks>
  484. <summary>
  485. <attribution license="cc4" from="Microsoft" modified="false" />
  486. <para>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> class with the specified pipe name, pipe direction, maximum number of server instances, transmission mode, pipe options, recommended in and out buffer sizes, pipe security, inheritability mode, and pipe access rights.</para>
  487. </summary>
  488. <param name="pipeName">
  489. <attribution license="cc4" from="Microsoft" modified="false" />The name of the pipe.</param>
  490. <param name="direction">
  491. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines the direction of the pipe.</param>
  492. <param name="maxNumberOfServerInstances">
  493. <attribution license="cc4" from="Microsoft" modified="false" />The maximum number of server instances that share the same name. You can pass <see cref="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances" /> for this value.</param>
  494. <param name="transmissionMode">
  495. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines the transmission mode of the pipe.</param>
  496. <param name="options">
  497. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines how to open or create the pipe.</param>
  498. <param name="inBufferSize">
  499. <attribution license="cc4" from="Microsoft" modified="false" />The input buffer size.</param>
  500. <param name="outBufferSize">
  501. <attribution license="cc4" from="Microsoft" modified="false" />The output buffer size.</param>
  502. <param name="pipeSecurity">
  503. <attribution license="cc4" from="Microsoft" modified="false" />An object that determines the access control and audit security for the pipe.</param>
  504. <param name="inheritability">
  505. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that determines whether the underlying handle can be inherited by child processes.</param>
  506. <param name="additionalAccessRights">
  507. <attribution license="cc4" from="Microsoft" modified="false" />One of the enumeration values that specifies the access rights of the pipe.</param>
  508. </Docs>
  509. </Member>
  510. <Member MemberName="BeginWaitForConnection">
  511. <MemberSignature Language="C#" Value="public IAsyncResult BeginWaitForConnection (AsyncCallback callback, object state);" />
  512. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.IAsyncResult BeginWaitForConnection(class System.AsyncCallback callback, object state) cil managed" />
  513. <MemberType>Method</MemberType>
  514. <AssemblyInfo>
  515. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  516. </AssemblyInfo>
  517. <ReturnValue>
  518. <ReturnType>System.IAsyncResult</ReturnType>
  519. </ReturnValue>
  520. <Parameters>
  521. <Parameter Name="callback" Type="System.AsyncCallback" />
  522. <Parameter Name="state" Type="System.Object" />
  523. </Parameters>
  524. <Docs>
  525. <remarks>
  526. <attribution license="cc4" from="Microsoft" modified="false" />
  527. <para>This is the asynchronous equivalent of <see cref="M:System.IO.Pipes.NamedPipeServerStream.WaitForConnection" />.</para>
  528. <para>
  529. <see cref="M:System.IO.Pipes.NamedPipeServerStream.EndWaitForConnection(System.IAsyncResult)" /> must be called exactly once for every call to <see cref="M:System.IO.Pipes.NamedPipeServerStream.BeginWaitForConnection(System.AsyncCallback,System.Object)" />.</para>
  530. </remarks>
  531. <summary>
  532. <attribution license="cc4" from="Microsoft" modified="false" />
  533. <para>Begins an asynchronous operation to wait for a client to connect.</para>
  534. </summary>
  535. <returns>
  536. <attribution license="cc4" from="Microsoft" modified="false" />
  537. <para>An object that references the asynchronous request.</para>
  538. </returns>
  539. <param name="callback">
  540. <attribution license="cc4" from="Microsoft" modified="false" />The method to call when a client connects to the <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> object.</param>
  541. <param name="state">
  542. <attribution license="cc4" from="Microsoft" modified="false" />A user-provided object that distinguishes this particular asynchronous request from other requests.</param>
  543. </Docs>
  544. </Member>
  545. <Member MemberName="Disconnect">
  546. <MemberSignature Language="C#" Value="public void Disconnect ();" />
  547. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Disconnect() cil managed" />
  548. <MemberType>Method</MemberType>
  549. <AssemblyInfo>
  550. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  551. </AssemblyInfo>
  552. <ReturnValue>
  553. <ReturnType>System.Void</ReturnType>
  554. </ReturnValue>
  555. <Parameters />
  556. <Docs>
  557. <remarks>
  558. <attribution license="cc4" from="Microsoft" modified="false" />
  559. <para>Calling the <see cref="M:System.IO.Pipes.NamedPipeServerStream.Disconnect" /> method will block until all the sent characters have been read unless the transmission mode of the pipe is set to <see cref="F:System.IO.Pipes.PipeTransmissionMode.Message" /> and the buffer size is set in the constructor that created the <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> object. In this case, not all of the messages will be received. Calling <see cref="M:System.IO.Pipes.PipeStream.WaitForPipeDrain" /> causes the server to block until all the data has been read from the pipe.</para>
  560. </remarks>
  561. <summary>
  562. <attribution license="cc4" from="Microsoft" modified="false" />
  563. <para>Disconnects the current connection.</para>
  564. </summary>
  565. </Docs>
  566. </Member>
  567. <Member MemberName="EndWaitForConnection">
  568. <MemberSignature Language="C#" Value="public void EndWaitForConnection (IAsyncResult asyncResult);" />
  569. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void EndWaitForConnection(class System.IAsyncResult asyncResult) cil managed" />
  570. <MemberType>Method</MemberType>
  571. <AssemblyInfo>
  572. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  573. </AssemblyInfo>
  574. <ReturnValue>
  575. <ReturnType>System.Void</ReturnType>
  576. </ReturnValue>
  577. <Parameters>
  578. <Parameter Name="asyncResult" Type="System.IAsyncResult" />
  579. </Parameters>
  580. <Docs>
  581. <remarks>
  582. <attribution license="cc4" from="Microsoft" modified="false" />
  583. <para>
  584. <see cref="M:System.IO.Pipes.NamedPipeServerStream.EndWaitForConnection(System.IAsyncResult)" /> must be called exactly once for every call to <see cref="M:System.IO.Pipes.NamedPipeServerStream.BeginWaitForConnection(System.AsyncCallback,System.Object)" />.</para>
  585. </remarks>
  586. <summary>
  587. <attribution license="cc4" from="Microsoft" modified="false" />
  588. <para>Ends an asynchronous operation to wait for a client to connect.</para>
  589. </summary>
  590. <param name="asyncResult">
  591. <attribution license="cc4" from="Microsoft" modified="false" />The pending asynchronous request.</param>
  592. </Docs>
  593. </Member>
  594. <Member MemberName="GetImpersonationUserName">
  595. <MemberSignature Language="C#" Value="public string GetImpersonationUserName ();" />
  596. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetImpersonationUserName() cil managed" />
  597. <MemberType>Method</MemberType>
  598. <AssemblyInfo>
  599. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  600. </AssemblyInfo>
  601. <Attributes>
  602. <Attribute>
  603. <AttributeName>System.MonoTODO</AttributeName>
  604. </Attribute>
  605. </Attributes>
  606. <ReturnValue>
  607. <ReturnType>System.String</ReturnType>
  608. </ReturnValue>
  609. <Parameters />
  610. <Docs>
  611. <remarks>
  612. <attribution license="cc4" from="Microsoft" modified="false" />
  613. <para>The <see cref="M:System.IO.Pipes.NamedPipeServerStream.GetImpersonationUserName" /> method returns null if the client has not yet written to the pipe or if the connected client did not connect with a <see cref="T:System.Security.Principal.TokenImpersonationLevel" /> of <see cref="F:System.Security.Principal.TokenImpersonationLevel.Impersonation" />.</para>
  614. </remarks>
  615. <summary>
  616. <attribution license="cc4" from="Microsoft" modified="false" />
  617. <para>Gets the user name of the client on the other end of the pipe.</para>
  618. </summary>
  619. <returns>
  620. <attribution license="cc4" from="Microsoft" modified="false" />
  621. <para>The user name of the client on the other end of the pipe.</para>
  622. </returns>
  623. </Docs>
  624. </Member>
  625. <Member MemberName="MaxAllowedServerInstances">
  626. <MemberSignature Language="C#" Value="public const int MaxAllowedServerInstances = -1;" />
  627. <MemberSignature Language="ILAsm" Value=".field public static literal int32 MaxAllowedServerInstances = (-1)" />
  628. <MemberType>Field</MemberType>
  629. <AssemblyInfo>
  630. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  631. </AssemblyInfo>
  632. <ReturnValue>
  633. <ReturnType>System.Int32</ReturnType>
  634. </ReturnValue>
  635. <MemberValue>-1</MemberValue>
  636. <Docs>
  637. <remarks>
  638. <attribution license="cc4" from="Microsoft" modified="false" />
  639. <para>Use the <see cref="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances" /> when creating a <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> object to set the maximum number of server instances that the system resources allow.</para>
  640. </remarks>
  641. <summary>
  642. <attribution license="cc4" from="Microsoft" modified="false" />
  643. <para>Represents the maximum number of server instances that the system resources allow.</para>
  644. </summary>
  645. </Docs>
  646. </Member>
  647. <Member MemberName="RunAsClient">
  648. <MemberSignature Language="C#" Value="public void RunAsClient (System.IO.Pipes.PipeStreamImpersonationWorker impersonationWorker);" />
  649. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RunAsClient(class System.IO.Pipes.PipeStreamImpersonationWorker impersonationWorker) cil managed" />
  650. <MemberType>Method</MemberType>
  651. <AssemblyInfo>
  652. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  653. </AssemblyInfo>
  654. <Attributes>
  655. <Attribute>
  656. <AttributeName>System.MonoTODO</AttributeName>
  657. </Attribute>
  658. </Attributes>
  659. <ReturnValue>
  660. <ReturnType>System.Void</ReturnType>
  661. </ReturnValue>
  662. <Parameters>
  663. <Parameter Name="impersonationWorker" Type="System.IO.Pipes.PipeStreamImpersonationWorker" />
  664. </Parameters>
  665. <Docs>
  666. <remarks>
  667. <attribution license="cc4" from="Microsoft" modified="false" />
  668. <para>The connecting client's permissions are applied to the remote server. For example, if the connecting client tries to request the contents of a file on the server, the client can request only files that it has sufficient permissions to open.</para>
  669. </remarks>
  670. <summary>
  671. <attribution license="cc4" from="Microsoft" modified="false" />
  672. <para>Calls a delegate while impersonating the client.</para>
  673. </summary>
  674. <param name="impersonationWorker">
  675. <attribution license="cc4" from="Microsoft" modified="false" />The delegate that specifies a method to call.</param>
  676. </Docs>
  677. </Member>
  678. <Member MemberName="WaitForConnection">
  679. <MemberSignature Language="C#" Value="public void WaitForConnection ();" />
  680. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WaitForConnection() cil managed" />
  681. <MemberType>Method</MemberType>
  682. <AssemblyInfo>
  683. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  684. </AssemblyInfo>
  685. <ReturnValue>
  686. <ReturnType>System.Void</ReturnType>
  687. </ReturnValue>
  688. <Parameters />
  689. <Docs>
  690. <remarks>
  691. <attribution license="cc4" from="Microsoft" modified="false" />
  692. <para>Calling this method causes the <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> object to block until a client connects.</para>
  693. </remarks>
  694. <summary>
  695. <attribution license="cc4" from="Microsoft" modified="false" />
  696. <para>Waits for a client to connect to this <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> object.</para>
  697. </summary>
  698. </Docs>
  699. </Member>
  700. </Members>
  701. </Type>