geode-cq/src/main/java/org/apache/geode/cache/query/cq/internal/ops/StopCQOp.java

/*
 * 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.cq.internal.ops;

import org.apache.geode.cache.client.internal.AbstractOp;
import org.apache.geode.cache.client.internal.ConnectionStats;
import org.apache.geode.cache.client.internal.ExecutablePool;
import org.apache.geode.cache.query.cq.internal.ops.CreateCQOp.CreateCQOpImpl;
import org.apache.geode.internal.cache.tier.MessageType;

/**
 * Does a region query on a server
 *
 * @since GemFire 5.7
 */
public class StopCQOp {
  /**
   * Stop a continuous query on the server using connections from the given pool to communicate with
   * the server.
   *
   * @param pool the pool to use to communicate with the server.
   * @param cqName name of the CQ to stop
   */
  public static void execute(ExecutablePool pool, String cqName) {
    AbstractOp op = new StopCQOpImpl(cqName);
    pool.executeOnQueuesAndReturnPrimaryResult(op);
  }

  private StopCQOp() {
    // no instances allowed
  }

  private static class StopCQOpImpl extends CreateCQOpImpl {
    /**
     * @throws org.apache.geode.SerializationException if serialization fails
     */
    public StopCQOpImpl(String cqName) {
      super(MessageType.STOPCQ_MSG_TYPE, 1);
      getMessage().addStringPart(cqName);
    }

    @Override
    protected String getOpName() {
      return "stopCQ";
    }

    @Override
    protected long startAttempt(ConnectionStats stats) {
      return stats.startStopCQ();
    }

    @Override
    protected void endSendAttempt(ConnectionStats stats, long start) {
      stats.endStopCQSend(start, hasFailed());
    }

    @Override
    protected void endAttempt(ConnectionStats stats, long start) {
      stats.endStopCQ(start, hasTimedOut(), hasFailed());
    }
  }
}