Skip to content

Commit

Permalink
deploy: fd542c0
Browse files Browse the repository at this point in the history
  • Loading branch information
@peterbroadhurst
peterbroadhurst committed Jan 19, 2024
1 parent fb017b6 commit 49adeb8
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 12 deletions.
12 changes: 6 additions & 6 deletions head/assets/js/search-data.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -913,7 +913,7 @@
},"152": {
"doc": "Configuration Reference",
"title": "event.aggregator",
"content": "| Key | Description | Type | Default Value | . | batchSize | The maximum number of records to read from the DB before performing an aggregation run | BytesSize | 200 | . | batchTimeout | How long to wait for new events to arrive before performing aggregation on a page of events | time.Duration | 250ms | . | firstEvent | The first event the aggregator should process, if no previous offest is stored in the DB. Valid options are oldest or newest | string | oldest | . | pollTimeout | The time to wait without a notification of new events, before trying a select on the table | time.Duration | 30s | . | rewindQueryLimit | Safety limit on the maximum number of records to search when performing queries to search for rewinds | int | 1000 | . | rewindQueueLength | The size of the queue into the rewind dispatcher | int | 10 | . | rewindTimeout | The minimum time to wait for rewinds to accumulate before resolving them | time.Duration | 50ms | . ",
"content": "| Key | Description | Type | Default Value | . | batchSize | The maximum number of records to read from the DB before performing an aggregation run | BytesSize | 200 | . | batchTimeout | How long to wait for new events to arrive before performing aggregation on a page of events | time.Duration | 0ms | . | firstEvent | The first event the aggregator should process, if no previous offest is stored in the DB. Valid options are oldest or newest | string | oldest | . | pollTimeout | The time to wait without a notification of new events, before trying a select on the table | time.Duration | 30s | . | rewindQueryLimit | Safety limit on the maximum number of records to search when performing queries to search for rewinds | int | 1000 | . | rewindQueueLength | The size of the queue into the rewind dispatcher | int | 10 | . | rewindTimeout | The minimum time to wait for rewinds to accumulate before resolving them | time.Duration | 50ms | . ",
"url": "/firefly/head/reference/config.html#eventaggregator",
"relUrl": "/reference/config.html#eventaggregator"
},"153": {
Expand All @@ -931,7 +931,7 @@
},"155": {
"doc": "Configuration Reference",
"title": "event.dispatcher",
"content": "| Key | Description | Type | Default Value | . | batchTimeout | A short time to wait for new events to arrive before re-polling for new events | time.Duration | 250ms | . | bufferLength | The number of events + attachments an individual dispatcher should hold in memory ready for delivery to the subscription | int | 5 | . | pollTimeout | The time to wait without a notification of new events, before trying a select on the table | time.Duration | 30s | . ",
"content": "| Key | Description | Type | Default Value | . | batchTimeout | A short time to wait for new events to arrive before re-polling for new events | time.Duration | 0ms | . | bufferLength | The number of events + attachments an individual dispatcher should hold in memory ready for delivery to the subscription | int | 5 | . | pollTimeout | The time to wait without a notification of new events, before trying a select on the table | time.Duration | 30s | . ",
"url": "/firefly/head/reference/config.html#eventdispatcher",
"relUrl": "/reference/config.html#eventdispatcher"
},"156": {
Expand Down Expand Up @@ -1651,7 +1651,7 @@
},"275": {
"doc": "Configuration Reference",
"title": "subscription.defaults",
"content": "| Key | Description | Type | Default Value | . | batchSize | Default read ahead to enable for subscriptions that do not explicitly configure readahead | int | 0 | . ",
"content": "| Key | Description | Type | Default Value | . | batchSize | Default read ahead to enable for subscriptions that do not explicitly configure readahead | int | 50 | . | batchTimeout | Default batch timeout | int | 50ms | . ",
"url": "/firefly/head/reference/config.html#subscriptiondefaults",
"relUrl": "/reference/config.html#subscriptiondefaults"
},"276": {
Expand Down Expand Up @@ -5029,7 +5029,7 @@
},"838": {
"doc": "WSAck",
"title": "WSAck",
"content": "An ack must be sent on a WebSocket for each event delivered to an application. Unless autoack is set in the WSStart payload/URL parameters to cause automatic acknowledgement. Your application should specify the id of each event that it acknowledges. If the id is omitted, then FireFly will assume the oldest message delivered to the application that has not been acknowledged is the one the ack is associated with. If multiple subscriptions are started on a WebSocket, then you need to specify the subscription namespace+name as part of each ack. If you send an acknowledgement that cannot be correlated, then a WSError payload will be sent to the application. Example . { \"type\": \"ack\", \"id\": \"f78bf82b-1292-4c86-8a08-e53d855f1a64\", \"subscription\": { \"namespace\": \"ns1\", \"name\": \"app1_subscription\" } } . Field Descriptions . | Field Name | Description | Type | . | type | WSActionBase.type | FFEnum:\"start\"\"ack\"\"protocol_error\" | . | id | WSAck.id | UUID | . | subscription | WSAck.subscription | SubscriptionRef | . ",
"content": "An ack must be sent on a WebSocket for each event delivered to an application. Unless autoack is set in the WSStart payload/URL parameters to cause automatic acknowledgement. Your application should specify the id of each event that it acknowledges. If the id is omitted, then FireFly will assume the oldest message delivered to the application that has not been acknowledged is the one the ack is associated with. If multiple subscriptions are started on a WebSocket, then you need to specify the subscription namespace+name as part of each ack. If you send an acknowledgement that cannot be correlated, then a WSError payload will be sent to the application. Example . { \"type\": \"ack\", \"id\": \"f78bf82b-1292-4c86-8a08-e53d855f1a64\", \"subscription\": { \"namespace\": \"ns1\", \"name\": \"app1_subscription\" } } . Field Descriptions . | Field Name | Description | Type | . | type | WSActionBase.type | FFEnum:\"start\"\"ack\"\"protocol_error\"\"event_batch\" | . | id | WSAck.id | UUID | . | subscription | WSAck.subscription | SubscriptionRef | . ",
"url": "/firefly/head/reference/types/wsack.html",
"relUrl": "/reference/types/wsack.html"
},"839": {
Expand All @@ -5053,7 +5053,7 @@
},"842": {
"doc": "WSError",
"title": "WSError",
"content": "Example . { \"type\": \"protocol_error\", \"error\": \"FF10175: Acknowledgment does not match an inflight event + subscription\" } . Field Descriptions . | Field Name | Description | Type | . | type | WSAck.type | FFEnum:\"start\"\"ack\"\"protocol_error\" | . | error | WSAck.error | string | . ",
"content": "Example . { \"type\": \"protocol_error\", \"error\": \"FF10175: Acknowledgment does not match an inflight event + subscription\" } . Field Descriptions . | Field Name | Description | Type | . | type | WSAck.type | FFEnum:\"start\"\"ack\"\"protocol_error\"\"event_batch\" | . | error | WSAck.error | string | . ",
"url": "/firefly/head/reference/types/wserror.html",
"relUrl": "/reference/types/wserror.html"
},"843": {
Expand All @@ -5071,7 +5071,7 @@
},"845": {
"doc": "WSStart",
"title": "WSStart",
"content": "The start payload is sent after an application connects to a WebSocket, to start delivery of events over that connection. The start command can refer to a subscription by name in order to reliably receive all matching events for that subscription, including those that were emitted when the application was disconnected. Alternatively the start command can request \"ephemeral\": true in order to dynamically create a new subscription that lasts only for the duration that the connection is active. Example . { \"type\": \"start\", \"autoack\": false, \"namespace\": \"ns1\", \"name\": \"app1_subscription\", \"ephemeral\": false, \"filter\": { \"message\": {}, \"transaction\": {}, \"blockchainevent\": {} }, \"options\": {} } . Field Descriptions . | Field Name | Description | Type | . | type | WSActionBase.type | FFEnum:\"start\"\"ack\"\"protocol_error\" | . | autoack | WSStart.autoack | bool | . | namespace | WSStart.namespace | string | . | name | WSStart.name | string | . | ephemeral | WSStart.ephemeral | bool | . | filter | WSStart.filter | SubscriptionFilter | . | options | WSStart.options | SubscriptionOptions | . ",
"content": "The start payload is sent after an application connects to a WebSocket, to start delivery of events over that connection. The start command can refer to a subscription by name in order to reliably receive all matching events for that subscription, including those that were emitted when the application was disconnected. Alternatively the start command can request \"ephemeral\": true in order to dynamically create a new subscription that lasts only for the duration that the connection is active. Example . { \"type\": \"start\", \"autoack\": false, \"namespace\": \"ns1\", \"name\": \"app1_subscription\", \"ephemeral\": false, \"filter\": { \"message\": {}, \"transaction\": {}, \"blockchainevent\": {} }, \"options\": {} } . Field Descriptions . | Field Name | Description | Type | . | type | WSActionBase.type | FFEnum:\"start\"\"ack\"\"protocol_error\"\"event_batch\" | . | autoack | WSStart.autoack | bool | . | namespace | WSStart.namespace | string | . | name | WSStart.name | string | . | ephemeral | WSStart.ephemeral | bool | . | filter | WSStart.filter | SubscriptionFilter | . | options | WSStart.options | SubscriptionOptions | . ",
"url": "/firefly/head/reference/types/wsstart.html",
"relUrl": "/reference/types/wsstart.html"
},"846": {
Expand Down
12 changes: 9 additions & 3 deletions head/reference/config.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1294,7 +1294,7 @@ <h2 id="eventaggregator">
<td>batchTimeout</td>
<td>How long to wait for new events to arrive before performing aggregation on a page of events</td>
<td><a href="https://pkg.go.dev/time#Duration"><code class="language-plaintext highlighter-rouge">time.Duration</code></a></td>
<td><code class="language-plaintext highlighter-rouge">250ms</code></td>
<td><code class="language-plaintext highlighter-rouge">0ms</code></td>
</tr>
<tr>
<td>firstEvent</td>
Expand Down Expand Up @@ -1417,7 +1417,7 @@ <h2 id="eventdispatcher">
<td>batchTimeout</td>
<td>A short time to wait for new events to arrive before re-polling for new events</td>
<td><a href="https://pkg.go.dev/time#Duration"><code class="language-plaintext highlighter-rouge">time.Duration</code></a></td>
<td><code class="language-plaintext highlighter-rouge">250ms</code></td>
<td><code class="language-plaintext highlighter-rouge">0ms</code></td>
</tr>
<tr>
<td>bufferLength</td>
Expand Down Expand Up @@ -7165,7 +7165,13 @@ <h2 id="subscriptiondefaults">
<td>batchSize</td>
<td>Default read ahead to enable for subscriptions that do not explicitly configure readahead</td>
<td><code class="language-plaintext highlighter-rouge">int</code></td>
<td><code class="language-plaintext highlighter-rouge">0</code></td>
<td><code class="language-plaintext highlighter-rouge">50</code></td>
</tr>
<tr>
<td>batchTimeout</td>
<td>Default batch timeout</td>
<td><code class="language-plaintext highlighter-rouge">int</code></td>
<td><code class="language-plaintext highlighter-rouge">50ms</code></td>
</tr>
</tbody>
</table>
Expand Down
2 changes: 1 addition & 1 deletion head/reference/types/wsack.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ <h3 id="field-descriptions">
<tr>
<td><code class="language-plaintext highlighter-rouge">type</code></td>
<td>WSActionBase.type</td>
<td><code class="language-plaintext highlighter-rouge">FFEnum</code>:<br /><code class="language-plaintext highlighter-rouge">"start"</code><br /><code class="language-plaintext highlighter-rouge">"ack"</code><br /><code class="language-plaintext highlighter-rouge">"protocol_error"</code></td>
<td><code class="language-plaintext highlighter-rouge">FFEnum</code>:<br /><code class="language-plaintext highlighter-rouge">"start"</code><br /><code class="language-plaintext highlighter-rouge">"ack"</code><br /><code class="language-plaintext highlighter-rouge">"protocol_error"</code><br /><code class="language-plaintext highlighter-rouge">"event_batch"</code></td>
</tr>
<tr>
<td><code class="language-plaintext highlighter-rouge">id</code></td>
Expand Down
2 changes: 1 addition & 1 deletion head/reference/types/wserror.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ <h3 id="field-descriptions">
<tr>
<td><code class="language-plaintext highlighter-rouge">type</code></td>
<td>WSAck.type</td>
<td><code class="language-plaintext highlighter-rouge">FFEnum</code>:<br /><code class="language-plaintext highlighter-rouge">"start"</code><br /><code class="language-plaintext highlighter-rouge">"ack"</code><br /><code class="language-plaintext highlighter-rouge">"protocol_error"</code></td>
<td><code class="language-plaintext highlighter-rouge">FFEnum</code>:<br /><code class="language-plaintext highlighter-rouge">"start"</code><br /><code class="language-plaintext highlighter-rouge">"ack"</code><br /><code class="language-plaintext highlighter-rouge">"protocol_error"</code><br /><code class="language-plaintext highlighter-rouge">"event_batch"</code></td>
</tr>
<tr>
<td><code class="language-plaintext highlighter-rouge">error</code></td>
Expand Down
2 changes: 1 addition & 1 deletion head/reference/types/wsstart.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ <h3 id="field-descriptions">
<tr>
<td><code class="language-plaintext highlighter-rouge">type</code></td>
<td>WSActionBase.type</td>
<td><code class="language-plaintext highlighter-rouge">FFEnum</code>:<br /><code class="language-plaintext highlighter-rouge">"start"</code><br /><code class="language-plaintext highlighter-rouge">"ack"</code><br /><code class="language-plaintext highlighter-rouge">"protocol_error"</code></td>
<td><code class="language-plaintext highlighter-rouge">FFEnum</code>:<br /><code class="language-plaintext highlighter-rouge">"start"</code><br /><code class="language-plaintext highlighter-rouge">"ack"</code><br /><code class="language-plaintext highlighter-rouge">"protocol_error"</code><br /><code class="language-plaintext highlighter-rouge">"event_batch"</code></td>
</tr>
<tr>
<td><code class="language-plaintext highlighter-rouge">autoack</code></td>
Expand Down

0 comments on commit 49adeb8

Please sign in to comment.