Scale Stack 0.3 Developer Documentation

scalestack/event/handler.h

Go to the documentation of this file.

/*
 * Scale Stack
 *
 * Copyright 2010 Eric Day
 *
 * Licensed 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 SCALESTACK_EVENT_HANDLER_H
#define SCALESTACK_EVENT_HANDLER_H

#include <memory>
#include <stdint.h>
#include <unistd.h>

#include <scalestack/event/handler_service.h>

namespace scalestack
{
namespace kernel
{
  class module;
} /* namespace kernel */

namespace event
{

class handler_provider;

class handler
{
public:

  handler(handler_service& handler_service);

  virtual ~handler();

  void start(void);

  virtual void started(void);

  virtual void shutdown(void);

  void stop(void);

  void set_timer(uint64_t milliseconds);

  virtual void timer_expired(void);

  void set_file_descriptor(int file_descriptor);

  virtual void close_file_descriptor(int file_descriptor);

  void watch_read(void);

  virtual void read_ready(int file_descriptor);

  void watch_write(void);

  virtual void write_ready(int file_descriptor);

  void run_now(void);

  virtual void run(void);

protected:

  kernel::module& _module;

private:

  handler(const handler&);

  handler& operator=(const handler&);

  void _start(void);

  void _stop(void);

  handler_service& _handler_service;
  std::auto_ptr<handler_provider> _handler_provider;

  friend class handler_provider;
  friend class handler_service;
};

class handler_provider
{
public:

  handler_provider(kernel::module& module, handler* handler);

  virtual ~handler_provider();

  virtual void start(void) = 0;

  virtual void stop(void) = 0;

  virtual void set_timer(uint64_t milliseconds) = 0;

  virtual void set_file_descriptor(int file_descriptor) = 0;

  virtual void watch_read(void) = 0;

  virtual void watch_write(void) = 0;

  virtual void run_now(void) = 0;

protected:

  void _stop(void);

  kernel::module& _module;
  handler* _handler;

private:

  handler_provider(const handler_provider&);

  handler_provider& operator=(const handler_provider&);
};

/*
 * Public handler methods.
 */

inline handler::handler(handler_service& handler_service):
  _module(handler_service.get_module()),
  _handler_service(handler_service),
  _handler_provider(handler_service._add_handler(this))
{
}

inline handler::~handler()
{
}

inline void handler::start(void)
{
  _handler_service._start_handler(this);
}

inline void handler::started(void)
{
}

inline void handler::shutdown(void)
{
  stop();
}

inline void handler::stop(void)
{
  _handler_provider->stop();
}

inline void handler::set_timer(uint64_t milliseconds)
{
  _handler_provider->set_timer(milliseconds);
}

inline void handler::timer_expired(void)
{
}

inline void handler::set_file_descriptor(int file_descriptor)
{
  _handler_provider->set_file_descriptor(file_descriptor);
}

inline void handler::close_file_descriptor(int file_descriptor)
{
  close(file_descriptor);
}

inline void handler::watch_read(void)
{
  _handler_provider->watch_read();
}

inline void handler::read_ready(int)
{
}

inline void handler::watch_write(void)
{
  _handler_provider->watch_write();
}

inline void handler::write_ready(int)
{
}

inline void handler::run_now(void)
{
  _handler_provider->run_now();
}

inline void handler::run(void)
{
}

/*
 * Private handler methods.
 */

inline void handler::_start(void)
{
  _handler_provider->start();
}

inline void handler::_stop(void)
{
  _handler_service._stop_handler(this);
}

/*
 * Public handler_provider methods.
 */

inline handler_provider::handler_provider(kernel::module& module,
                                          handler* handler):
  _module(module),
  _handler(handler)
{
}

inline handler_provider::~handler_provider()
{
}

/*
 * Protected handler_provider methods.
 */

inline void handler_provider::_stop(void)
{
  _handler->_stop();
}

} /* namespace event */
} /* namespace scalestack */

#endif /* SCALESTACK_EVENT_HANDLER_H */

---