From 355e86c2cf11f980c643a319ef5d838b3bee7016 Mon Sep 17 00:00:00 2001 From: MadelineMurray <43356962+MadelineMurray@users.noreply.github.com> Date: Fri, 11 Jan 2019 13:55:18 +1100 Subject: [PATCH] Added --ws-refresh-delay option. (#493) Signed-off-by: Adrian Sutton --- docs/Reference/Pantheon-CLI-Syntax.md | 14 ++++++++++++++ docs/Using-Pantheon/RPC-PubSub.md | 13 ++++++++----- 2 files changed, 22 insertions(+), 5 deletions(-) diff --git a/docs/Reference/Pantheon-CLI-Syntax.md b/docs/Reference/Pantheon-CLI-Syntax.md index ee35ce75b5..d258d0f7ec 100644 --- a/docs/Reference/Pantheon-CLI-Syntax.md +++ b/docs/Reference/Pantheon-CLI-Syntax.md @@ -504,6 +504,20 @@ The default is 127.0.0.1:8546. !!!note This option is not used when running Pantheon from the [Docker image](../Getting-Started/Run-Docker-Image.md#exposing-ports). +### ws-refresh-delay + +```bash tab="Syntax" +--ws-refresh-delay= +``` + +```bash tab="Example" +--ws-refresh-delay="10000" +``` + +Refresh delay for Websocket synchronizing subscription in milliseconds. +The default is 5000. + + ### help ```bash tab="Syntax" diff --git a/docs/Using-Pantheon/RPC-PubSub.md b/docs/Using-Pantheon/RPC-PubSub.md index 8a9676f492..3b90e8942c 100644 --- a/docs/Using-Pantheon/RPC-PubSub.md +++ b/docs/Using-Pantheon/RPC-PubSub.md @@ -58,7 +58,7 @@ Use `eth_subscribe` to create subscriptions for the following event types: * [New headers](#new-headers) * [Logs](#logs) * [Pending transactions](#pending-transactions) -* [Sychronizng](#synchronizing) +* [Synchronizng](#synchronizing) ### New Headers @@ -147,7 +147,7 @@ are included in the notifications. Otherwise, the transaction hashes are include } ``` -#### Logs +### Logs Use the `logs` parameter with `eth_subscribe` to be notified of logs included in new blocks. You can specify a [filter object](../Reference/JSON-RPC-API-Objects.md#filter-options-object) to receive notifications @@ -204,7 +204,7 @@ The logs subscription returns [Log objects](../Reference/JSON-RPC-API-Objects.md } ``` -#### Pending Transactions +### Pending Transactions Use the `newPendingTransactions` parameter with `eth_subscribe` to be notified of pending transactions added to the transaction pool for the node. @@ -239,11 +239,14 @@ This means the subscription can publish notifications for the same pending trans } ``` -#### Synchronizing +### Synchronizing Use the `syncing` parameter with `eth_subscribe` to be notified about synchronization progress. -The sychronizing subscription returns an object indicating the synchronization progress. +The synchronizing subscription returns an object indicating the synchronization progress. + +Use the [`--ws-refresh-delay` option](../Reference/Pantheon-CLI-Syntax.md#ws-refresh-delay) to configure how +often the synchronizing subscription returns an object. The default is 5000 milliseconds. !!!example To subscribe to synchronizing notifications: