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.
 
 
 
 
 
 

2116 lines
101 KiB

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Pipelines.Sockets.Unofficial</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Pipelines.Sockets.Unofficial.Arenas.Allocator`1">
  8. <summary>
  9. Allocates blocks of memory
  10. </summary>
  11. </member>
  12. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Allocator`1.Allocate(System.Int32)">
  13. <summary>
  14. Allocate a new block
  15. </summary>
  16. </member>
  17. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Allocator`1.Clear(System.Buffers.IMemoryOwner{`0},System.Int32)">
  18. <summary>
  19. Clear (zero) the supplied region
  20. </summary>
  21. </member>
  22. <member name="T:Pipelines.Sockets.Unofficial.Arenas.ArrayPoolAllocator`1">
  23. <summary>
  24. An allocator that rents memory from the array-pool provided, returning them to the pool when done
  25. </summary>
  26. </member>
  27. <member name="P:Pipelines.Sockets.Unofficial.Arenas.ArrayPoolAllocator`1.Shared">
  28. <summary>
  29. An array-pool allocator that uses the shared array-pool
  30. </summary>
  31. </member>
  32. <member name="M:Pipelines.Sockets.Unofficial.Arenas.ArrayPoolAllocator`1.#ctor(System.Buffers.ArrayPool{`0})">
  33. <summary>
  34. Create a new array-pool allocator that uses the provided array pool (or the shared array-pool otherwise)
  35. </summary>
  36. </member>
  37. <member name="M:Pipelines.Sockets.Unofficial.Arenas.ArrayPoolAllocator`1.Allocate(System.Int32)">
  38. <summary>
  39. Allocate a new block
  40. </summary>
  41. </member>
  42. <member name="P:Pipelines.Sockets.Unofficial.Arenas.PinnedArrayPoolAllocator`1.Shared">
  43. <summary>
  44. An array-pool allocator that uses the shared array-pool
  45. </summary>
  46. </member>
  47. <member name="T:Pipelines.Sockets.Unofficial.Arenas.UnmanagedAllocator`1">
  48. <summary>
  49. An allocator that allocates unmanaged memory, releasing the memory back to the OS when done
  50. </summary>
  51. </member>
  52. <member name="P:Pipelines.Sockets.Unofficial.Arenas.UnmanagedAllocator`1.Shared">
  53. <summary>
  54. The global instance of the unmanaged allocator
  55. </summary>
  56. </member>
  57. <member name="M:Pipelines.Sockets.Unofficial.Arenas.UnmanagedAllocator`1.Allocate(System.Int32)">
  58. <summary>
  59. Allocate a new block
  60. </summary>
  61. </member>
  62. <member name="T:Pipelines.Sockets.Unofficial.Arenas.ArenaOptions">
  63. <summary>
  64. Options that configure the behahaviour of an arena
  65. </summary>
  66. </member>
  67. <member name="P:Pipelines.Sockets.Unofficial.Arenas.ArenaOptions.Default">
  68. <summary>
  69. The default arena configuration
  70. </summary>
  71. </member>
  72. <member name="P:Pipelines.Sockets.Unofficial.Arenas.ArenaOptions.Flags">
  73. <summary>
  74. The flags that are enabled for the arena
  75. </summary>
  76. </member>
  77. <member name="M:Pipelines.Sockets.Unofficial.Arenas.ArenaOptions.HasFlag(Pipelines.Sockets.Unofficial.Arenas.ArenaFlags)">
  78. <summary>
  79. Tests an individual flag
  80. </summary>
  81. </member>
  82. <member name="P:Pipelines.Sockets.Unofficial.Arenas.ArenaOptions.BlockSizeBytes">
  83. <summary>
  84. The block-size to suggest for new allocations in the arena
  85. </summary>
  86. </member>
  87. <member name="P:Pipelines.Sockets.Unofficial.Arenas.ArenaOptions.RetentionPolicy">
  88. <summary>
  89. The policy for retaining allocations when memory requirements decrease
  90. </summary>
  91. </member>
  92. <member name="M:Pipelines.Sockets.Unofficial.Arenas.ArenaOptions.#ctor(Pipelines.Sockets.Unofficial.Arenas.ArenaFlags,System.Int32,System.Func{System.Int64,System.Int64,System.Int64})">
  93. <summary>
  94. Create a new ArenaOptions instance
  95. </summary>
  96. </member>
  97. <member name="T:Pipelines.Sockets.Unofficial.Arenas.AllocatorFactory">
  98. <summary>
  99. Provides facilities to create new type-specific allocators for use in an arena
  100. </summary>
  101. </member>
  102. <member name="P:Pipelines.Sockets.Unofficial.Arenas.AllocatorFactory.Default">
  103. <summary>
  104. The default allocator factory
  105. </summary>
  106. </member>
  107. <member name="M:Pipelines.Sockets.Unofficial.Arenas.AllocatorFactory.SuggestAllocator``1(Pipelines.Sockets.Unofficial.Arenas.ArenaOptions)">
  108. <summary>
  109. Suggest an allocator for any type
  110. </summary>
  111. </member>
  112. <member name="M:Pipelines.Sockets.Unofficial.Arenas.AllocatorFactory.SuggestBlittableAllocator``1(Pipelines.Sockets.Unofficial.Arenas.ArenaOptions)">
  113. <summary>
  114. Suggest an allocator for a blittable type
  115. </summary>
  116. </member>
  117. <member name="M:Pipelines.Sockets.Unofficial.Arenas.AllocatorFactory.SuggestBlockSizeBytes``1(Pipelines.Sockets.Unofficial.Arenas.ArenaOptions)">
  118. <summary>
  119. Suggest a per-type block size (in bytes) to use for allocations
  120. </summary>
  121. </member>
  122. <member name="T:Pipelines.Sockets.Unofficial.Arenas.OwnedArena`1">
  123. <summary>
  124. Represents a typed subset of data within an arena
  125. </summary>
  126. </member>
  127. <member name="M:Pipelines.Sockets.Unofficial.Arenas.OwnedArena`1.Allocate(System.Int32)">
  128. <summary>
  129. Allocate a (possibly non-contiguous) region of memory from the arena
  130. </summary>
  131. </member>
  132. <member name="M:Pipelines.Sockets.Unofficial.Arenas.OwnedArena`1.Allocate">
  133. <summary>
  134. Allocate a single instance as a reference
  135. </summary>
  136. </member>
  137. <member name="M:Pipelines.Sockets.Unofficial.Arenas.OwnedArena`1.Allocate(System.Collections.Generic.IEnumerable{`0})">
  138. <summary>
  139. Allocate a (possibly non-contiguous) region of memory from the arena
  140. </summary>
  141. </member>
  142. <member name="T:Pipelines.Sockets.Unofficial.Arenas.Arena">
  143. <summary>
  144. An arena allocator that can allocate sequences for multiple data types
  145. </summary>
  146. </member>
  147. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Arena.#ctor(Pipelines.Sockets.Unofficial.Arenas.ArenaOptions,Pipelines.Sockets.Unofficial.Arenas.AllocatorFactory)">
  148. <summary>
  149. Create a new Arena instance
  150. </summary>
  151. </member>
  152. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Arena.Dispose">
  153. <summary>
  154. Release all resources associated with this arena
  155. </summary>
  156. </member>
  157. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Arena.Reset">
  158. <summary>
  159. Reset the memory allocated by this arena
  160. </summary>
  161. </member>
  162. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Arena.Allocate``1">
  163. <summary>
  164. Allocate a single instance as a reference
  165. </summary>
  166. </member>
  167. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Arena.Allocate``1(System.Int32)">
  168. <summary>
  169. Allocate a (possibly non-contiguous) region of memory from the arena
  170. </summary>
  171. </member>
  172. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Arena.Allocate``1(System.Collections.Generic.IEnumerable{``0})">
  173. <summary>
  174. Allocate a (possibly non-contiguous) region of memory from the arena
  175. </summary>
  176. </member>
  177. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Arena.GetArena``1">
  178. <summary>
  179. Get a per-type arena inside a multi-type arena
  180. </summary>
  181. </member>
  182. <member name="T:Pipelines.Sockets.Unofficial.Arenas.ArenaFlags">
  183. <summary>
  184. Flags that impact behaviour of the arena
  185. </summary>
  186. </member>
  187. <member name="F:Pipelines.Sockets.Unofficial.Arenas.ArenaFlags.None">
  188. <summary>
  189. None
  190. </summary>
  191. </member>
  192. <member name="F:Pipelines.Sockets.Unofficial.Arenas.ArenaFlags.ClearAtReset">
  193. <summary>
  194. Allocations are cleared at each reset (and when initially allocated), so that they are always wiped before use
  195. </summary>
  196. </member>
  197. <member name="F:Pipelines.Sockets.Unofficial.Arenas.ArenaFlags.ClearAtDispose">
  198. <summary>
  199. Allocations are cleared when the arena is disposed (or when data is released in line with the retention policy), so that the contents are not released back to the underlying allocator
  200. </summary>
  201. </member>
  202. <member name="F:Pipelines.Sockets.Unofficial.Arenas.ArenaFlags.PreferUnmanaged">
  203. <summary>
  204. When possible, and when no allocator is explicitly provided; prefer using unmanaged memory
  205. </summary>
  206. </member>
  207. <member name="F:Pipelines.Sockets.Unofficial.Arenas.ArenaFlags.PreferPinned">
  208. <summary>
  209. When possible, use pinned memory
  210. </summary>
  211. </member>
  212. <member name="F:Pipelines.Sockets.Unofficial.Arenas.ArenaFlags.BlittableNonPaddedSharing">
  213. <summary>
  214. Allow blittable types of the same size to share a pool of data (only applies to multi-type arenas)
  215. </summary>
  216. </member>
  217. <member name="F:Pipelines.Sockets.Unofficial.Arenas.ArenaFlags.BlittablePaddedSharing">
  218. <summary>
  219. Allow blittable types to all share a single pool of byte-data, using padding to align (only applies to multi-type arenas, and for reasonably sized types)
  220. </summary>
  221. </member>
  222. <member name="T:Pipelines.Sockets.Unofficial.Arenas.Arena`1">
  223. <summary>
  224. Represents a lifetime-bound allocator of multiple non-contiguous memory regions
  225. </summary>
  226. </member>
  227. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Arena`1.AllocatedBytes">
  228. <summary>
  229. The number of elements allocated since the last reset
  230. </summary>
  231. </member>
  232. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Arena`1.#ctor(Pipelines.Sockets.Unofficial.Arenas.ArenaOptions,Pipelines.Sockets.Unofficial.Arenas.Allocator{`0})">
  233. <summary>
  234. Create a new Arena
  235. </summary>
  236. </member>
  237. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Arena`1.Allocate(System.Int32)">
  238. <summary>
  239. Allocate a (possibly non-contiguous) region of memory from the arena
  240. </summary>
  241. </member>
  242. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Arena`1.Allocate(System.Int64)">
  243. <summary>
  244. Allocate a (possibly non-contiguous) region of memory from the arena
  245. </summary>
  246. </member>
  247. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Arena`1.Allocate(System.Collections.Generic.IEnumerable{`0})">
  248. <summary>
  249. Allocate a (possibly non-contiguous) region of memory from the arena
  250. </summary>
  251. </member>
  252. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Arena`1.Allocate">
  253. <summary>
  254. Allocate a reference to a new instance from the arena
  255. </summary>
  256. </member>
  257. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Arena`1.Reset">
  258. <summary>
  259. Resets the arena; all current allocations should be considered invalid - new allocations may overwrite them
  260. </summary>
  261. </member>
  262. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Arena`1.Dispose">
  263. <summary>
  264. Releases all resources associated with the arena
  265. </summary>
  266. </member>
  267. <member name="T:Pipelines.Sockets.Unofficial.Arenas.Reference`1">
  268. <summary>
  269. Acts as a fly-weight reference into existing data
  270. </summary>
  271. </member>
  272. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Reference`1.ToString">
  273. <summary>
  274. Obtain a text representation of the value
  275. </summary>
  276. </member>
  277. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Reference`1.Equals(System.Object)">
  278. <summary>
  279. Used to compare two instances for equality
  280. </summary>
  281. </member>
  282. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Reference`1.Equals(Pipelines.Sockets.Unofficial.Arenas.Reference{`0}@)">
  283. <summary>
  284. Used to compare two instances for equality
  285. </summary>
  286. </member>
  287. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Reference`1.GetHashCode">
  288. <summary>
  289. Used to compare two instances for equality
  290. </summary>
  291. </member>
  292. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Reference`1.#ctor(`0[],System.Int32)">
  293. <summary>
  294. Create a new reference into an array
  295. </summary>
  296. </member>
  297. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Reference`1.#ctor(System.Memory{`0},System.Int32)">
  298. <summary>
  299. Create a new reference into a memory
  300. </summary>
  301. </member>
  302. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Reference`1.Value">
  303. <summary>
  304. Get a reference to the underlying value
  305. </summary>
  306. </member>
  307. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Reference`1.op_Implicit(Pipelines.Sockets.Unofficial.Arenas.Reference{`0}@)~`0">
  308. <summary>
  309. Convert a reference to the underlying type
  310. </summary>
  311. </member>
  312. <member name="T:Pipelines.Sockets.Unofficial.Arenas.RetentionPolicy">
  313. <summary>
  314. Provides common retention policies
  315. </summary>
  316. </member>
  317. <member name="P:Pipelines.Sockets.Unofficial.Arenas.RetentionPolicy.Default">
  318. <summary>
  319. The default retention policy
  320. </summary>
  321. </member>
  322. <member name="P:Pipelines.Sockets.Unofficial.Arenas.RetentionPolicy.Recent">
  323. <summary>
  324. Retain the space required by the previous operation (trim to the size of the last usage)
  325. </summary>
  326. </member>
  327. <member name="P:Pipelines.Sockets.Unofficial.Arenas.RetentionPolicy.Nothing">
  328. <summary>
  329. Retain nothing (trim aggressively)
  330. </summary>
  331. </member>
  332. <member name="P:Pipelines.Sockets.Unofficial.Arenas.RetentionPolicy.Everything">
  333. <summary>
  334. Retain everything (grow only)
  335. </summary>
  336. </member>
  337. <member name="M:Pipelines.Sockets.Unofficial.Arenas.RetentionPolicy.Decay(System.Single)">
  338. <summary>
  339. When the required usage drops, decay the retained amount exponentially; growth is instant
  340. </summary>
  341. </member>
  342. <member name="T:Pipelines.Sockets.Unofficial.Arenas.Sequence">
  343. <summary>
  344. Represents a Sequence without needing to know the type at compile-time
  345. </summary>
  346. </member>
  347. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence.Empty``1">
  348. <summary>
  349. Returns an empty sequence of the supplied type
  350. </summary>
  351. </member>
  352. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence.Equals(System.Object)">
  353. <summary>
  354. Tests two sequences for equality
  355. </summary>
  356. </member>
  357. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence.System#IEquatable{Pipelines#Sockets#Unofficial#Arenas#Sequence}#Equals(Pipelines.Sockets.Unofficial.Arenas.Sequence)">
  358. <summary>
  359. Tests two sequences for equality
  360. </summary>
  361. </member>
  362. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence.Equals(Pipelines.Sockets.Unofficial.Arenas.Sequence@)">
  363. <summary>
  364. Tests two sequences for equality
  365. </summary>
  366. </member>
  367. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence.GetHashCode">
  368. <summary>
  369. Used for equality operations
  370. </summary>
  371. </member>
  372. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence.ToString">
  373. <summary>
  374. Summarizes a sequence as a string
  375. </summary>
  376. </member>
  377. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence.op_Equality(Pipelines.Sockets.Unofficial.Arenas.Sequence@,Pipelines.Sockets.Unofficial.Arenas.Sequence@)">
  378. <summary>
  379. Tests two sequences for equality
  380. </summary>
  381. </member>
  382. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence.op_Inequality(Pipelines.Sockets.Unofficial.Arenas.Sequence@,Pipelines.Sockets.Unofficial.Arenas.Sequence@)">
  383. <summary>
  384. Tests two sequences for equality
  385. </summary>
  386. </member>
  387. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Sequence.IsSingleSegment">
  388. <summary>
  389. Indicates whether the sequence involves multiple segments, vs whether all the data fits into the first segment
  390. </summary>
  391. </member>
  392. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Sequence.Length">
  393. <summary>
  394. Indicates the number of elements in the sequence
  395. </summary>
  396. </member>
  397. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Sequence.IsEmpty">
  398. <summary>
  399. Indicates whether the sequence is empty (zero elements)
  400. </summary>
  401. </member>
  402. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Sequence.ElementType">
  403. <summary>
  404. Indicates the type of element defined by the sequence
  405. </summary>
  406. </member>
  407. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence.Cast``1">
  408. <summary>
  409. Converts an untyped sequence back to a typed sequence; the type must be correct
  410. </summary>
  411. </member>
  412. <member name="T:Pipelines.Sockets.Unofficial.Arenas.Sequence`1">
  413. <summary>
  414. Represents a (possibly non-contiguous) region of memory; the read/write cousin or ReadOnlySequence-T
  415. </summary>
  416. </member>
  417. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.op_Implicit(Pipelines.Sockets.Unofficial.Arenas.Sequence{`0}@)~Pipelines.Sockets.Unofficial.Arenas.Sequence">
  418. <summary>
  419. Represents a typed sequence as an untyped sequence
  420. </summary>
  421. </member>
  422. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.op_Explicit(Pipelines.Sockets.Unofficial.Arenas.Sequence@)~Pipelines.Sockets.Unofficial.Arenas.Sequence{`0}">
  423. <summary>
  424. Converts an untyped sequence back to a typed sequence; the type must be correct
  425. </summary>
  426. </member>
  427. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.Equals(System.Object)">
  428. <summary>
  429. Tests two sequences for equality
  430. </summary>
  431. </member>
  432. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.System#IEquatable{Pipelines#Sockets#Unofficial#Arenas#Sequence{T}}#Equals(Pipelines.Sockets.Unofficial.Arenas.Sequence{`0})">
  433. <summary>
  434. Tests two sequences for equality
  435. </summary>
  436. </member>
  437. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.Equals(Pipelines.Sockets.Unofficial.Arenas.Sequence{`0}@)">
  438. <summary>
  439. Tests two sequences for equality
  440. </summary>
  441. </member>
  442. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.GetHashCode">
  443. <summary>
  444. Used for equality operations
  445. </summary>
  446. </member>
  447. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.ToString">
  448. <summary>
  449. Summaries a sequence as a string
  450. </summary>
  451. </member>
  452. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.op_Equality(Pipelines.Sockets.Unofficial.Arenas.Sequence{`0}@,Pipelines.Sockets.Unofficial.Arenas.Sequence{`0}@)">
  453. <summary>
  454. Tests two sequences for equality
  455. </summary>
  456. </member>
  457. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.op_Inequality(Pipelines.Sockets.Unofficial.Arenas.Sequence{`0}@,Pipelines.Sockets.Unofficial.Arenas.Sequence{`0}@)">
  458. <summary>
  459. Tests two sequences for equality
  460. </summary>
  461. </member>
  462. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.op_Implicit(Pipelines.Sockets.Unofficial.Arenas.Sequence{`0}@)~System.Buffers.ReadOnlySequence{`0}">
  463. <summary>
  464. Converts a typed sequence to a typed read-only-sequence
  465. </summary>
  466. </member>
  467. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.Item(System.Int32)">
  468. <summary>
  469. Get a reference to an element by index; note that this *can* have
  470. poor performance for multi-segment sequences, but it is usually satisfactory
  471. </summary>
  472. </member>
  473. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.Item(System.Int64)">
  474. <summary>
  475. Get a reference to an element by index; note that this *can* have
  476. poor performance for multi-segment sequences, but it is usually satisfactory
  477. </summary>
  478. </member>
  479. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.GetReference(System.Int64)">
  480. <summary>
  481. Obtains a reference into the segment
  482. </summary>
  483. </member>
  484. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.op_Explicit(System.Buffers.ReadOnlySequence{`0}@)~Pipelines.Sockets.Unofficial.Arenas.Sequence{`0}">
  485. <summary>
  486. Converts a typed sequence to a typed read-only-sequence
  487. </summary>
  488. </member>
  489. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.Untyped">
  490. <summary>
  491. Represents a typed sequence as an untyped sequence
  492. </summary>
  493. </member>
  494. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.AsReadOnly">
  495. <summary>
  496. Converts a typed sequence to a typed read-only-sequence
  497. </summary>
  498. </member>
  499. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.Start">
  500. <summary>
  501. Calculate the start position of the current sequence
  502. </summary>
  503. </member>
  504. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.End">
  505. <summary>
  506. Calculate the end position of the current sequence
  507. </summary>
  508. </member>
  509. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.GetPosition(System.Int64)">
  510. <summary>
  511. Calculate a position inside the current sequence
  512. </summary>
  513. </member>
  514. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.TryGetArray(System.ArraySegment{`0}@)">
  515. <summary>
  516. Try to get the contents as an array
  517. </summary>
  518. </member>
  519. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.Slice(System.Int64)">
  520. <summary>
  521. Obtains a sub-region of a sequence
  522. </summary>
  523. </member>
  524. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.Slice(System.Int64,System.Int64)">
  525. <summary>
  526. Obtains a sub-region of a sequence
  527. </summary>
  528. </member>
  529. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.Slice(System.Range)">
  530. <summary>
  531. Obtains a sub-region of a sequence
  532. </summary>
  533. </member>
  534. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.Item(System.Index)">
  535. <summary>
  536. Get a reference to an element by index; note that this *can* have
  537. poor performance for multi-segment sequences, but it is usually satisfactory
  538. </summary>
  539. </member>
  540. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.TryGetSequence(System.Buffers.ReadOnlySequence{`0}@,Pipelines.Sockets.Unofficial.Arenas.Sequence{`0}@)">
  541. <summary>
  542. Attempts to convert a typed read-only-sequence back to a typed sequence; the sequence must have originated from a valid typed sequence
  543. </summary>
  544. </member>
  545. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.Length">
  546. <summary>
  547. Indicates the number of elements in the sequence
  548. </summary>
  549. </member>
  550. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.IsSingleSegment">
  551. <summary>
  552. Indicates whether the sequence involves multiple segments, vs whether all the data fits into the first segment
  553. </summary>
  554. </member>
  555. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.IsEmpty">
  556. <summary>
  557. Indicates whether the sequence is empty (zero elements)
  558. </summary>
  559. </member>
  560. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.FirstSegment">
  561. <summary>
  562. Obtains the first segment, in terms of a memory
  563. </summary>
  564. </member>
  565. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.FirstSpan">
  566. <summary>
  567. Obtains the first segment, in terms of a span
  568. </summary>
  569. </member>
  570. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.CopyTo(System.Span{`0})">
  571. <summary>
  572. Copy the contents of the sequence into a contiguous region
  573. </summary>
  574. </member>
  575. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.TryCopyTo(System.Span{`0})">
  576. <summary>
  577. If possible, copy the contents of the sequence into a contiguous region
  578. </summary>
  579. </member>
  580. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.#ctor(System.Memory{`0})">
  581. <summary>
  582. Create a new single-segment sequence from a memory
  583. </summary>
  584. </member>
  585. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.#ctor(`0[])">
  586. <summary>
  587. Create a new single-segment sequence from an array
  588. </summary>
  589. </member>
  590. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.#ctor(`0[],System.Int32,System.Int32)">
  591. <summary>
  592. Create a new single-segment sequence from an array
  593. </summary>
  594. </member>
  595. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.Spans">
  596. <summary>
  597. Allows a sequence to be enumerated as spans
  598. </summary>
  599. </member>
  600. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.Segments">
  601. <summary>
  602. Allows a sequence to be enumerated as memory instances
  603. </summary>
  604. </member>
  605. <member name="T:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.SpanEnumerable">
  606. <summary>
  607. Allows a sequence to be enumerated as spans
  608. </summary>
  609. </member>
  610. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.SpanEnumerable.GetEnumerator">
  611. <summary>
  612. Allows a sequence to be enumerated as spans
  613. </summary>
  614. </member>
  615. <member name="T:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.MemoryEnumerable">
  616. <summary>
  617. Allows a sequence to be enumerated as memory instances
  618. </summary>
  619. </member>
  620. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.MemoryEnumerable.GetEnumerator">
  621. <summary>
  622. Allows a sequence to be enumerated as memory instances
  623. </summary>
  624. </member>
  625. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.GetEnumerator">
  626. <summary>
  627. Allows a sequence to be enumerated as values
  628. </summary>
  629. </member>
  630. <member name="T:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.Enumerator">
  631. <summary>
  632. Allows a sequence to be enumerated as values
  633. </summary>
  634. </member>
  635. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.Enumerator.MoveNext">
  636. <summary>
  637. Attempt to move the next value
  638. </summary>
  639. </member>
  640. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.Enumerator.GetNext">
  641. <summary>
  642. Progresses the iterator, asserting that space is available, returning a reference to the next value
  643. </summary>
  644. </member>
  645. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.Enumerator.Current">
  646. <summary>
  647. Obtain a reference to the current value
  648. </summary>
  649. </member>
  650. <member name="T:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.SpanEnumerator">
  651. <summary>
  652. Allows a sequence to be enumerated as spans
  653. </summary>
  654. </member>
  655. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.SpanEnumerator.MoveNext">
  656. <summary>
  657. Attempt to move the next segment
  658. </summary>
  659. </member>
  660. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.SpanEnumerator.GetNext">
  661. <summary>
  662. Asserts that another span is available, and returns then next span
  663. </summary>
  664. </member>
  665. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.SpanEnumerator.Current">
  666. <summary>
  667. Obtain the current segment
  668. </summary>
  669. </member>
  670. <member name="T:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.MemoryEnumerator">
  671. <summary>
  672. Allows a sequence to be enumerated as memory instances
  673. </summary>
  674. </member>
  675. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.MemoryEnumerator.MoveNext">
  676. <summary>
  677. Attempt to move the next segment
  678. </summary>
  679. </member>
  680. <member name="P:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.MemoryEnumerator.Current">
  681. <summary>
  682. Obtain the current segment
  683. </summary>
  684. </member>
  685. <member name="M:Pipelines.Sockets.Unofficial.Arenas.Sequence`1.MemoryEnumerator.GetNext">
  686. <summary>
  687. Asserts that another span is available, and returns then next span
  688. </summary>
  689. </member>
  690. <member name="T:Pipelines.Sockets.Unofficial.Arenas.Projection`2">
  691. <summary>
  692. Similar to Func, but with "in" parameters
  693. </summary>
  694. </member>
  695. <member name="T:Pipelines.Sockets.Unofficial.Arenas.Projection`3">
  696. <summary>
  697. Similar to Func, but with "in" parameters
  698. </summary>
  699. </member>
  700. <member name="T:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions">
  701. <summary>
  702. Provides utility methods for working with sequences
  703. </summary>
  704. </member>
  705. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.ToArray``1(Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@)">
  706. <summary>
  707. Create an array with the contents of the sequence; if possible, an existing
  708. wrapped array may be reused
  709. </summary>
  710. </member>
  711. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.ToSequence``1(System.Collections.Generic.IEnumerable{``0})">
  712. <summary>
  713. Obtain a Sequence from an enumerable; this may reuse existing sequence-compatible data if possible
  714. </summary>
  715. </member>
  716. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.ToList``1(Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@)">
  717. <summary>
  718. Create a list-like object that provides access to the sequence
  719. </summary>
  720. </member>
  721. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.ToArray``2(Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@,Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1})">
  722. <summary>
  723. Create an array with the contents of the sequence, applying a projection
  724. </summary>
  725. </member>
  726. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.ToArray``3(Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@,Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1,``2},``1@)">
  727. <summary>
  728. Create an array with the contents of the sequence, applying a projection
  729. </summary>
  730. </member>
  731. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.CopyTo``2(Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@,System.Span{``1},Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1})">
  732. <summary>
  733. Copy the data from a sequence to a span, applying a projection
  734. </summary>
  735. </member>
  736. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.CopyTo``3(Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@,System.Span{``2},Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1,``2},``1@)">
  737. <summary>
  738. Copy the data from a sequence to a span, applying a projection
  739. </summary>
  740. </member>
  741. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.CopyTo``1(System.ReadOnlySpan{``0},Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@)">
  742. <summary>
  743. Copy the data from a span to a sequence
  744. </summary>
  745. </member>
  746. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.CopyTo``2(System.Span{``0},Pipelines.Sockets.Unofficial.Arenas.Sequence{``1}@,Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1})">
  747. <summary>
  748. Copy the data from a span to a sequence, applying a projection
  749. </summary>
  750. </member>
  751. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.CopyTo``3(System.ReadOnlySpan{``0},Pipelines.Sockets.Unofficial.Arenas.Sequence{``2}@,Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1,``2},``1@)">
  752. <summary>
  753. Copy the data from a span to a sequence, applying a projection
  754. </summary>
  755. </member>
  756. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.CopyTo``2(System.ReadOnlySpan{``0},Pipelines.Sockets.Unofficial.Arenas.Sequence{``1}@,Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1})">
  757. <summary>
  758. Copy the data from a span to a sequence, applying a projection
  759. </summary>
  760. </member>
  761. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.CopyTo``3(System.Span{``0},Pipelines.Sockets.Unofficial.Arenas.Sequence{``2}@,Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1,``2},``1@)">
  762. <summary>
  763. Copy the data from a span to a sequence, applying a projection
  764. </summary>
  765. </member>
  766. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.TryCopyTo``2(Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@,System.Span{``1},Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1})">
  767. <summary>
  768. Copy the data from a sequence to a span, applying a projection
  769. </summary>
  770. </member>
  771. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.TryCopyTo``3(Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@,System.Span{``2},Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1,``2},``1@)">
  772. <summary>
  773. Copy the data from a sequence to a span, applying a projection
  774. </summary>
  775. </member>
  776. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.TryCopyTo``1(System.ReadOnlySpan{``0},Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@)">
  777. <summary>
  778. Copy the data from a span to a sequence
  779. </summary>
  780. </member>
  781. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.TryCopyTo``2(System.Span{``0},Pipelines.Sockets.Unofficial.Arenas.Sequence{``1}@,Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1})">
  782. <summary>
  783. Copy the data from a span to a sequence, applying a projection
  784. </summary>
  785. </member>
  786. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.TryCopyTo``3(System.Span{``0},Pipelines.Sockets.Unofficial.Arenas.Sequence{``2}@,Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1,``2},``1@)">
  787. <summary>
  788. Copy the data from a span to a sequence, applying a projection
  789. </summary>
  790. </member>
  791. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.TryCopyTo``2(System.ReadOnlySpan{``0},Pipelines.Sockets.Unofficial.Arenas.Sequence{``1}@,Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1})">
  792. <summary>
  793. Copy the data from a span to a sequence, applying a projection
  794. </summary>
  795. </member>
  796. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.TryCopyTo``3(System.ReadOnlySpan{``0},Pipelines.Sockets.Unofficial.Arenas.Sequence{``2}@,Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1,``2},``1@)">
  797. <summary>
  798. Copy the data from a span to a sequence, applying a projection
  799. </summary>
  800. </member>
  801. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.Allocate``2(Pipelines.Sockets.Unofficial.Arenas.Arena{``1},Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@,Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1})">
  802. <summary>
  803. Copy the data from a sequence to a newly allocated sequence, applying a projection
  804. </summary>
  805. </member>
  806. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.Allocate``3(Pipelines.Sockets.Unofficial.Arenas.Arena{``2},Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@,Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1,``2},``1@)">
  807. <summary>
  808. Copy the data from a sequence to a newly allocated sequence, applying a projection
  809. </summary>
  810. </member>
  811. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.CopyTo``1(Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@,Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@)">
  812. <summary>
  813. Copy the data from between two sequences, applying a projection
  814. </summary>
  815. </member>
  816. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.TryCopyTo``1(Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@,Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@)">
  817. <summary>
  818. Copy the data from between two sequences, applying a projection
  819. </summary>
  820. </member>
  821. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.CopyTo``1(System.Buffers.ReadOnlySequence{``0}@,Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@)">
  822. <summary>
  823. Copy the data from between two sequences, applying a projection
  824. </summary>
  825. </member>
  826. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.TryCopyTo``1(System.Buffers.ReadOnlySequence{``0}@,Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@)">
  827. <summary>
  828. Copy the data from between two sequences, applying a projection
  829. </summary>
  830. </member>
  831. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.CopyTo``2(Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@,Pipelines.Sockets.Unofficial.Arenas.Sequence{``1}@,Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1})">
  832. <summary>
  833. Copy the data from between two sequences, applying a projection
  834. </summary>
  835. </member>
  836. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.TryCopyTo``2(Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@,Pipelines.Sockets.Unofficial.Arenas.Sequence{``1}@,Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1})">
  837. <summary>
  838. Copy the data from between two sequences, applying a projection
  839. </summary>
  840. </member>
  841. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.CopyTo``3(Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@,Pipelines.Sockets.Unofficial.Arenas.Sequence{``2}@,Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1,``2},``1@)">
  842. <summary>
  843. Copy the data from between two sequences, applying a projection
  844. </summary>
  845. </member>
  846. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.TryCopyTo``3(Pipelines.Sockets.Unofficial.Arenas.Sequence{``0}@,Pipelines.Sockets.Unofficial.Arenas.Sequence{``2}@,Pipelines.Sockets.Unofficial.Arenas.Projection{``0,``1,``2},``1@)">
  847. <summary>
  848. Copy the data from between two sequences, applying a projection
  849. </summary>
  850. </member>
  851. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.TryGetOffset(System.SequencePosition@)">
  852. <summary>
  853. Attempt to calculate the net offset of a position
  854. </summary>
  855. </member>
  856. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceExtensions.TryGetSummary(System.SequencePosition@)">
  857. <summary>
  858. Attempt to calculate the net offset of a position
  859. </summary>
  860. </member>
  861. <member name="T:Pipelines.Sockets.Unofficial.Arenas.SequenceList`1">
  862. <summary>
  863. A list-like reference type that can be used in most APIs that expect a list object
  864. </summary>
  865. </member>
  866. <member name="P:Pipelines.Sockets.Unofficial.Arenas.SequenceList`1.Count">
  867. <summary>
  868. Returns the size of the list
  869. </summary>
  870. </member>
  871. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceList`1.GetEnumerator">
  872. <summary>
  873. Allows a sequence to be enumerated as values
  874. </summary>
  875. </member>
  876. <member name="P:Pipelines.Sockets.Unofficial.Arenas.SequenceList`1.Item(System.Int32)">
  877. <summary>
  878. Provide a reference to an element by index
  879. </summary>
  880. </member>
  881. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceList`1.ToSequence">
  882. <summary>
  883. Get the sequence represented by this list
  884. </summary>
  885. </member>
  886. <member name="T:Pipelines.Sockets.Unofficial.Arenas.ISegment">
  887. <summary>
  888. Represents an abstract chained segment of mutable memory
  889. </summary>
  890. </member>
  891. <member name="P:Pipelines.Sockets.Unofficial.Arenas.ISegment.Index">
  892. <summary>
  893. The segment index
  894. </summary>
  895. </member>
  896. <member name="P:Pipelines.Sockets.Unofficial.Arenas.ISegment.ElementType">
  897. <summary>
  898. The type of data represented by this segment
  899. </summary>
  900. </member>
  901. <member name="P:Pipelines.Sockets.Unofficial.Arenas.ISegment.UnderlyingType">
  902. <summary>
  903. The actual type of memory used for the storage
  904. </summary>
  905. </member>
  906. <member name="P:Pipelines.Sockets.Unofficial.Arenas.ISegment.RunningIndex">
  907. <summary>
  908. The offset of this segment in the chain
  909. </summary>
  910. </member>
  911. <member name="T:Pipelines.Sockets.Unofficial.Arenas.IPinnedMemoryOwner`1">
  912. <summary>
  913. A memory-owner that provides direct access to the root reference
  914. </summary>
  915. </member>
  916. <member name="P:Pipelines.Sockets.Unofficial.Arenas.IPinnedMemoryOwner`1.Origin">
  917. <summary>
  918. The root reference of the block, or a null-pointer if the data should not be considered pinned
  919. </summary>
  920. </member>
  921. <member name="P:Pipelines.Sockets.Unofficial.Arenas.IPinnedMemoryOwner`1.Length">
  922. <summary>
  923. Gets the size of the data
  924. </summary>
  925. </member>
  926. <member name="T:Pipelines.Sockets.Unofficial.Arenas.SequenceSegment`1">
  927. <summary>
  928. Represents an abstract chained segment of mutable memory
  929. </summary>
  930. </member>
  931. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceSegment`1.#ctor(System.Memory{`0},Pipelines.Sockets.Unofficial.Arenas.SequenceSegment{`0})">
  932. <summary>
  933. Creates a new SequenceSegment, optionally attaching the segment to an existing chain
  934. </summary>
  935. </member>
  936. <member name="P:Pipelines.Sockets.Unofficial.Arenas.SequenceSegment`1.Length">
  937. <summary>
  938. The length of the memory
  939. </summary>
  940. </member>
  941. <member name="P:Pipelines.Sockets.Unofficial.Arenas.SequenceSegment`1.RunningIndex">
  942. <summary>
  943. The logical position of the start of this segment
  944. </summary>
  945. </member>
  946. <member name="P:Pipelines.Sockets.Unofficial.Arenas.SequenceSegment`1.Next">
  947. <summary>
  948. The next segment in the chain
  949. </summary>
  950. </member>
  951. <member name="P:Pipelines.Sockets.Unofficial.Arenas.SequenceSegment`1.Memory">
  952. <summary>
  953. The memory represented by this segment
  954. </summary>
  955. </member>
  956. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceSegment`1.GetSegmentIndex">
  957. <summary>
  958. Get the logical index of this segment
  959. </summary>
  960. </member>
  961. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceSegment`1.GetUnderlyingType">
  962. <summary>
  963. Get the real type of data being used to hold this data
  964. </summary>
  965. </member>
  966. <member name="M:Pipelines.Sockets.Unofficial.Arenas.SequenceSegment`1.DetachNext">
  967. <summary>
  968. Remove the Next node in this chain, terminating the chain - returning the detached segment
  969. </summary>
  970. </member>
  971. <member name="T:Pipelines.Sockets.Unofficial.Buffers.Owned`1">
  972. <summary>
  973. Represents a <typeparamref name="T"/> with lifetime management over the data
  974. </summary>
  975. </member>
  976. <member name="P:Pipelines.Sockets.Unofficial.Buffers.Owned`1.Value">
  977. <summary>
  978. The data represented by this value
  979. </summary>
  980. </member>
  981. <member name="M:Pipelines.Sockets.Unofficial.Buffers.Owned`1.Dispose">
  982. <summary>
  983. Release any resources associated with this value
  984. </summary>
  985. </member>
  986. <member name="M:Pipelines.Sockets.Unofficial.Buffers.Owned`1.#ctor(`0,System.Action{`0})">
  987. <summary>
  988. Create a new instance with a call-defined lifetime management callback
  989. </summary>
  990. </member>
  991. <member name="M:Pipelines.Sockets.Unofficial.Buffers.Owned`1.op_Implicit(Pipelines.Sockets.Unofficial.Buffers.Owned{`0}@)~`0">
  992. <summary>
  993. Access the underlying data directly
  994. </summary>
  995. <param name="value"></param>
  996. </member>
  997. <member name="M:Pipelines.Sockets.Unofficial.Buffers.Owned`1.op_Implicit(`0@)~Pipelines.Sockets.Unofficial.Buffers.Owned{`0}">
  998. <summary>
  999. Represent an existing value with dummy lifetime management
  1000. </summary>
  1001. </member>
  1002. <member name="T:Pipelines.Sockets.Unofficial.Buffers.BufferWriter`1">
  1003. <summary>
  1004. Implements a buffer-writer over arbitrary memory
  1005. </summary>
  1006. </member>
  1007. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriter`1.Create(System.Buffers.MemoryPool{`0},System.Nullable{System.Int32})">
  1008. <summary>
  1009. Create a new buffer-writer instance that uses a memory pool as the backing store; if the provided pool is null, the shared instance is used
  1010. </summary>
  1011. </member>
  1012. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriter`1.Create(System.Buffers.ArrayPool{`0},System.Nullable{System.Int32})">
  1013. <summary>
  1014. Create a new buffer-writer instance that uses an array-pool as the backing store; if the provided pool is null, the shared instance is used
  1015. </summary>
  1016. </member>
  1017. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriter`1.Create(System.Nullable{System.Int32})">
  1018. <summary>
  1019. Create a new buffer-writer instance that uses an array-pool as the backing store; if the provided pool is null, the shared instance is used
  1020. </summary>
  1021. </member>
  1022. <member name="P:Pipelines.Sockets.Unofficial.Buffers.BufferWriter`1.Writer">
  1023. <summary>
  1024. Get the writer used to append data to this instance
  1025. </summary>
  1026. </member>
  1027. <member name="P:Pipelines.Sockets.Unofficial.Buffers.BufferWriter`1.Length">
  1028. <summary>
  1029. Gets the amount of data buffered by the writer
  1030. </summary>
  1031. </member>
  1032. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriter`1.Dispose">
  1033. <summary>
  1034. Release all resources associate with this instance
  1035. </summary>
  1036. </member>
  1037. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriter`1.GetBuffer">
  1038. <summary>
  1039. Gets the currently buffered data as a sequence of read-write buffer-segments
  1040. </summary>
  1041. </member>
  1042. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriter`1.Flush(System.Int64)">
  1043. <summary>
  1044. Gets some subset of the currently buffered data as a sequence of read-only buffer-segments (with lifetime management); you
  1045. can continue to append data after calling <c>Flush</c> - any additional data will form a new payload
  1046. that can be fetched by the next call to <c>Flush</c>
  1047. </summary>
  1048. </member>
  1049. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriter`1.Flush">
  1050. <summary>
  1051. Gets the currently buffered data as a sequence of read-only buffer-segments (with lifetime management); you
  1052. can continue to append data after calling <c>Flush</c> - any additional data will form a new payload
  1053. that can be fetched by the next call to <c>Flush</c>
  1054. </summary>
  1055. </member>
  1056. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriter`1.Advance(System.Int32)">
  1057. <summary>
  1058. Commit a number of bytes to the underyling buffer
  1059. </summary>
  1060. </member>
  1061. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriter`1.GetSpan(System.Int32)">
  1062. <summary>
  1063. Access a contiguous write buffer
  1064. </summary>
  1065. </member>
  1066. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriter`1.GetMemory(System.Int32)">
  1067. <summary>
  1068. Access a contiguous write buffer
  1069. </summary>
  1070. </member>
  1071. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriter`1.GetSequence(System.Int32)">
  1072. <summary>
  1073. Access a non-contiguous write buffer
  1074. </summary>
  1075. </member>
  1076. <member name="T:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter">
  1077. <summary>
  1078. Implements a <see cref="T:System.IO.TextWriter"/> over an <see cref="T:System.Buffers.IBufferWriter`1"/>
  1079. </summary>
  1080. </member>
  1081. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.Create(System.Buffers.IBufferWriter{System.Byte},System.Text.Encoding)">
  1082. <summary>
  1083. Creates a new instance
  1084. </summary>
  1085. </member>
  1086. <member name="P:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.Encoding">
  1087. <inheritdoc/>
  1088. </member>
  1089. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.Write(System.String)">
  1090. <inheritdoc/>
  1091. </member>
  1092. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.WriteLine(System.String)">
  1093. <inheritdoc/>
  1094. </member>
  1095. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.Write(System.Char[])">
  1096. <inheritdoc/>
  1097. </member>
  1098. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.Write(System.Char)">
  1099. <inheritdoc/>
  1100. </member>
  1101. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.WriteLine">
  1102. <inheritdoc/>
  1103. </member>
  1104. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.WriteLine(System.Char)">
  1105. <inheritdoc/>
  1106. </member>
  1107. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.WriteLineAsync">
  1108. <inheritdoc/>
  1109. </member>
  1110. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.WriteLineAsync(System.Char)">
  1111. <inheritdoc/>
  1112. </member>
  1113. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.WriteLineAsync(System.Char[],System.Int32,System.Int32)">
  1114. <inheritdoc/>
  1115. </member>
  1116. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.Write(System.Char[],System.Int32,System.Int32)">
  1117. <inheritdoc/>
  1118. </member>
  1119. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.WriteLineAsync(System.String)">
  1120. <inheritdoc/>
  1121. </member>
  1122. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.WriteAsync(System.String)">
  1123. <inheritdoc/>
  1124. </member>
  1125. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.WriteLine(System.Char[])">
  1126. <inheritdoc/>
  1127. </member>
  1128. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.WriteLine(System.Char[],System.Int32,System.Int32)">
  1129. <inheritdoc/>
  1130. </member>
  1131. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.Flush">
  1132. <inheritdoc/>
  1133. </member>
  1134. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.FlushAsync">
  1135. <inheritdoc/>
  1136. </member>
  1137. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.WriteAsync(System.Char)">
  1138. <inheritdoc/>
  1139. </member>
  1140. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.WriteAsync(System.Char[],System.Int32,System.Int32)">
  1141. <inheritdoc/>
  1142. </member>
  1143. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.Write(System.ReadOnlySpan{System.Char})">
  1144. <inheritdoc/>
  1145. </member>
  1146. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.WriteLineAsync(System.ReadOnlyMemory{System.Char},System.Threading.CancellationToken)">
  1147. <inheritdoc/>
  1148. </member>
  1149. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.WriteLine(System.ReadOnlySpan{System.Char})">
  1150. <inheritdoc/>
  1151. </member>
  1152. <member name="M:Pipelines.Sockets.Unofficial.Buffers.BufferWriterTextWriter.WriteAsync(System.ReadOnlyMemory{System.Char},System.Threading.CancellationToken)">
  1153. <inheritdoc/>
  1154. </member>
  1155. <member name="T:Pipelines.Sockets.Unofficial.ConnectionAbortedException">
  1156. <summary>
  1157. Indicates that a connection was aborted
  1158. </summary>
  1159. </member>
  1160. <member name="M:Pipelines.Sockets.Unofficial.ConnectionAbortedException.#ctor">
  1161. <summary>
  1162. Create a new instance of ConnectionAbortedException
  1163. </summary>
  1164. </member>
  1165. <member name="M:Pipelines.Sockets.Unofficial.ConnectionAbortedException.#ctor(System.String)">
  1166. <summary>
  1167. Create a new instance of ConnectionAbortedException
  1168. </summary>
  1169. </member>
  1170. <member name="M:Pipelines.Sockets.Unofficial.ConnectionAbortedException.#ctor(System.String,System.Exception)">
  1171. <summary>
  1172. Create a new instance of ConnectionAbortedException
  1173. </summary>
  1174. </member>
  1175. <member name="T:Pipelines.Sockets.Unofficial.ConnectionResetException">
  1176. <summary>
  1177. Indicates that a connection was reset
  1178. </summary>
  1179. </member>
  1180. <member name="M:Pipelines.Sockets.Unofficial.ConnectionResetException.#ctor">
  1181. <summary>
  1182. Create a new ConnectionResetException instance
  1183. </summary>
  1184. </member>
  1185. <member name="M:Pipelines.Sockets.Unofficial.ConnectionResetException.#ctor(System.String)">
  1186. <summary>
  1187. Create a new ConnectionResetException instance
  1188. </summary>
  1189. </member>
  1190. <member name="M:Pipelines.Sockets.Unofficial.ConnectionResetException.#ctor(System.String,System.Exception)">
  1191. <summary>
  1192. Create a new ConnectionResetException instance
  1193. </summary>
  1194. </member>
  1195. <member name="T:Pipelines.Sockets.Unofficial.DedicatedThreadPoolPipeScheduler">
  1196. <summary>
  1197. An implementation of a pipe-scheduler that uses a dedicated pool of threads, deferring to
  1198. the thread-pool if that becomes too backlogged
  1199. </summary>
  1200. </member>
  1201. <member name="P:Pipelines.Sockets.Unofficial.DedicatedThreadPoolPipeScheduler.Default">
  1202. <summary>
  1203. Reusable shared scheduler instance
  1204. </summary>
  1205. </member>
  1206. <member name="M:Pipelines.Sockets.Unofficial.DedicatedThreadPoolPipeScheduler.IsWorker(Pipelines.Sockets.Unofficial.DedicatedThreadPoolPipeScheduler)">
  1207. <summary>
  1208. Indicates whether the current thread is a worker, optionally for the specific pool
  1209. (otherwise for any pool)
  1210. </summary>
  1211. </member>
  1212. <member name="M:Pipelines.Sockets.Unofficial.DedicatedThreadPoolPipeScheduler.ToString">
  1213. <summary>
  1214. The name of the pool
  1215. </summary>
  1216. </member>
  1217. <member name="P:Pipelines.Sockets.Unofficial.DedicatedThreadPoolPipeScheduler.WorkerCount">
  1218. <summary>
  1219. The number of workers associated with this pool
  1220. </summary>
  1221. </member>
  1222. <member name="M:Pipelines.Sockets.Unofficial.DedicatedThreadPoolPipeScheduler.#ctor(System.String,System.Int32,System.Int32,System.Threading.ThreadPriority)">
  1223. <summary>
  1224. Create a new dedicated thread-pool
  1225. </summary>
  1226. </member>
  1227. <member name="P:Pipelines.Sockets.Unofficial.DedicatedThreadPoolPipeScheduler.TotalServicedByQueue">
  1228. <summary>
  1229. The total number of operations serviced by the queue
  1230. </summary>
  1231. </member>
  1232. <member name="P:Pipelines.Sockets.Unofficial.DedicatedThreadPoolPipeScheduler.TotalServicedByPool">
  1233. <summary>
  1234. The total number of operations that could not be serviced by the queue, but which were sent to the thread-pool instead
  1235. </summary>
  1236. </member>
  1237. <member name="M:Pipelines.Sockets.Unofficial.DedicatedThreadPoolPipeScheduler.Schedule(System.Action{System.Object},System.Object)">
  1238. <summary>
  1239. Requests <paramref name="action"/> to be run on scheduler with <paramref name="state"/> being passed in
  1240. </summary>
  1241. </member>
  1242. <member name="P:Pipelines.Sockets.Unofficial.DedicatedThreadPoolPipeScheduler.AvailableCount">
  1243. <summary>
  1244. The number of workers currently actively engaged in work
  1245. </summary>
  1246. </member>
  1247. <member name="M:Pipelines.Sockets.Unofficial.DedicatedThreadPoolPipeScheduler.Dispose">
  1248. <summary>
  1249. Release the threads associated with this pool; if additional work is requested, it will
  1250. be sent to the main thread-pool
  1251. </summary>
  1252. </member>
  1253. <member name="T:Pipelines.Sockets.Unofficial.Delegates">
  1254. <summary>
  1255. Provides utility methods for working with delegates
  1256. </summary>
  1257. </member>
  1258. <member name="M:Pipelines.Sockets.Unofficial.Delegates.GetEnumerator``1(``0)">
  1259. <summary>
  1260. Iterate over the individual elements of a multicast delegate (without allocation)
  1261. </summary>
  1262. </member>
  1263. <member name="M:Pipelines.Sockets.Unofficial.Delegates.AsEnumerable``1(``0)">
  1264. <summary>
  1265. Iterate over the individual elements of a multicast delegate (without allocation)
  1266. </summary>
  1267. </member>
  1268. <member name="M:Pipelines.Sockets.Unofficial.Delegates.IsSingle(System.MulticastDelegate)">
  1269. <summary>
  1270. Indicates whether a particular delegate is known to be a single-target delegate
  1271. </summary>
  1272. </member>
  1273. <member name="T:Pipelines.Sockets.Unofficial.Delegates.DelegateEnumerable`1">
  1274. <summary>
  1275. Allows allocation-free enumerator over the individual elements of a multicast delegate
  1276. </summary>
  1277. </member>
  1278. <member name="M:Pipelines.Sockets.Unofficial.Delegates.DelegateEnumerable`1.GetEnumerator">
  1279. <summary>
  1280. Iterate over the individual elements of a multicast delegate (without allocation)
  1281. </summary>
  1282. </member>
  1283. <member name="T:Pipelines.Sockets.Unofficial.Delegates.DelegateEnumerator`1">
  1284. <summary>
  1285. Allows allocation-free enumerator over the individual elements of a multicast delegate
  1286. </summary>
  1287. </member>
  1288. <member name="P:Pipelines.Sockets.Unofficial.Delegates.DelegateEnumerator`1.Current">
  1289. <summary>
  1290. Provides the current value of the seqyence
  1291. </summary>
  1292. </member>
  1293. <member name="M:Pipelines.Sockets.Unofficial.Delegates.DelegateEnumerator`1.MoveNext">
  1294. <summary>
  1295. Move to the next item in the sequence
  1296. </summary>
  1297. </member>
  1298. <member name="M:Pipelines.Sockets.Unofficial.Delegates.DelegateEnumerator`1.Reset">
  1299. <summary>
  1300. Reset the enumerator, allowing the sequence to be repeated
  1301. </summary>
  1302. </member>
  1303. <member name="T:Pipelines.Sockets.Unofficial.IMeasuredDuplexPipe">
  1304. <summary>
  1305. A duplex pipe that measures the bytes sent/received
  1306. </summary>
  1307. </member>
  1308. <member name="P:Pipelines.Sockets.Unofficial.IMeasuredDuplexPipe.TotalBytesSent">
  1309. <summary>
  1310. The total number of bytes sent to the pipe
  1311. </summary>
  1312. </member>
  1313. <member name="P:Pipelines.Sockets.Unofficial.IMeasuredDuplexPipe.TotalBytesReceived">
  1314. <summary>
  1315. The total number of bytes received by the pipe
  1316. </summary>
  1317. </member>
  1318. <member name="T:Pipelines.Sockets.Unofficial.MemoryMappedPipeReader">
  1319. <summary>
  1320. Represents a pipe that iterates over a memory-mapped file
  1321. </summary>
  1322. </member>
  1323. <member name="M:Pipelines.Sockets.Unofficial.MemoryMappedPipeReader.ToString">
  1324. <summary>
  1325. Get a string representation of the object
  1326. </summary>
  1327. </member>
  1328. <member name="P:Pipelines.Sockets.Unofficial.MemoryMappedPipeReader.IsAvailable">
  1329. <summary>
  1330. Indicates whether this API is likely to work
  1331. </summary>
  1332. </member>
  1333. <member name="M:Pipelines.Sockets.Unofficial.MemoryMappedPipeReader.Create(System.String,System.Int32)">
  1334. <summary>
  1335. Create a pipe-reader over the provided file
  1336. </summary>
  1337. </member>
  1338. <member name="M:Pipelines.Sockets.Unofficial.MemoryMappedPipeReader.Complete(System.Exception)">
  1339. <summary>
  1340. Mark the reader as complete
  1341. </summary>
  1342. <param name="exception"></param>
  1343. </member>
  1344. <member name="M:Pipelines.Sockets.Unofficial.MemoryMappedPipeReader.Dispose">
  1345. <summary>
  1346. Releases all resources associated with the object
  1347. </summary>
  1348. </member>
  1349. <member name="M:Pipelines.Sockets.Unofficial.MemoryMappedPipeReader.OnWriterCompleted(System.Action{System.Exception,System.Object},System.Object)">
  1350. <summary>
  1351. Not implemented
  1352. </summary>
  1353. </member>
  1354. <member name="M:Pipelines.Sockets.Unofficial.MemoryMappedPipeReader.CancelPendingRead">
  1355. <summary>
  1356. Cancels an in-progress read
  1357. </summary>
  1358. </member>
  1359. <member name="M:Pipelines.Sockets.Unofficial.MemoryMappedPipeReader.AdvanceTo(System.SequencePosition)">
  1360. <summary>
  1361. Indicates how much data was consumed from a read operation
  1362. </summary>
  1363. </member>
  1364. <member name="M:Pipelines.Sockets.Unofficial.MemoryMappedPipeReader.AdvanceTo(System.SequencePosition,System.SequencePosition)">
  1365. <summary>
  1366. Indicates how much data was consumed, and how much examined, from a read operation
  1367. </summary>
  1368. </member>
  1369. <member name="M:Pipelines.Sockets.Unofficial.MemoryMappedPipeReader.ReadAsync(System.Threading.CancellationToken)">
  1370. <summary>
  1371. Perform an asynchronous read operation
  1372. </summary>
  1373. </member>
  1374. <member name="M:Pipelines.Sockets.Unofficial.MemoryMappedPipeReader.TryRead(System.IO.Pipelines.ReadResult@)">
  1375. <summary>
  1376. Attempt to perfom a synchronous read operation
  1377. </summary>
  1378. </member>
  1379. <member name="T:Pipelines.Sockets.Unofficial.SocketAwaitableEventArgs">
  1380. <summary>
  1381. Awaitable SocketAsyncEventArgs, where awaiting the args yields either the BytesTransferred or throws the relevant socket exception
  1382. </summary>
  1383. </member>
  1384. <member name="M:Pipelines.Sockets.Unofficial.SocketAwaitableEventArgs.Abort(System.Net.Sockets.SocketError)">
  1385. <summary>
  1386. Abort the current async operation (and prevent future operations)
  1387. </summary>
  1388. </member>
  1389. <member name="M:Pipelines.Sockets.Unofficial.SocketAwaitableEventArgs.#ctor(System.IO.Pipelines.PipeScheduler)">
  1390. <summary>
  1391. Create a new SocketAwaitableEventArgs instance, optionally providing a scheduler for callbacks
  1392. </summary>
  1393. <param name="ioScheduler"></param>
  1394. </member>
  1395. <member name="M:Pipelines.Sockets.Unofficial.SocketAwaitableEventArgs.GetAwaiter">
  1396. <summary>
  1397. Get the awaiter for this instance; used as part of "await"
  1398. </summary>
  1399. </member>
  1400. <member name="P:Pipelines.Sockets.Unofficial.SocketAwaitableEventArgs.IsCompleted">
  1401. <summary>
  1402. Indicates whether the current operation is complete; used as part of "await"
  1403. </summary>
  1404. </member>
  1405. <member name="M:Pipelines.Sockets.Unofficial.SocketAwaitableEventArgs.GetResult">
  1406. <summary>
  1407. Gets the result of the async operation is complete; used as part of "await"
  1408. </summary>
  1409. </member>
  1410. <member name="M:Pipelines.Sockets.Unofficial.SocketAwaitableEventArgs.OnCompleted(System.Action)">
  1411. <summary>
  1412. Schedules a continuation for this operation; used as part of "await"
  1413. </summary>
  1414. </member>
  1415. <member name="M:Pipelines.Sockets.Unofficial.SocketAwaitableEventArgs.UnsafeOnCompleted(System.Action)">
  1416. <summary>
  1417. Schedules a continuation for this operation; used as part of "await"
  1418. </summary>
  1419. </member>
  1420. <member name="M:Pipelines.Sockets.Unofficial.SocketAwaitableEventArgs.Complete">
  1421. <summary>
  1422. Marks the operation as complete - this should be invoked whenever a SocketAsyncEventArgs operation returns false
  1423. </summary>
  1424. </member>
  1425. <member name="M:Pipelines.Sockets.Unofficial.SocketAwaitableEventArgs.OnCompleted(System.Net.Sockets.SocketAsyncEventArgs)">
  1426. <summary>
  1427. Invoked automatically when an operation completes asynchronously
  1428. </summary>
  1429. </member>
  1430. <member name="T:Pipelines.Sockets.Unofficial.SocketConnection">
  1431. <summary>
  1432. Reperesents a duplex pipe over managed sockets
  1433. </summary>
  1434. </member>
  1435. <member name="M:Pipelines.Sockets.Unofficial.SocketConnection.ConnectAsync(System.Net.EndPoint,System.IO.Pipelines.PipeOptions,Pipelines.Sockets.Unofficial.SocketConnectionOptions,System.Func{Pipelines.Sockets.Unofficial.SocketConnection,System.Threading.Tasks.Task},System.Net.Sockets.Socket,System.String)">
  1436. <summary>
  1437. Open a new or existing socket as a client
  1438. </summary>
  1439. </member>
  1440. <member name="M:Pipelines.Sockets.Unofficial.SocketConnection.ConnectAsync(System.Net.EndPoint,System.IO.Pipelines.PipeOptions,System.IO.Pipelines.PipeOptions,Pipelines.Sockets.Unofficial.SocketConnectionOptions,System.Func{Pipelines.Sockets.Unofficial.SocketConnection,System.Threading.Tasks.Task},System.Net.Sockets.Socket,System.String)">
  1441. <summary>
  1442. Open a new or existing socket as a client
  1443. </summary>
  1444. </member>
  1445. <member name="M:Pipelines.Sockets.Unofficial.SocketConnection.AssertDependencies">
  1446. <summary>
  1447. Check that all dependencies are available
  1448. </summary>
  1449. </member>
  1450. <member name="P:Pipelines.Sockets.Unofficial.SocketConnection.ShutdownKind">
  1451. <summary>
  1452. When possible, determines how the pipe first reached a close state
  1453. </summary>
  1454. </member>
  1455. <member name="P:Pipelines.Sockets.Unofficial.SocketConnection.SocketError">
  1456. <summary>
  1457. When the ShutdownKind relates to a socket error, may contain the socket error code
  1458. </summary>
  1459. </member>
  1460. <member name="M:Pipelines.Sockets.Unofficial.SocketConnection.TrySetProtocolShutdown(Pipelines.Sockets.Unofficial.PipeShutdownKind)">
  1461. <summary>
  1462. Try to signal the pipe shutdown reason as being due to an application protocol event
  1463. </summary>
  1464. <param name="kind">The kind of shutdown; only protocol-related reasons will succeed</param>
  1465. <returns>True if successful</returns>
  1466. </member>
  1467. <member name="M:Pipelines.Sockets.Unofficial.SocketConnection.SetRecommendedClientOptions(System.Net.Sockets.Socket)">
  1468. <summary>
  1469. Set recommended socket options for client sockets
  1470. </summary>
  1471. <param name="socket">The socket to set options against</param>
  1472. </member>
  1473. <member name="M:Pipelines.Sockets.Unofficial.SocketConnection.SetRecommendedServerOptions(System.Net.Sockets.Socket)">
  1474. <summary>
  1475. Set recommended socket options for server sockets
  1476. </summary>
  1477. <param name="socket">The socket to set options against</param>
  1478. </member>
  1479. <member name="M:Pipelines.Sockets.Unofficial.SocketConnection.Dispose">
  1480. <summary>
  1481. Release any resources held by this instance
  1482. </summary>
  1483. </member>
  1484. <member name="P:Pipelines.Sockets.Unofficial.SocketConnection.Input">
  1485. <summary>
  1486. Connection for receiving data
  1487. </summary>
  1488. </member>
  1489. <member name="P:Pipelines.Sockets.Unofficial.SocketConnection.Output">
  1490. <summary>
  1491. Connection for sending data
  1492. </summary>
  1493. </member>
  1494. <member name="M:Pipelines.Sockets.Unofficial.SocketConnection.ToString">
  1495. <summary>
  1496. Gets a string representation of this object
  1497. </summary>
  1498. </member>
  1499. <member name="P:Pipelines.Sockets.Unofficial.SocketConnection.Socket">
  1500. <summary>
  1501. The underlying socket for this connection
  1502. </summary>
  1503. </member>
  1504. <member name="M:Pipelines.Sockets.Unofficial.SocketConnection.GetCounters">
  1505. <summary>
  1506. Obtain performance monitoring counters about this connection
  1507. </summary>
  1508. </member>
  1509. <member name="T:Pipelines.Sockets.Unofficial.SocketConnection.Counters">
  1510. <summary>
  1511. Exposes performance monitoring counters about a connection
  1512. </summary>
  1513. </member>
  1514. <member name="M:Pipelines.Sockets.Unofficial.SocketConnection.Counters.GetPipeLength(System.IO.Pipelines.Pipe)">
  1515. <summary>
  1516. Get the number of bytes currently held in a pipe instance
  1517. </summary>
  1518. </member>
  1519. <member name="P:Pipelines.Sockets.Unofficial.SocketConnection.Counters.BytesAvailableOnSocket">
  1520. <summary>
  1521. The number of bytes available on the socket that have not yet been consumed into the pipe
  1522. </summary>
  1523. </member>
  1524. <member name="P:Pipelines.Sockets.Unofficial.SocketConnection.Counters.BytesWaitingToBeSent">
  1525. <summary>
  1526. The number of bytes available on the send pipe that have not yet been sent to the socket
  1527. </summary>
  1528. </member>
  1529. <member name="P:Pipelines.Sockets.Unofficial.SocketConnection.Counters.BytesWaitingToBeRead">
  1530. <summary>
  1531. The number of bytes available on the receive pipe, i.e. they have been processed from the socket, but not yet read
  1532. </summary>
  1533. </member>
  1534. <member name="M:Pipelines.Sockets.Unofficial.SocketConnection.Create(System.Net.Sockets.Socket,System.IO.Pipelines.PipeOptions,Pipelines.Sockets.Unofficial.SocketConnectionOptions,System.String)">
  1535. <summary>
  1536. Create a SocketConnection instance over an existing socket
  1537. </summary>
  1538. </member>
  1539. <member name="M:Pipelines.Sockets.Unofficial.SocketConnection.Create(System.Net.Sockets.Socket,System.IO.Pipelines.PipeOptions,System.IO.Pipelines.PipeOptions,Pipelines.Sockets.Unofficial.SocketConnectionOptions,System.String)">
  1540. <summary>
  1541. Create a SocketConnection instance over an existing socket
  1542. </summary>
  1543. </member>
  1544. <member name="P:Pipelines.Sockets.Unofficial.SocketConnection.BytesRead">
  1545. <summary>
  1546. The total number of bytes read from the socket
  1547. </summary>
  1548. </member>
  1549. <member name="P:Pipelines.Sockets.Unofficial.SocketConnection.LastReceived">
  1550. <summary>
  1551. The number of bytes received in the last read
  1552. </summary>
  1553. </member>
  1554. <member name="P:Pipelines.Sockets.Unofficial.SocketConnection.BytesSent">
  1555. <summary>
  1556. The total number of bytes sent to the socket
  1557. </summary>
  1558. </member>
  1559. <member name="T:Pipelines.Sockets.Unofficial.PipeShutdownKind">
  1560. <summary>
  1561. When possible, determines how the pipe first reached a close state
  1562. </summary>
  1563. </member>
  1564. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.None">
  1565. <summary>
  1566. The pipe is still open
  1567. </summary>
  1568. </member>
  1569. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.PipeDisposed">
  1570. <summary>
  1571. The pipe itself was disposed
  1572. </summary>
  1573. </member>
  1574. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.ReadEndOfStream">
  1575. <summary>
  1576. The socket-reader reached a natural EOF from the socket
  1577. </summary>
  1578. </member>
  1579. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.ReadDisposed">
  1580. <summary>
  1581. The socket-reader encountered a dispose failure
  1582. </summary>
  1583. </member>
  1584. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.ReadIOException">
  1585. <summary>
  1586. The socket-reader encountered an IO failure
  1587. </summary>
  1588. </member>
  1589. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.ReadException">
  1590. <summary>
  1591. The socket-reader encountered a general failure
  1592. </summary>
  1593. </member>
  1594. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.ReadSocketError">
  1595. <summary>
  1596. The socket-reader encountered a socket failure - the SocketError may be populated
  1597. </summary>
  1598. </member>
  1599. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.ReadFlushCompleted">
  1600. <summary>
  1601. When attempting to flush incoming data, the pipe indicated that it was complete
  1602. </summary>
  1603. </member>
  1604. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.ReadFlushCanceled">
  1605. <summary>
  1606. When attempting to flush incoming data, the pipe indicated cancelation
  1607. </summary>
  1608. </member>
  1609. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.WriteEndOfStream">
  1610. <summary>
  1611. The socket-writerreached a natural EOF from the pipe
  1612. </summary>
  1613. </member>
  1614. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.WriteDisposed">
  1615. <summary>
  1616. The socket-writer encountered a dispose failure
  1617. </summary>
  1618. </member>
  1619. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.WriteIOException">
  1620. <summary>
  1621. The socket-writer encountered an IO failure
  1622. </summary>
  1623. </member>
  1624. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.WriteException">
  1625. <summary>
  1626. The socket-writer encountered a general failure
  1627. </summary>
  1628. </member>
  1629. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.WriteSocketError">
  1630. <summary>
  1631. The socket-writer encountered a socket failure - the SocketError may be populated
  1632. </summary>
  1633. </member>
  1634. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.InputReaderCompleted">
  1635. <summary>
  1636. The input's reader was completed
  1637. </summary>
  1638. </member>
  1639. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.InputWriterCompleted">
  1640. <summary>
  1641. The input's writer was completed
  1642. </summary>
  1643. </member>
  1644. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.OutputReaderCompleted">
  1645. <summary>
  1646. The output's reader was completed
  1647. </summary>
  1648. </member>
  1649. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.OutputWriterCompleted">
  1650. <summary>
  1651. The input's writer was completed
  1652. </summary>
  1653. </member>
  1654. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.ProtocolExitClient">
  1655. <summary>
  1656. An application defined exit was triggered by the client
  1657. </summary>
  1658. </member>
  1659. <member name="F:Pipelines.Sockets.Unofficial.PipeShutdownKind.ProtocolExitServer">
  1660. <summary>
  1661. An application defined exit was triggered by the server
  1662. </summary>
  1663. </member>
  1664. <member name="T:Pipelines.Sockets.Unofficial.SocketConnectionOptions">
  1665. <summary>
  1666. Flags that influence the behavior of SocketConnection
  1667. </summary>
  1668. </member>
  1669. <member name="F:Pipelines.Sockets.Unofficial.SocketConnectionOptions.None">
  1670. <summary>
  1671. Default
  1672. </summary>
  1673. </member>
  1674. <member name="F:Pipelines.Sockets.Unofficial.SocketConnectionOptions.ZeroLengthReads">
  1675. <summary>
  1676. When no data is currently available, perform a zero-length read as a buffer-free wait mechanism
  1677. </summary>
  1678. </member>
  1679. <member name="F:Pipelines.Sockets.Unofficial.SocketConnectionOptions.InlineReads">
  1680. <summary>
  1681. During async reads, the awaiter should continue on the IO thread
  1682. </summary>
  1683. </member>
  1684. <member name="F:Pipelines.Sockets.Unofficial.SocketConnectionOptions.InlineWrites">
  1685. <summary>
  1686. During async writes, the awaiter should continue on the IO thread
  1687. </summary>
  1688. </member>
  1689. <member name="F:Pipelines.Sockets.Unofficial.SocketConnectionOptions.InlineConnect">
  1690. <summary>
  1691. During async connects, the awaiter should continue on the IO thread
  1692. </summary>
  1693. </member>
  1694. <member name="T:Pipelines.Sockets.Unofficial.SocketServer">
  1695. <summary>
  1696. Represents a multi-client socket-server capable of dispatching pipeline clients
  1697. </summary>
  1698. </member>
  1699. <member name="M:Pipelines.Sockets.Unofficial.SocketServer.Listen(System.Net.EndPoint,System.Net.Sockets.AddressFamily,System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType,System.Int32,System.IO.Pipelines.PipeOptions,System.IO.Pipelines.PipeOptions)">
  1700. <summary>
  1701. Start listening as a server
  1702. </summary>
  1703. </member>
  1704. <member name="M:Pipelines.Sockets.Unofficial.SocketServer.Listen(System.Net.EndPoint,System.Net.Sockets.AddressFamily,System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType,System.IO.Pipelines.PipeOptions,System.IO.Pipelines.PipeOptions)">
  1705. <summary>
  1706. Start listening as a server
  1707. </summary>
  1708. </member>
  1709. <member name="M:Pipelines.Sockets.Unofficial.SocketServer.Stop">
  1710. <summary>
  1711. Stop listening as a server
  1712. </summary>
  1713. </member>
  1714. <member name="M:Pipelines.Sockets.Unofficial.SocketServer.Dispose">
  1715. <summary>
  1716. Release any resources associated with this instance
  1717. </summary>
  1718. </member>
  1719. <member name="M:Pipelines.Sockets.Unofficial.SocketServer.Dispose(System.Boolean)">
  1720. <summary>
  1721. Release any resources associated with this instance
  1722. </summary>
  1723. </member>
  1724. <member name="M:Pipelines.Sockets.Unofficial.SocketServer.#ctor">
  1725. <summary>
  1726. Create a new instance of a socket server
  1727. </summary>
  1728. </member>
  1729. <member name="M:Pipelines.Sockets.Unofficial.SocketServer.OnServerFaulted(System.Exception)">
  1730. <summary>
  1731. Invoked when the server has faulted
  1732. </summary>
  1733. </member>
  1734. <member name="M:Pipelines.Sockets.Unofficial.SocketServer.OnClientFaulted(Pipelines.Sockets.Unofficial.SocketServer.ClientConnection@,System.Exception)">
  1735. <summary>
  1736. Invoked when a client has faulted
  1737. </summary>
  1738. </member>
  1739. <member name="M:Pipelines.Sockets.Unofficial.SocketServer.OnStarted(System.Net.EndPoint)">
  1740. <summary>
  1741. Invoked when the server starts
  1742. </summary>
  1743. </member>
  1744. <member name="M:Pipelines.Sockets.Unofficial.SocketServer.OnClientConnectedAsync(Pipelines.Sockets.Unofficial.SocketServer.ClientConnection@)">
  1745. <summary>
  1746. Invoked when a new client connects
  1747. </summary>
  1748. </member>
  1749. <member name="T:Pipelines.Sockets.Unofficial.SocketServer.ClientConnection">
  1750. <summary>
  1751. The state of a client connection
  1752. </summary>
  1753. </member>
  1754. <member name="P:Pipelines.Sockets.Unofficial.SocketServer.ClientConnection.Transport">
  1755. <summary>
  1756. The transport to use for this connection
  1757. </summary>
  1758. </member>
  1759. <member name="P:Pipelines.Sockets.Unofficial.SocketServer.ClientConnection.RemoteEndPoint">
  1760. <summary>
  1761. The remote endpoint that the client connected from
  1762. </summary>
  1763. </member>
  1764. <member name="T:Pipelines.Sockets.Unofficial.StreamConnection">
  1765. <summary>
  1766. Provides serves to shim between streams and pipelines
  1767. </summary>
  1768. </member>
  1769. <member name="T:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream">
  1770. <summary>
  1771. Exposes a Stream as a duplex pipe
  1772. </summary>
  1773. </member>
  1774. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.ToString">
  1775. <summary>
  1776. Gets a string representation of this object
  1777. </summary>
  1778. </member>
  1779. <member name="P:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.CanRead">
  1780. <summary>
  1781. Gets whether read operations are available
  1782. </summary>
  1783. </member>
  1784. <member name="P:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.CanWrite">
  1785. <summary>
  1786. Gets whether write operations are available
  1787. </summary>
  1788. </member>
  1789. <member name="P:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.CanTimeout">
  1790. <summary>
  1791. Gets whether the stream can timeout
  1792. </summary>
  1793. </member>
  1794. <member name="P:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.CanSeek">
  1795. <summary>
  1796. Gets whether the seek operations are supported on this stream
  1797. </summary>
  1798. </member>
  1799. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.Seek(System.Int64,System.IO.SeekOrigin)">
  1800. <summary>
  1801. Change the position of the stream
  1802. </summary>
  1803. </member>
  1804. <member name="P:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.Length">
  1805. <summary>
  1806. Query the length of the stream
  1807. </summary>
  1808. </member>
  1809. <member name="P:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.Position">
  1810. <summary>
  1811. Get or set the position of the stream
  1812. </summary>
  1813. </member>
  1814. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.SetLength(System.Int64)">
  1815. <summary>
  1816. Specify the length of the stream
  1817. </summary>
  1818. </member>
  1819. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.Read(System.Byte[],System.Int32,System.Int32)">
  1820. <summary>
  1821. Read a buffer from the stream
  1822. </summary>
  1823. </member>
  1824. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.ReadByte">
  1825. <summary>
  1826. Reads a single byte
  1827. </summary>
  1828. </member>
  1829. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.Write(System.Byte[],System.Int32,System.Int32)">
  1830. <summary>
  1831. Write a buffer to the stream
  1832. </summary>
  1833. </member>
  1834. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  1835. <summary>
  1836. Perform an asynchronous write operation
  1837. </summary>
  1838. </member>
  1839. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.WriteByte(System.Byte)">
  1840. <summary>
  1841. Write a single byte
  1842. </summary>
  1843. </member>
  1844. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
  1845. <summary>
  1846. Begin an asynchronous write operation
  1847. </summary>
  1848. </member>
  1849. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.EndWrite(System.IAsyncResult)">
  1850. <summary>
  1851. End an asynchronous write operation
  1852. </summary>
  1853. </member>
  1854. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.Flush">
  1855. <summary>
  1856. Signal that the written data should be read; this may awaken the reader if inactive,
  1857. and suspend the writer if the backlog is too large
  1858. </summary>
  1859. </member>
  1860. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.FlushAsync(System.Threading.CancellationToken)">
  1861. <summary>
  1862. Signal that the written data should be read; this may awaken the reader if inactive,
  1863. and suspend the writer if the backlog is too large
  1864. </summary>
  1865. </member>
  1866. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.Close">
  1867. <summary>
  1868. Close the stream
  1869. </summary>
  1870. </member>
  1871. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.CloseWrite">
  1872. <summary>
  1873. Signals that writing is complete; no more data will be written
  1874. </summary>
  1875. </member>
  1876. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.CloseRead">
  1877. <summary>
  1878. Signals that reading is complete; no more data will be read
  1879. </summary>
  1880. </member>
  1881. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
  1882. <summary>
  1883. Begin an asynchronous read operation
  1884. </summary>
  1885. </member>
  1886. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.EndRead(System.IAsyncResult)">
  1887. <summary>
  1888. End an asynchronous read operation
  1889. </summary>
  1890. </member>
  1891. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  1892. <summary>
  1893. Perform an asynchronous read operation
  1894. </summary>
  1895. </member>
  1896. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.Write(System.ReadOnlySpan{System.Byte})">
  1897. <summary>
  1898. Write a span to the pipe
  1899. </summary>
  1900. </member>
  1901. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.Read(System.Span{System.Byte})">
  1902. <summary>
  1903. Red a span from the pipe
  1904. </summary>
  1905. </member>
  1906. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.ReadAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
  1907. <summary>
  1908. Read a span from the pipe
  1909. </summary>
  1910. </member>
  1911. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.AsyncPipeStream.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
  1912. <summary>
  1913. Write a span to the pipe
  1914. </summary>
  1915. </member>
  1916. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.GetDuplex(System.IO.Stream,System.IO.Pipelines.PipeOptions,System.String)">
  1917. <summary>
  1918. Create a duplex pipe that represents the provided stream
  1919. </summary>
  1920. </member>
  1921. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.GetDuplex(System.IO.Stream,System.IO.Pipelines.PipeOptions,System.IO.Pipelines.PipeOptions,System.String)">
  1922. <summary>
  1923. Create a duplex pipe that represents the provided stream
  1924. </summary>
  1925. </member>
  1926. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.GetReader(System.IO.Stream,System.IO.Pipelines.PipeOptions,System.String)">
  1927. <summary>
  1928. Create a PipeReader that consumes the provided stream
  1929. </summary>
  1930. </member>
  1931. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.GetWriter(System.IO.Stream,System.IO.Pipelines.PipeOptions,System.String)">
  1932. <summary>
  1933. Create a PipeWriter feeds the provided stream
  1934. </summary>
  1935. </member>
  1936. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.GetDuplex(System.IO.Pipelines.PipeReader,System.IO.Pipelines.PipeWriter,System.String)">
  1937. <summary>
  1938. Create a duplex stream that represents the provided reader and writer
  1939. </summary>
  1940. </member>
  1941. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.GetDuplex(System.IO.Pipelines.IDuplexPipe,System.String)">
  1942. <summary>
  1943. Create a duplex stream that represents the provided pipe
  1944. </summary>
  1945. </member>
  1946. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.GetWriter(System.IO.Pipelines.PipeWriter,System.String)">
  1947. <summary>
  1948. Create a write-only stream that feeds the provided PipeReader
  1949. </summary>
  1950. <param name="writer">The writer to wrap</param>
  1951. <param name="name">The logical name of the reader</param>
  1952. </member>
  1953. <member name="M:Pipelines.Sockets.Unofficial.StreamConnection.GetReader(System.IO.Pipelines.PipeReader,System.String)">
  1954. <summary>
  1955. Create a read-only stream that consumes the provided PipeReader
  1956. </summary>
  1957. <param name="reader">The reader to wrap</param>
  1958. <param name="name">The logical name of the reader</param>
  1959. </member>
  1960. <member name="T:Pipelines.Sockets.Unofficial.Threading.MutexSlim">
  1961. <summary>
  1962. A mutex primitive that can be waited or awaited, with support for schedulers
  1963. </summary>
  1964. </member>
  1965. <member name="P:Pipelines.Sockets.Unofficial.Threading.MutexSlim.TimeoutMilliseconds">
  1966. <summary>
  1967. Time to wait, in milliseconds - or zero for immediate-only
  1968. </summary>
  1969. </member>
  1970. <member name="M:Pipelines.Sockets.Unofficial.Threading.MutexSlim.ToString">
  1971. <summary>
  1972. See Object.ToString
  1973. </summary>
  1974. </member>
  1975. <member name="M:Pipelines.Sockets.Unofficial.Threading.MutexSlim.#ctor(System.Int32,System.IO.Pipelines.PipeScheduler)">
  1976. <summary>
  1977. Create a new MutexSlim instance
  1978. </summary>
  1979. <param name = "timeoutMilliseconds">Time to wait, in milliseconds - or zero for immediate-only</param>
  1980. <param name="scheduler">The scheduler to use for async continuations, or the thread-pool if omitted</param>
  1981. </member>
  1982. <member name="P:Pipelines.Sockets.Unofficial.Threading.MutexSlim.IsAvailable">
  1983. <summary>
  1984. Indicates whether the lock is currently available
  1985. </summary>
  1986. </member>
  1987. <member name="M:Pipelines.Sockets.Unofficial.Threading.MutexSlim.TryWaitAsync(System.Threading.CancellationToken,Pipelines.Sockets.Unofficial.Threading.MutexSlim.WaitOptions)">
  1988. <summary>
  1989. Attempt to take the lock (Success should be checked by the caller)
  1990. </summary>
  1991. </member>
  1992. <member name="M:Pipelines.Sockets.Unofficial.Threading.MutexSlim.TryWait(Pipelines.Sockets.Unofficial.Threading.MutexSlim.WaitOptions)">
  1993. <summary>
  1994. Attempt to take the lock (Success should be checked by the caller)
  1995. </summary>
  1996. </member>
  1997. <member name="T:Pipelines.Sockets.Unofficial.Threading.MutexSlim.WaitOptions">
  1998. <summary>
  1999. Additional options that influence how TryWait/TryWaitAsync operate
  2000. </summary>
  2001. </member>
  2002. <member name="F:Pipelines.Sockets.Unofficial.Threading.MutexSlim.WaitOptions.None">
  2003. <summary>
  2004. Default options
  2005. </summary>
  2006. </member>
  2007. <member name="F:Pipelines.Sockets.Unofficial.Threading.MutexSlim.WaitOptions.NoDelay">
  2008. <summary>
  2009. If the mutex cannot be acquired immediately, it is failed
  2010. </summary>
  2011. </member>
  2012. <member name="F:Pipelines.Sockets.Unofficial.Threading.MutexSlim.WaitOptions.DisableAsyncContext">
  2013. <summary>
  2014. Disable full TPL flow; more efficient, but no sync-context or execution-context guarantees
  2015. </summary>
  2016. </member>
  2017. <member name="T:Pipelines.Sockets.Unofficial.Threading.MutexSlim.LockToken">
  2018. <summary>
  2019. The result of a Wait/WaitAsync operation on MutexSlim; the caller *must* check Success to see whether the mutex was obtained
  2020. </summary>
  2021. </member>
  2022. <member name="M:Pipelines.Sockets.Unofficial.Threading.MutexSlim.LockToken.op_Equality(Pipelines.Sockets.Unofficial.Threading.MutexSlim.LockToken@,Pipelines.Sockets.Unofficial.Threading.MutexSlim.LockToken@)">
  2023. <summary>
  2024. Compare two LockToken instances for equality
  2025. </summary>
  2026. </member>
  2027. <member name="M:Pipelines.Sockets.Unofficial.Threading.MutexSlim.LockToken.op_Inequality(Pipelines.Sockets.Unofficial.Threading.MutexSlim.LockToken@,Pipelines.Sockets.Unofficial.Threading.MutexSlim.LockToken@)">
  2028. <summary>
  2029. Compare two LockToken instances for equality
  2030. </summary>
  2031. </member>
  2032. <member name="M:Pipelines.Sockets.Unofficial.Threading.MutexSlim.LockToken.Equals(System.Object)">
  2033. <summary>
  2034. Compare two LockToken instances for equality
  2035. </summary>
  2036. </member>
  2037. <member name="M:Pipelines.Sockets.Unofficial.Threading.MutexSlim.LockToken.GetHashCode">
  2038. <summary>
  2039. See Object.GetHashCode
  2040. </summary>
  2041. </member>
  2042. <member name="M:Pipelines.Sockets.Unofficial.Threading.MutexSlim.LockToken.ToString">
  2043. <summary>
  2044. See Object.ToString()
  2045. </summary>
  2046. </member>
  2047. <member name="M:Pipelines.Sockets.Unofficial.Threading.MutexSlim.LockToken.Equals(Pipelines.Sockets.Unofficial.Threading.MutexSlim.LockToken@)">
  2048. <summary>
  2049. Compare two LockToken instances for equality
  2050. </summary>
  2051. </member>
  2052. <member name="M:Pipelines.Sockets.Unofficial.Threading.MutexSlim.LockToken.op_True(Pipelines.Sockets.Unofficial.Threading.MutexSlim.LockToken@)">
  2053. <summary>
  2054. Indicates whether the mutex was successfully taken
  2055. </summary>
  2056. </member>
  2057. <member name="M:Pipelines.Sockets.Unofficial.Threading.MutexSlim.LockToken.op_False(Pipelines.Sockets.Unofficial.Threading.MutexSlim.LockToken@)">
  2058. <summary>
  2059. Indicates whether the mutex was successfully taken
  2060. </summary>
  2061. </member>
  2062. <member name="P:Pipelines.Sockets.Unofficial.Threading.MutexSlim.LockToken.Success">
  2063. <summary>
  2064. Indicates whether the mutex was successfully taken
  2065. </summary>
  2066. </member>
  2067. <member name="M:Pipelines.Sockets.Unofficial.Threading.MutexSlim.LockToken.Dispose">
  2068. <summary>
  2069. Release the mutex, if obtained
  2070. </summary>
  2071. </member>
  2072. <member name="T:Pipelines.Sockets.Unofficial.UnmanagedMemoryManager`1">
  2073. <summary>
  2074. A MemoryManager over a raw pointer
  2075. </summary>
  2076. <remarks>The pointer is assumed to be fully unmanaged, or externally pinned - no attempt will be made to pin this data</remarks>
  2077. </member>
  2078. <member name="M:Pipelines.Sockets.Unofficial.UnmanagedMemoryManager`1.#ctor(System.Span{`0})">
  2079. <summary>
  2080. Create a new UnmanagedMemoryManager instance at the given pointer and size
  2081. </summary>
  2082. <remarks>It is assumed that the span provided is already unmanaged or externally pinned</remarks>
  2083. </member>
  2084. <member name="M:Pipelines.Sockets.Unofficial.UnmanagedMemoryManager`1.#ctor(`0*,System.Int32)">
  2085. <summary>
  2086. Create a new UnmanagedMemoryManager instance at the given pointer and size
  2087. </summary>
  2088. </member>
  2089. <member name="M:Pipelines.Sockets.Unofficial.UnmanagedMemoryManager`1.#ctor(System.IntPtr,System.Int32)">
  2090. <summary>
  2091. Create a new UnmanagedMemoryManager instance at the given pointer and size
  2092. </summary>
  2093. </member>
  2094. <member name="M:Pipelines.Sockets.Unofficial.UnmanagedMemoryManager`1.GetSpan">
  2095. <summary>
  2096. Obtains a span that represents the region
  2097. </summary>
  2098. </member>
  2099. <member name="M:Pipelines.Sockets.Unofficial.UnmanagedMemoryManager`1.Pin(System.Int32)">
  2100. <summary>
  2101. Provides access to a pointer that represents the data (note: no actual pin occurs)
  2102. </summary>
  2103. </member>
  2104. <member name="M:Pipelines.Sockets.Unofficial.UnmanagedMemoryManager`1.Unpin">
  2105. <summary>
  2106. Has no effect
  2107. </summary>
  2108. </member>
  2109. <member name="M:Pipelines.Sockets.Unofficial.UnmanagedMemoryManager`1.Dispose(System.Boolean)">
  2110. <summary>
  2111. Releases all resources associated with this object
  2112. </summary>
  2113. </member>
  2114. </members>
  2115. </doc>