geode-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From n...@apache.org
Subject [geode] 11/11: GEODE-7204: Add changes to AEQ documentation for 'pause-event-processing' functionality (#4053)
Date Tue, 17 Sep 2019 16:31:13 GMT
This is an automated email from the ASF dual-hosted git repository.

nnag pushed a commit to branch release/1.10.0
in repository https://gitbox.apache.org/repos/asf/geode.git

commit 972b870dc0527d88d1c621044ec7749a2edbf13c
Author: BenjaminPerryRoss <39068135+BenjaminPerryRoss@users.noreply.github.com>
AuthorDate: Mon Sep 16 09:27:45 2019 -0700

    GEODE-7204: Add changes to AEQ documentation for 'pause-event-processing' functionality
(#4053)
    
            * Added documentation for the "pause-event-processing" attribute
            * Added documentation for resume async-event-queue-dispatcher command
            * Updated gfsh and cache.xml references for AEQ commands
    
    Co-authored-by: Benjamin Ross <bross@pivotal.io>
    Co-authored-by: Donal Evans <doevans@pivotal.io>
---
 .../source/subnavs/geode-subnav.erb                | 14 +++++--
 .../cluster_config/gfsh_persist.html.md.erb        |  5 ++-
 .../implementing_authorization.html.md.erb         |  3 ++
 geode-docs/reference/topics/cache_xml.html.md.erb  |  5 +++
 .../gfsh/cache_xml_2_gfsh.html.md.erb              |  3 ++
 .../gfsh/command-pages/alter.html.md.erb           |  3 +-
 .../gfsh/command-pages/create.html.md.erb          | 10 ++++-
 .../gfsh/command-pages/resume.html.md.erb          | 48 +++++++++++++++++++---
 .../gfsh/quick_ref_commands_by_area.html.md.erb    |  9 +++-
 9 files changed, 86 insertions(+), 14 deletions(-)

diff --git a/geode-book/master_middleman/source/subnavs/geode-subnav.erb b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
index 4b91666..c46e812 100644
--- a/geode-book/master_middleman/source/subnavs/geode-subnav.erb
+++ b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
@@ -1914,9 +1914,17 @@ gfsh</a>
                                     <li>
                                         <a href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/remove.html">remove</a>
                                     </li>
-                                    <li>
-                                        <a href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/resume.html">resume
gateway-sender</a>
-                                    </li>
+                                    <li class="has_submenu">
+                                        <a href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/resume.html">resume</a>
+                                        <ul>
+                                            <li>
+                                                <a href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/resume.html#topic_resume_async_event_queue_dispatcher">resume
async-event-queue-dispatcher</a>
+                                            </li>
+                                            <li>
+                                                <a href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/resume.html#topic_resume_gateway_sender">resume
gateway-sender</a>
+                                            </li>
+                                        </ul>
+                                        </li>
                                     <li>
                                         <a href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/revoke.html">revoke
missing-disk-store</a>
                                     </li>
diff --git a/geode-docs/configuring/cluster_config/gfsh_persist.html.md.erb b/geode-docs/configuring/cluster_config/gfsh_persist.html.md.erb
index 6c1fcf2..9603342 100644
--- a/geode-docs/configuring/cluster_config/gfsh_persist.html.md.erb
+++ b/geode-docs/configuring/cluster_config/gfsh_persist.html.md.erb
@@ -76,10 +76,14 @@ The following `gfsh` commands cause the configuration to be written to
all locat
 -   `create disk-store`
 -   `destroy disk-store`
 -   `create async-event-queue`
+-   `alter async-event-queue`
+-   `destroy async-event-queue`
 -   `deploy jar`
 -   `undeploy jar`
 -   `create gateway-sender`
+-   `destroy gateway-sender`
 -   `create gateway-receiver`
+-   `destroy gateway-receiver`
 
 **\*** Note that the `configure pdx` command must be executed *before* starting your data
members. This command does not affect any currently running members in the system. Data members
(with cluster configuration enabled) that are started after running this command will pick
up the new PDX configuration.
 
@@ -109,7 +113,6 @@ by using the API:
     -   `transaction-listener`
     -   `transaction-writer`
 -   Adding or removing a `TransactionListener`
--   Deleting an `AsyncEventQueue`
 -   Configuring a `GatewayConflictResolver`
 -   You cannot specify parameters and values for Java classes for the following:
     -   `gateway-listener`
diff --git a/geode-docs/managing/security/implementing_authorization.html.md.erb b/geode-docs/managing/security/implementing_authorization.html.md.erb
index 33356a8..7b05450 100644
--- a/geode-docs/managing/security/implementing_authorization.html.md.erb
+++ b/geode-docs/managing/security/implementing_authorization.html.md.erb
@@ -111,6 +111,7 @@ This table classifies the permissions assigned for `gfsh` operations.
 
 | `gfsh` Command                         | Assigned `ResourcePermission`
 |----------------------------------------|----------------------------------|
+| alter async-event-queue                | CLUSTER:MANAGE:DEPLOY            |
 | alter disk-store                       | CLUSTER:MANAGE:DISK              |
 | alter region                           | DATA:MANAGE:RegionName           |
 | alter runtime                          | CLUSTER:MANAGE                   |
@@ -140,6 +141,7 @@ This table classifies the permissions assigned for `gfsh` operations.
 | describe member                        | CLUSTER:READ                     |
 | describe offline-disk-store            | CLUSTER:READ                     |
 | describe region                        | CLUSTER:READ                     |
+| destroy async-event-queue              | CLUSTER:MANAGE                   |
 | destroy disk-store                     | CLUSTER:MANAGE:DISK              |
 | destroy function                       | CLUSTER:MANAGE:DEPLOY            |
 | destroy index                          | CLUSTER:MANAGE:QUERY             |
@@ -177,6 +179,7 @@ This table classifies the permissions assigned for `gfsh` operations.
 | query                                  | DATA:READ:RegionName             |
 | rebalance                              | DATA:MANAGE                      |
 | remove                                 | DATA:WRITE:RegionName or DATA:WRITE:RegionName:Key
|
+| resume async-event-queue-dispatcher    | CLUSTER:MANAGE                   |
 | resume gateway-sender                  | CLUSTER:MANAGE:GATEWAY           |
 | revoke mising-disk-store               | CLUSTER:MANAGE:DISK              |
 | search lucene                          | DATA:READ:RegionName             |
diff --git a/geode-docs/reference/topics/cache_xml.html.md.erb b/geode-docs/reference/topics/cache_xml.html.md.erb
index 694dd9c..c41e154 100644
--- a/geode-docs/reference/topics/cache_xml.html.md.erb
+++ b/geode-docs/reference/topics/cache_xml.html.md.erb
@@ -576,6 +576,11 @@ Configures a queue for sending region events to an AsyncEventListener
implementa
 <td>key</td>
 </tr>
 <tr class="even">
+<td>pause-event-processing</td>
+<td>When true, event dispatching from the queue to the listener(s) will be paused when
the AsyncEventQueue is started.</td>
+<td>false</td>
+</tr>
+<tr class="odd">
 <td>persistent</td>
 <td>Boolean value that determines whether <%=vars.product_name%> persists this
queue.</td>
 <td>False</td>
diff --git a/geode-docs/tools_modules/gfsh/cache_xml_2_gfsh.html.md.erb b/geode-docs/tools_modules/gfsh/cache_xml_2_gfsh.html.md.erb
index c845823..feccd65 100644
--- a/geode-docs/tools_modules/gfsh/cache_xml_2_gfsh.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/cache_xml_2_gfsh.html.md.erb
@@ -51,8 +51,11 @@ configure and manage a cluster.
 <tr class="even">
 <td>&lt;async-event-queue&gt;</td>
 <td><ul>
+<li><a href="command-pages/alter.html#topic_alter_async_event_queue">alter async-event-queue</a></li>
 <li><a href="command-pages/create.html#topic_ryz_pb1_dk">create async-event-queue</a></li>
+<li><a href="command-pages/destroy.html#topic_destroy-async-event-queue">destroy
async-event-queue</a></li>
 <li><a href="command-pages/list.html#topic_j22_kzk_2l">list async-event-queues</a></li>
+<li><a href="command-pages/resume.html#topic_resume_async_event_queue_dispatcher">resume
async-event-queue-dispatching</a></li>
 </ul></td>
 </tr>
 <tr class="odd">
diff --git a/geode-docs/tools_modules/gfsh/command-pages/alter.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/alter.html.md.erb
index 4989eab..f7623c9 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/alter.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/alter.html.md.erb
@@ -50,7 +50,7 @@ settings to take effect on that server.
 
 ``` pre
 alter async-event-queue --id=value [--batch-size=value] [--batch-time-interval=value]
-    [--max-queue-memory=value] [--if-exists(=value)]
+    [--max-queue-memory=value] [--if-exists(=value)] [--pause-event-processing(=value)]
 ```
 
 The required option, `--id`, identifies the async event queue to be altered.
@@ -64,6 +64,7 @@ The required option, `--id`, identifies the async event queue to be altered.
 | &#8209;&#8209;batch&#8209;time&#8209;interval | Maximum amount of time,
in ms, that can elapse before a batch is delivered |
 | &#8209;&#8209;max&#8209;queue&#8209;memory | Maximum amount of memory,
in megabytes, that the queue can consume before overflowing to disk |
 | &#8209;&#8209;if&#8209;exists | If the specified async event queue does not
exist, gfsh responds with a message to that effect. If this parameter is true, the response
is prefixed with the label "Skipping: ". Useful for scripted tests. Default (if the parameter
is not specified): false. Default (if the parameter is specified without value): true. |
+| &#8209;&#8209;pause&#8209;event&#8209;processing | Specifies whether event
dispatching from the queue to the listener(s) will be paused when the AsyncEventQueue is started.
Default (if the parameter is not specified): false. Default (if the parameter is specified
without value): true.
 
 **Example Commands:**
 
diff --git a/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb
index e0c2f3d..c0455d6 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb
@@ -74,8 +74,9 @@ create async-event-queue --id=value --listener=value [--groups=value(,value)*]
     [--disk-synchronous(=value)?] [--max-queue-memory=value]
     [--dispatcher-threads=value] [--order-policy=value]
     [--gateway-event-filter=value(,value)*]
-    [--gateway-event-substitution-filter=value] 
-    [--listener-param=value(,value)*]
+    [--gateway-event-substitution-filter=value]
+    [--listener-param=value(,value)*] [--forward-expiration-destroy(=value)?]
+    [--pause-event-processing(=value)?]
 ```
 
 **Parameters, create async-event-queue:**
@@ -180,6 +181,11 @@ create async-event-queue --id=value --listener=value [--groups=value(,value)*]
 <td>Enables forwarding of expiration destroy operations to AsyncEventListener instances.
If specified without a value, this parameter is set to “false”.</td>
 <td>false</td>
 </tr>
+<tr class="even">
+<td><span class="keyword parmname">\-\-pause-event-processing</span></td>
+<td>Specifies whether event dispatching from the queue to the listener(s) will be paused
when the AsyncEventQueue is started. If specified without a value, this parameter is set to
"true".</td>
+<td>false</td>
+</tr>
 </tbody>
 </table>
 
diff --git a/geode-docs/tools_modules/gfsh/command-pages/resume.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/resume.html.md.erb
index 855f6f3..8f4d72e 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/resume.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/resume.html.md.erb
@@ -1,5 +1,5 @@
 ---
-title:  resume gateway-sender
+title:  resume
 ---
 
 <!--
@@ -19,9 +19,49 @@ See the License for the specific language governing permissions and
 limitations under the License.
 -->
 
-Resume any gateway senders that you have paused.
+<a id="topic_resume_command"></a>
 
-Resume the gateway sender on a member or members.
+
+Modify an existing <%=vars.product_name%> resource.
+
+-   **[resume async-event-queue-dispatcher](#topic_resume_async_event_queue_dispatcher)**
+
+    Resume dispatching of events from the queue to the listener(s) for a specified asynchronous
event queue which is currently in a paused state.
+
+-   **[resume gateway-sender](#topic_resume_gateway_sender)**
+
+    Resume specified gateway sender that is currently in a paused state.
+
+## <a id="topic_resume_async_event_queue_dispatcher" class="no-quick-link"></a>resume
async-event-queue-dispatcher
+
+Resume dispatching of events on a specified asynchronous event queue which is currently in
a paused state.
+
+**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use
this command.
+
+**Syntax:**
+
+``` pre
+resume async-event-queue-dispatcher --id=value [--groups=value(,value)*]
+[--members=value(,value)*]
+```
+
+<a id="concept_resume_async_event_queue_dispatcher__table_rwp_vbg_2w"></a>
+
+| Name                                           | Description                          
                       |
+|------------------------------------------------|--------------------------------------------------------------|
+| <span class="keyword parmname">\\-\\-id</span>     | *Required.* ID of the
Asynchronous Event Queue.          |
+| <span class="keyword parmname">\\-\\-groups</span>  | Group(s) of members on
which to resume event dispatching for this queue.   |
+| <span class="keyword parmname">\\-\\-members</span> | Name/Id of the member(s)
on which to resume event dispatching for this queue. |
+
+**Example Commands:**
+
+``` pre
+resume async-event-queue-dispatcher --id=AEQ1 --groups=Group1
+```
+
+## <a id="topic_resume_gateway_sender" class="no-quick-link"></a>resume gateway-sender
+
+Resume a gateway sender which is currently in a paused sate.
 
 **Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use
this command.
 
@@ -40,8 +80,6 @@ resume gateway-sender --id=value [--groups=value(,value)*]
 | <span class="keyword parmname">\\-\\-groups</span>  | Group(s) of members on
which to resume the Gateway Sender.   |
 | <span class="keyword parmname">\\-\\-members</span> | Name/Id of the member(s)
on which to resume the Gateway Sender. |
 
-<span class="tablecap">Table 1. Resume Gateway-Sender Parameters</span>
-
 **Example Commands:**
 
 ``` pre
diff --git a/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb b/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb
index d5dd6b6..ba46393 100644
--- a/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb
@@ -169,15 +169,18 @@ limitations under the License.
 
 | Command                                                                               
                                                                                         
                                                                                         
               | Description                                                             
                                                                  | Availability |
 |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|--------------|
+| [alter async-event-queue](command-pages/alter.html#topic_alter_async_event_queue)   | Alter
attributes of a specified asynchronous event queue.       | online      |
 | [create async-event-queue](command-pages/create.html#topic_ryz_pb1_dk)                
                                                            | Creates an asynchronous event
queue.                                                                                   
                   | online       |
 | [create gateway-receiver](command-pages/create.html#topic_a4x_pb1_dk) | Creates a gateway
receiver on one or more members.                                                         
                               | online       |
 | [create gateway-sender](command-pages/create.html#topic_hg2_bjz_ck)                   
                                                                                         
| Creates a gateway sender on one or more members.                                       
                                                   | online       |
+| [destroy async-event-queue](command-pages/destroy.html#topic_destroy-async-event-queue)
                                                                                         
                   | Destroys an asynchronous event queue on one or more members.        
                                                                                  | online
      |
 | [destroy gateway-sender](command-pages/destroy.html#destroy-gs)                       
                                                                                      | Destroys
a gateway sender on one or more members.                                                 
                                         | online       |
 | [list async-event-queues](command-pages/list.html#topic_j22_kzk_2l)                   
                                                                                         
                   | Display a list of async event queues for all members.               
                                                                      | online       |
 | [list gateways](command-pages/list.html#topic_B1D89671C7B74074899C7D52F15849ED)       
                                                                                         
     | Displays the gateway senders and receivers for a member or members.               
                                                        | online       |
 | [load-balance gateway-sender](command-pages/load-balance.html#concept_fn2_qls_5q)     
                        | Causes the specified gateway sender to close its current connections
and reconnect to remote gateway receivers in a more balanced fashion. | online       |
 | [pause gateway-sender](command-pages/pause.html#concept_44B6EC91FD464A1A91E438D6DF65C9D6)
                                                                                         
                                              | Pause a gateway sender.                  
                                                                                         
       | online       |
-| [resume gateway-sender](command-pages/resume.html#concept_8B0532D13CF34E0CB04ACC3F14F1E4A2)
                                                                                         
                   | Resume any gateway senders that you have paused.                    
                                                                      | online       |
+| [resume async-event-queue-dispatcher](command-pages/resume.html#topic_resume_async_event_queue_dispatcher)
                                                                                         
                   | Resumes dispatching of events on a specified asynchronous event queue
which is currently in a paused state.   | online       |
+| [resume gateway-sender](command-pages/resume.html#concept_8B0532D13CF34E0CB04ACC3F14F1E4A2)
                                                                                         
                   | Resumes specified gateway sender that is currently in a paused state.
   | online       |
 | [start gateway-receiver](command-pages/start.html#topic_67738A5B68E84DEE95D1C92DAB2E26E5)
                                                                                         
    | Start the gateway receiver on a given member or group of members.                  
                                                       | online       |
 | [start gateway-sender](command-pages/start.html#topic_AB8BA3F42B9645A8BE9BD97CE2F839A8)
                                                                                         
                       | Start the gateway sender on a member or members.                
                                                                          | online       |
 | [status gateway-receiver](command-pages/status.html#topic_B0F45DC2D5F64FB1A2F738206BC6539E)
                                                                                         
              | Display the status of the specified gateway receiver.                    
                                                                 | online       |
@@ -191,9 +194,11 @@ limitations under the License.
 
 | Command                                                                               
                                                                                         
                             | Description                                           | Availability
|
 |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|--------------|
+| [alter async-event-queue](command-pages/alter.html#topic_alter_async_event_queue)   | Alter
attributes of a specified asynchronous event queue.       | online      |
 | [create async-event-queue](command-pages/create.html#topic_ryz_pb1_dk) | Creates an asynchronous
event queue.                  | online       |
+| [destroy async-event-queue](command-pages/destroy.html#topic_destroy-async-event-queue)
                                                                                         
                   | Destroys an asynchronous event queue on one or more members.        
                                                                                  | online
      |
 | [list async-event-queues](command-pages/list.html#topic_j22_kzk_2l)                   
                                 | Display a list of async event queues for all members. |
online       |
-
+| [resume async-event-queue-dispatcher](command-pages/resume.html#topic_resume_async_event_queue_dispatcher)
                                                                                         
                   | Resumes dispatching of events on a specified asynchronous event queue
which is currently in a paused state.                                                    
                                      | online       |
 ## <a id="topic_B742E9E862BA457082E2346581C97D03" class="no-quick-link"></a><%=vars.product_name%>
Monitoring Commands
 
 <a id="topic_B742E9E862BA457082E2346581C97D03__table_pkf_nz1_3l"></a>


Mime
View raw message