/*
* Licensed to the Apache Software Foundation (ASF) under one or more contributor license
* agreements. See the NOTICE file distributed with this work for additional information regarding
* copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the License. You may obtain a
* copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package org.apache.geode.cache.query;
/**
* This class provides methods to get aggregate statistical information about the CQs of a client.
*
* @since GemFire 5.5
*/
public interface CqServiceStatistics {
/**
* Get the number of CQs currently active. Active CQs are those which are executing (in running
* state).
*
* @return long number of CQs
*/
public long numCqsActive();
/**
* Get the total number of CQs created. This is a cumulative number.
*
* @return long number of CQs created.
*/
public long numCqsCreated();
/**
* Get the total number of closed CQs. This is a cumulative number.
*
* @return long number of CQs closed.
*/
public long numCqsClosed();
/**
* Get the number of stopped CQs currently.
*
* @return number of CQs stopped.
*/
public long numCqsStopped();
/**
* Get number of CQs that are currently active or stopped. The CQs included in this number are
* either running or stopped (suspended). Closed CQs are not included.
*
* @return long number of CQs on client.
*/
public long numCqsOnClient();
/**
* Get number of CQs on the given region. Active CQs and stopped CQs on this region are included
* and closed CQs are not included.
*
* @param regionFullPath
* @return long number of CQs on the region.
*/
public long numCqsOnRegion(String regionFullPath);
}