You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
125 lines
3.3 KiB
125 lines
3.3 KiB
package core
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/pkg/errors"
|
|
|
|
ctypes "github.com/tendermint/tendermint/rpc/core/types"
|
|
rpctypes "github.com/tendermint/tendermint/rpc/lib/types"
|
|
tmtypes "github.com/tendermint/tendermint/types"
|
|
tmquery "github.com/tendermint/tmlibs/pubsub/query"
|
|
)
|
|
|
|
// Subscribe for events via WebSocket.
|
|
//
|
|
// ```go
|
|
// import "github.com/tendermint/tendermint/types"
|
|
//
|
|
// client := client.NewHTTP("tcp://0.0.0.0:46657", "/websocket")
|
|
// result, err := client.AddListenerForEvent(types.EventStringNewBlock())
|
|
// ```
|
|
//
|
|
// > The above command returns JSON structured like this:
|
|
//
|
|
// ```json
|
|
// {
|
|
// "error": "",
|
|
// "result": {},
|
|
// "id": "",
|
|
// "jsonrpc": "2.0"
|
|
// }
|
|
// ```
|
|
//
|
|
// ### Query Parameters
|
|
//
|
|
// | Parameter | Type | Default | Required | Description |
|
|
// |-----------+--------+---------+----------+-------------|
|
|
// | event | string | "" | true | Event name |
|
|
//
|
|
// <aside class="notice">WebSocket only</aside>
|
|
func Subscribe(wsCtx rpctypes.WSRPCContext, query string) (*ctypes.ResultSubscribe, error) {
|
|
addr := wsCtx.GetRemoteAddr()
|
|
logger.Info("Subscribe to query", "remote", addr, "query", query)
|
|
|
|
q, err := tmquery.New(query)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "failed to parse query")
|
|
}
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), subscribeTimeout)
|
|
defer cancel()
|
|
ch := make(chan interface{})
|
|
err = eventBusFor(wsCtx).Subscribe(ctx, addr, q, ch)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
go func() {
|
|
for event := range ch {
|
|
tmResult := &ctypes.ResultEvent{query, event.(tmtypes.TMEventData)}
|
|
wsCtx.TryWriteRPCResponse(rpctypes.NewRPCSuccessResponse(wsCtx.Request.ID+"#event", tmResult))
|
|
}
|
|
}()
|
|
|
|
return &ctypes.ResultSubscribe{}, nil
|
|
}
|
|
|
|
// Unsubscribe from events via WebSocket.
|
|
//
|
|
// ```go
|
|
// import 'github.com/tendermint/tendermint/types'
|
|
//
|
|
// client := client.NewHTTP("tcp://0.0.0.0:46657", "/websocket")
|
|
// result, err := client.RemoveListenerForEvent(types.EventStringNewBlock())
|
|
// ```
|
|
//
|
|
// > The above command returns JSON structured like this:
|
|
//
|
|
// ```json
|
|
// {
|
|
// "error": "",
|
|
// "result": {},
|
|
// "id": "",
|
|
// "jsonrpc": "2.0"
|
|
// }
|
|
// ```
|
|
//
|
|
// ### Query Parameters
|
|
//
|
|
// | Parameter | Type | Default | Required | Description |
|
|
// |-----------+--------+---------+----------+-------------|
|
|
// | event | string | "" | true | Event name |
|
|
//
|
|
// <aside class="notice">WebSocket only</aside>
|
|
func Unsubscribe(wsCtx rpctypes.WSRPCContext, query string) (*ctypes.ResultUnsubscribe, error) {
|
|
addr := wsCtx.GetRemoteAddr()
|
|
logger.Info("Unsubscribe from query", "remote", addr, "query", query)
|
|
q, err := tmquery.New(query)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "failed to parse query")
|
|
}
|
|
err = eventBusFor(wsCtx).Unsubscribe(context.Background(), addr, q)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return &ctypes.ResultUnsubscribe{}, nil
|
|
}
|
|
|
|
func UnsubscribeAll(wsCtx rpctypes.WSRPCContext) (*ctypes.ResultUnsubscribe, error) {
|
|
addr := wsCtx.GetRemoteAddr()
|
|
logger.Info("Unsubscribe from all", "remote", addr)
|
|
err := eventBusFor(wsCtx).UnsubscribeAll(context.Background(), addr)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return &ctypes.ResultUnsubscribe{}, nil
|
|
}
|
|
|
|
func eventBusFor(wsCtx rpctypes.WSRPCContext) tmtypes.EventBusSubscriber {
|
|
es := wsCtx.GetEventSubscriber()
|
|
if es == nil {
|
|
es = eventBus
|
|
}
|
|
return es
|
|
}
|