aboutsummaryrefslogtreecommitdiffstats
path: root/ethreact/README.md
blob: 592b50b96a874d8a18aff03a8b6854f0f90ce657 (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
# ethreact

ethereum event reactor. Component of the ethereum stack.
various events like state change on an account or new block found are broadcast to subscribers.
Broadcasting to subscribers is running on its own routine and globally order preserving.

## Clients
### subscribe

    eventChannel := make(chan ethreact.Event)
    reactor.Subscribe(event, eventChannel)

The same channel can be subscribed to multiple events but only once for each event. In order to allow order of events to be preserved, broadcast of events is synchronous within the main broadcast loop. Therefore any blocking subscriber channels will be skipped, i.e. missing broadcasting events while they are blocked.

### unsubscribe

    reactor.Unsubscribe(event, eventChannel)

### Processing events

event.Resource is of type interface{}. The actual type of event.Resource depends on event.Name and may need to be cast for processing.

    var event ethreact.Event
    for {
        select {
        case event = <-eventChannel:
            processTransaction(event.Resource.(Transaction))
        }
    }

## Broadcast 

    reactor := ethreact.New()
    reactor.Start()
    reactor.Post(name, resource)
    reactor.Flush() // wait till all broadcast messages are dispatched
    reactor.Stop() // stop the main broadcast loop immediately (even if there are unbroadcast events left)