aboutsummaryrefslogtreecommitdiffstats
path: root/event/example_scope_test.go
blob: c413c3d74008a82b62dc10ae2bc1ba2f46320388 (plain) (blame)
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
// Copyright 2016 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package event_test

import (
    "fmt"
    "sync"

    "github.com/tangerine-network/go-tangerine/event"
)

// This example demonstrates how SubscriptionScope can be used to control the lifetime of
// subscriptions.
//
// Our example program consists of two servers, each of which performs a calculation when
// requested. The servers also allow subscribing to results of all computations.
type divServer struct{ results event.Feed }
type mulServer struct{ results event.Feed }

func (s *divServer) do(a, b int) int {
    r := a / b
    s.results.Send(r)
    return r
}

func (s *mulServer) do(a, b int) int {
    r := a * b
    s.results.Send(r)
    return r
}

// The servers are contained in an App. The app controls the servers and exposes them
// through its API.
type App struct {
    divServer
    mulServer
    scope event.SubscriptionScope
}

func (s *App) Calc(op byte, a, b int) int {
    switch op {
    case '/':
        return s.divServer.do(a, b)
    case '*':
        return s.mulServer.do(a, b)
    default:
        panic("invalid op")
    }
}

// The app's SubscribeResults method starts sending calculation results to the given
// channel. Subscriptions created through this method are tied to the lifetime of the App
// because they are registered in the scope.
func (s *App) SubscribeResults(op byte, ch chan<- int) event.Subscription {
    switch op {
    case '/':
        return s.scope.Track(s.divServer.results.Subscribe(ch))
    case '*':
        return s.scope.Track(s.mulServer.results.Subscribe(ch))
    default:
        panic("invalid op")
    }
}

// Stop stops the App, closing all subscriptions created through SubscribeResults.
func (s *App) Stop() {
    s.scope.Close()
}

func ExampleSubscriptionScope() {
    // Create the app.
    var (
        app  App
        wg   sync.WaitGroup
        divs = make(chan int)
        muls = make(chan int)
    )

    // Run a subscriber in the background.
    divsub := app.SubscribeResults('/', divs)
    mulsub := app.SubscribeResults('*', muls)
    wg.Add(1)
    go func() {
        defer wg.Done()
        defer fmt.Println("subscriber exited")
        defer divsub.Unsubscribe()
        defer mulsub.Unsubscribe()
        for {
            select {
            case result := <-divs:
                fmt.Println("division happened:", result)
            case result := <-muls:
                fmt.Println("multiplication happened:", result)
            case <-divsub.Err():
                return
            case <-mulsub.Err():
                return
            }
        }
    }()

    // Interact with the app.
    app.Calc('/', 22, 11)
    app.Calc('*', 3, 4)

    // Stop the app. This shuts down the subscriptions, causing the subscriber to exit.
    app.Stop()
    wg.Wait()

    // Output:
    // division happened: 2
    // multiplication happened: 12
    // subscriber exited
}