Apache Geode CHANGELOG

close

Close durable client CQs and durable clients.

  • close durable-client

    Attempts to close a durable client. The client must be disconnected for this command to work.

  • close durable-cq

    Closes the durable continuous query (CQ) registered by the durable client and drain events held for the durable CQ from the subscription queue.

close durable-client

Attempts to close a durable client. The client must be disconnected for this command to work.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:

close durable-client --durable-client-id=value [--members=value(,value)*]
[--groups=value(,value)*]

Name Description
--durable-client-id Required. The ID of the durable client.
--members Name or ID of the member(s) for which the durable client is to be closed.
--groups Group(s) of members for which the durable client is to be closed.

Table 1. Close Durable-Client Parameters

Example Commands:

close durable-client --durable-client-id=client1

Sample Output:

gfsh>close durable-client --durable-client-id=client1
Closed the durable client : "client1". on following members.
1.server4
2.server3

Error Messages:

gfsh>close durable-cq --durable-cq-name=cq1 --durable-client-id=client1

Could not close the durable-cq : "cq1" for the durable-client-id : "client1" due to following reasons.

CacheClientProxy: Could not drain cq cq1 because client proxy id client1 is connected.
Occurred on members
1.server4
2.server3

No client found with client-id : client1
Occurred on members
1.server1

close durable-cq

Closes the durable continuous query (CQ) registered by the durable client and drain events held for the durable CQ from the subscription queue.

Availability: Online. You must be connected in gfsh to a JMX Manager member to use this command.

Syntax:

close durable-cq --durable-client-id=value --durable-cq-name=value 
[--members=value(,value)*] [--groups=value(,value)*]

Name Description
--durable-client-id Required. The ID of the durable client.
--durable-cq-name Required. Name of the CQ to be closed.
--members Name or ID of the member(s) for which the durable client is registered and the durable CQ to be closed.
--groups Group(s) of members for which the durable client is registered and the durable CQ to be closed.

Table 2. Close Durable-CQ Parameters

Example Commands:

close durable-cq --durable-client-id=client1 --durable-cq-name=cq1

Sample Output:

gfsh>close durable-cq --durable-cq-name=cq1 --durable-client-id=client1
Closed the durable cq : "cq1" for the durable client : "client1". on following members.
1.server4
2.server3

Error Messages:

gfsh>close durable-client --durable-client-id=client1
Unable to close the durable client : "client1" due to following reasons.

Cannot close a running durable client : client1
Occurred on members
1.server4
2.server3

No client found with client-id : client1
Occurred on members
1.server1