go-piper

An easy way to build your Go programs with a pipeline pattern.

Go-piper creates N goroutines for each pipeline step all connected through unbuffered channels. The input data is guided through all steps' workers and the result is sent to the output channel.

Important

The pipeline will only work if your output channel is constantly consumed.

For more documentation, please refer to

Install

go get github.com/pedronasser/go-piper

Example

package main

import (
        "fmt"
        "strconv"

        // Import go-piper
        "github.com/pedronasser/go-piper"
)

func main() {
        // Create new Piper
        pipe, err := piper.New(

                // Creating first step
                piper.P(1, // Number of workers

                        // First step's function
                        func(d interface{}) interface{} { // Should always receive and return interface{}
                                var i int
                                var ok bool

                                if i, ok = d.(int); !ok {
                                    // If not integer, discard
                                    return nil
                                }

                                r := i * i
                                return r
                        },
                ),

                // Creating second step
                piper.P(1, // Number of workers

                        // Second step's function
                        func(d interface{}) interface{} { // Should always receive and return interface{}
                                var i int
                                var ok bool

                                if i, ok = d.(int); !ok {
                                    // If not integer, discard
                                    return nil
                                }

                                r := strconv.Itoa(i)
                                return r // returning as string
                        },
                ),
        )

        // Error check
        if err != nil {
                panic(err)
        }

        // Defering close
        defer pipe.Close()

        // Getting input and output channels
        in := pipe.Input()
        out := pipe.Output()

        in <- 1 // Sending first data
        in <- 1 // Sending second data

        fmt.Println((<-out).(string)) // Receiving first result
        fmt.Println((<-out).(string)) // Receiving second result
}

Other examples

• https://github.com/pedronasser/go-piper/blob/master/examples/

License

See LICENSE file.