/** @file

  Public declaration of Processor class

  @section license License

  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 _I_Processor_h_
#define _I_Processor_h_

#include "libts.h"

#define PROCESSOR_RECONFIGURE            0x01
#define PROCESSOR_CHECK                  0x02
#define PROCESSOR_FIX                    0x04
#define PROCESSOR_IGNORE_ERRORS          0x08

class Processor;
class Thread;

/**
   Base class for all of the IO Core processors.

   The Processor class defines a common interface for all the
   processors in the IO Core. A processor is multithreaded subsystem
   specialized in some type of task or application. For example,
   the Event System module includes the EventProcessor which provides
   schedulling services, the Net module includes the NetProcessor
   which provides networking services, etc.

   You cannot create objects of the Processor class and its methods
   have no implementation. Therefore, you are expected to use objects
   of a derived type.

   Most of such derived classes, provide a singleton object and is
   common case to have a single instance in that application scope.

*/
class Processor
{
public:
  virtual ~Processor();

  /**
    Returns a Thread appropriate for the processor.

    Returns a new instance of a Thread or Thread derived class of
    a thread which is the thread class for the processor.

    @param thread_index reserved for future use.

  */
  virtual Thread *create_thread(int thread_index);

  /**
    Returns the number of threads required for this processor. If
    the number is not defined or not used, it is equal to 0.

  */
  virtual int get_thread_count();

  /**
    This function attemps to stop the processor. Please refer to
    the documentation on each processor to determine if it is
    supported.

  */
  virtual void shutdown()
  {
  }

  /**
    Starts execution of the processor.

    Attempts to start the number of threads specified for the
    processor, initializes their states and sets them running. On
    failure it returns a negative value.

    @param number_of_threads Positive value indicating the number
      of threads to spawn for the processor.

  */
  virtual int start(int number_of_threads)
  {
    (void) number_of_threads;
    return 0;
  }

protected:
  Processor();

private:
  // prevent unauthorized copies (Not implemented)
  Processor(const Processor &);
  Processor & operator =(const Processor &);
};

#endif //_I_Processor_h_
