blob: cac155878dde89005f6f4cf81ac81a9ebe4aa894 [file] [log] [blame]
* 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
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
#include <activemq/util/Config.h>
#include <activemq/threads/Task.h>
namespace activemq {
namespace threads {
class AMQCPP_API TaskRunner {
virtual ~TaskRunner();
* Starts the task runner. Prior to call this method tasks can be added to a
* Runner, but no executions will occur. The start method will create the
* background Thread(s) which do the work for this task runner.
virtual void start() = 0;
* @return true if the start method has been called.
virtual bool isStarted() const = 0;
* Shutdown after a timeout, does not guarantee that the task's iterate
* method has completed and the thread halted.
* @param timeout - Time in Milliseconds to wait for the task to stop.
virtual void shutdown(long long timeout) = 0;
* Shutdown once the task has finished and the TaskRunner's thread has exited.
virtual void shutdown() = 0;
* Signal the TaskRunner to wakeup and execute another iteration cycle on
* the task, the Task instance will be run until its iterate method has
* returned false indicating it is done.
virtual void wakeup() = 0;