-
Notifications
You must be signed in to change notification settings - Fork 27
/
Copy pathindex.html
195 lines (181 loc) · 7.77 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Open.ChannelExtensions </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Open.ChannelExtensions ">
<meta name="generator" content="docfx 2.47.0.0">
<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="styles/docfx.vendor.css">
<link rel="stylesheet" href="styles/docfx.css">
<link rel="stylesheet" href="styles/main.css">
<meta property="docfx:navrel" content="toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">
<img id="logo" class="svg" src="logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="article row grid">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="">
<h1 id="openchannelextensions">Open.ChannelExtensions</h1>
<p>A set of extensions for optimizing/simplifying System.Threading.Channels usage.</p>
<h2 id="highlights">Highlights</h2>
<p>Being able to define an asynchronous pipeline with best practice usage using simple expressive syntax:</p>
<pre><code class="lang-cs">await Channel
.CreateBounded<T>(10)
.SourceAsync(source /* IEnumerable<Task<T>> */)
.PipeAsync(
maxConcurrency: 2,
capacity: 5,
transform: asyncTransform01)
.Pipe(transform02, /* capacity */ 3)
.ReadAllAsync(finalTransformedValue => {
// Do something async with each final value.
});
</code></pre>
<pre><code class="lang-cs">await source /* IEnumerable<T> */
.ToChannel(boundedSize: 10, singleReader: true)
.PipeAsync(asyncTransform01, /* capacity */ 5)
.Pipe(
maxConcurrency: 2,
capacity: 3,
transform: transform02)
.ReadAll(finalTransformedValue => {
// Do something with each final value.
});
</code></pre>
<h2 id="examples">Examples</h2>
<h3 id="reading-until-the-channel-is-closed">Reading (until the channel is closed)</h3>
<h4 id="one-by-one-read-each-entry-from-the-channel">One by one read each entry from the channel</h4>
<pre><code class="lang-cs">await channel.ReadAll(
entry => { /* Processing Code */ });
</code></pre>
<pre><code class="lang-cs">await channel.ReadAll(
(entry, index) => { /* Processing Code */ });
</code></pre>
<pre><code class="lang-cs">await channel.ReadAllAsync(
async entry => { await /* Processing Code */ });
</code></pre>
<pre><code class="lang-cs">await channel.ReadAllAsync(
async (entry, index) => { await /* Processing Code */ });
</code></pre>
<h4 id="read-concurrently-each-entry-from-the-channel">Read concurrently each entry from the channel</h4>
<pre><code class="lang-cs">await channel.ReadAllConcurrently(
maxConcurrency,
entry => { /* Processing Code */ });
</code></pre>
<pre><code class="lang-cs">await channel.ReadAllConcurrentlyAsync(
maxConcurrency,
async entry => { await /* Processing Code */ });
</code></pre>
<h3 id="writing">Writing</h3>
<p>If <code>complete</code> is <code>true</code>, the channel will be closed when the source is empty.</p>
<h4 id="dump-a-source-enumeration-into-the-channel">Dump a source enumeration into the channel</h4>
<pre><code class="lang-cs">// source can be any IEnumerable<T>.
await channel.WriteAll(source, complete: true);
</code></pre>
<pre><code class="lang-cs">// source can be any IEnumerable<Task<T>> or IEnumerable<ValueTask<T>>.
await channel.WriteAllAsync(source, complete: true);
</code></pre>
<h4 id="synchronize-reading-from-the-source-and-process-the-results-concurrently">Synchronize reading from the source and process the results concurrently</h4>
<pre><code class="lang-cs">// source can be any IEnumerable<Task<T>> or IEnumerable<ValueTask<T>>.
await channel.WriteAllConcurrentlyAsync(
maxConcurrency, source, complete: true);
</code></pre>
<h3 id="pipelining--transforming">Pipelining / Transforming</h3>
<h4 id="transform-and-buffer-entries">Transform and buffer entries</h4>
<pre><code class="lang-cs">// Transform values in a source channel to new unbounded channel.
var transformed = channel.Pipe(
async value => /* transformation */);
</code></pre>
<pre><code class="lang-cs">// Transform values in a source channel to new unbounded channel with a max concurrency of X.
const X = 4;
var transformed = channel.Pipe(
X, async value => /* transformation */);
</code></pre>
<pre><code class="lang-cs">// Transform values in a source channel to new bounded channel bound of N entries.
const N = 5;
var transformed = channel.Pipe(
async value => /* transformation */, N);
</code></pre>
<pre><code class="lang-cs">// Transform values in a source channel to new bounded channel bound of N entries with a max concurrency of X.
const X = 4;
const N = 5;
var transformed = channel.Pipe(
X, async value => /* transformation */, N);
// or
transformed = channel.Pipe(
maxConcurrency: X,
capacity: N,
transform: async value => /* transformation */);
</code></pre>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/electricessence/Open.ChannelExtensions/blob/master/docfx/index.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="styles/docfx.vendor.js"></script>
<script type="text/javascript" src="styles/docfx.js"></script>
<script type="text/javascript" src="styles/main.js"></script>
</body>
</html>