pagespeed/controller/schedule_rewrite_callback.h

/*
 * 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.
 */

#ifndef PAGESPEED_CONTROLLER_SCHEDULE_REWRITE_CALLBACK_H_
#define PAGESPEED_CONTROLLER_SCHEDULE_REWRITE_CALLBACK_H_

#include "pagespeed/controller/central_controller_callback.h"
#include "pagespeed/kernel/base/basictypes.h"
#include "pagespeed/kernel/base/scoped_ptr.h"
#include "pagespeed/kernel/base/string.h"
#include "pagespeed/kernel/thread/sequence.h"

// Callback classes to support rewrite scheduling in CentralController.

namespace net_instaweb {

// Passed to RunImpl for implementations of ScheduleRewriteCallback.
class ScheduleRewriteContext {
 public:
  virtual ~ScheduleRewriteContext();

  // Mark the rewrite operation as complete. MarkSucceeded will be
  // automatically invoked at destruction if neither is explicitly called.
  virtual void MarkSucceeded() = 0;
  virtual void MarkFailed() = 0;

 protected:
  ScheduleRewriteContext();

 private:
  DISALLOW_COPY_AND_ASSIGN(ScheduleRewriteContext);
};

// Implementor interface to rewrite scheduling features in CentralController.
class ScheduleRewriteCallback
    : public CentralControllerCallback<ScheduleRewriteContext> {
 public:
  explicit ScheduleRewriteCallback(const GoogleString& key, Sequence* sequence);
  ~ScheduleRewriteCallback() override;

  const GoogleString& key() { return key_; }

 private:
  // CentralControllerCallback interface.
  void RunImpl(std::unique_ptr<ScheduleRewriteContext>* context) override = 0;
  void CancelImpl() override = 0;

  GoogleString key_;

  DISALLOW_COPY_AND_ASSIGN(ScheduleRewriteCallback);
};

}  // namespace net_instaweb

#endif  // PAGESPEED_CONTROLLER_SCHEDULE_REWRITE_CALLBACK_H_