-
Notifications
You must be signed in to change notification settings - Fork 0
/
pipe.go
44 lines (44 loc) · 2.7 KB
/
pipe.go
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
// Package pipe provides a convenient way to work with Go channels and simple construction of pipelines with a wide
// range of logic gates.
//
// # Processing Strategies
//
// Some functions have different channel processing algorithms. To ensure maximum performance, it is recommended
// to use the original function. However, specific algorithms can help in cases where you are faced with a race of
// threads or you need to output data strictly in the same order in which you received them.
//
// - Parallel - Each handler is executed in its own goroutine and there is no guarantee that the output order
// will be consistent. Recommended for best performance.
// - Sync - Each handler executes in its own goroutine, but the result of the youngest goroutine waits for the oldest
// goroutine to finish before being passed to the output stream. To prevent memory leaks, the strategy will wait if
// there is more waiting data than the capacity of the output channel. Recommended if you want to get the output
// data in the same order as the input data.
// - Sequential - Each handler is executed sequentially, one after the other. Keeps the order of the output data
// equal to the order of the input data. Recommended if it is necessary to exclude the race of threads between
// handlers.
//
// If the input channel capacity is 0 (no bandwidth), then any strategy will act as Sequential behavior.
//
// # Closing Strategies
//
// Each function has one of several strategies for closing output channels. Understanding will help you understand
// how and when your pipeline closes.
//
// - Single - Suitable only for functions with one input. If the input channel is closed, then the output channels
// are closed.
// - All - If all input channels are closed, then the output channels are closed.
// - Any - If one of the input channels is closed, the output channels are closed. All other channels will be read
// to the end in the background.
//
// # Capacity Strategies
//
// Each function creates new output channels with the capacity corresponding to a specific strategy.
//
// - Same - Suitable only for functions with one input channel. The output channels will have a capacity equal to
// the input channel.
// - Mult - Suitable only for functions with one input channel. The output channels will have a capacity equal to
// the input channel multiplied by N.
// - Min - The output channels will have a capacity equal to the minimum capacity of the input channels.
// - Max - The output channels will have a capacity equal to the maximum capacity of the input channels.
// - Sum - The output channels will have a capacity equal to the sum of capacities of the input channels.
package pipe