fluencelabs/tendermint
1
0
Fork 0
mirror of https://github.com/fluencelabs/tendermint synced 2025-07-31 04:01:55 +00:00
Code Issues Projects Releases Wiki Activity

docs: update RPC docs for /subscribe & /unsubscribe (#3705)

Browse Source 
Fixes #3678

Co-Authored-By: Ethan Buchman <ethan@coinculture.info>
This commit is contained in:
Anton Kaliaev
2019-06-04 10:05:22 +09:00
committed by GitHub
parent 65a3dfe235
commit 99c9a35982
1 changed files with 16 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
rpc/core/events.go
View File

@@ -50,7 +50,6 @@ import (
// https://godoc.org/github.com/tendermint/tendermint/libs/pubsub/query.
//
// ```go
// import "github.com/tendermint/tendermint/libs/pubsub/query"
// import "github.com/tendermint/tendermint/types"
//
// client := client.NewHTTP("tcp://0.0.0.0:26657", "/websocket")
@@ -59,15 +58,17 @@ import (
// // handle error
// }
// defer client.Stop()
// ctx, cancel := context.WithTimeout(context.Background(), timeout)
// ctx, cancel := context.WithTimeout(context.Background(), 1 * time.Second)
// defer cancel()
// query := query.MustParse("tm.event = 'Tx' AND tx.height = 3")
// txs := make(chan interface{})
// err = client.Subscribe(ctx, "test-client", query, txs)
// query := "tm.event = 'Tx' AND tx.height = 3"
// txs, err := client.Subscribe(ctx, "test-client", query)
// if err != nil {
// // handle error
// }
//
// go func() {
// for e := range txs {
// fmt.Println("got ", e.(types.EventDataTx))
// fmt.Println("got ", e.Data.(types.EventDataTx))
// }
// }()
// ```
@@ -154,7 +155,11 @@ func Subscribe(ctx *rpctypes.Context, query string) (*ctypes.ResultSubscribe, er
// // handle error
// }
// defer client.Stop()
// err = client.Unsubscribe("test-client", query)
// query := "tm.event = 'Tx' AND tx.height = 3"
// err = client.Unsubscribe(context.Background(), "test-client", query)
// if err != nil {
// // handle error
// }
// ```
//
// > The above command returns JSON structured like this:
@@ -198,7 +203,10 @@ func Unsubscribe(ctx *rpctypes.Context, query string) (*ctypes.ResultUnsubscribe
// // handle error
// }
// defer client.Stop()
// err = client.UnsubscribeAll("test-client")
// err = client.UnsubscribeAll(context.Background(), "test-client")
// if err != nil {
// // handle error
// }
// ```
//
// > The above command returns JSON structured like this: