Scale Stack 0.3 Developer Documentation

scalestack/network/stream.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_NETWORK_STREAM_H
#define SCALESTACK_NETWORK_STREAM_H

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

#include <scalestack/event/handler.h>
#include <scalestack/kernel/macros.h>

struct addrinfo;

namespace scalestack
{
namespace network
{

class stream_provider;
class stream_service;

class stream
{
public:

  stream(kernel::module& module);

  virtual ~stream();

  virtual void shutdown(void);

  void stop(void);

  void set_timer(uint64_t milliseconds);

  virtual void timer_expired(void);

  void run_now(void);

  virtual void run(void);

  virtual void connected(void);

  void reconnect(void);

  virtual size_t read(uint8_t* buffer, size_t size) = 0;

  void consume(size_t size);

  virtual void read_eof(void);
  
  size_t write(uint8_t* buffer, size_t size, bool flush = false);

  virtual void flush_write(void) = 0;

  void shutdown_write(void);

protected:

  kernel::module& _module;

private:

  stream(const stream&);

  stream& operator=(const stream&);

  stream_provider* _stream_provider;

  friend class stream_provider;
};

class SCALESTACK_API stream_provider: public event::handler
{
public:

  stream_provider(event::handler_service& handler_service,
                  stream_service& stream_service,
                  int file_descriptor);

  stream_provider(event::handler_service& handler_service,
                  stream_service& stream_service,
                  const struct addrinfo* addresses);

  virtual ~stream_provider();

  void started();

  void shutdown(void);

  void timer_expired(void);

  void run(void);

  virtual void set_file_descriptor(int file_descriptor);

  void reconnect(void);

  void consume(size_t size);

  size_t write(uint8_t* buffer, size_t size, bool flush = false);

  void shutdown_write(void);

protected:

  const struct addrinfo* _addresses;
  const struct addrinfo* _address;

private:

  SCALESTACK_LOCAL
  stream_provider(const stream_provider&);

  SCALESTACK_LOCAL
  stream_provider& operator=(const stream_provider&);

  void read_ready(int file_descriptor);

  void write_ready(int file_descriptor);

  SCALESTACK_LOCAL
  void _connect(void);

  SCALESTACK_LOCAL
  void _consume(size_t size);

  SCALESTACK_LOCAL
  void _flush(void);

  SCALESTACK_LOCAL
  size_t _write(uint8_t* buffer, size_t size);

  //static const size_t _read_buffer_max_size = 32768;
  //static const size_t _write_buffer_max_size = 32768;
  static const size_t _read_buffer_max_size = 8192;
  static const size_t _write_buffer_max_size = 8192;

  bool _connecting;
  bool _waiting_for_consume;
  bool _call_flush_write;
  bool _shutdown_write;
  bool _connection_dead;
  int _file_descriptor;
  size_t _read_buffer_offset;
  size_t _read_buffer_size;
  size_t _write_buffer_offset;
  size_t _write_buffer_size;
  std::auto_ptr<stream> _stream;
  stream_service& _stream_service;
  uint8_t _read_buffer[_read_buffer_max_size];
  uint8_t _write_buffer[_write_buffer_max_size];
};

/*
 * Public stream methods.
 */

inline stream::stream(kernel::module& module):
  _module(module),
  _stream_provider()
{
}

inline stream::~stream()
{
}

inline void stream::shutdown(void)
{
  _stream_provider->stop();
}

inline void stream::stop(void)
{
  _stream_provider->stop();
}

inline void stream::set_timer(uint64_t milliseconds)
{
  _stream_provider->set_timer(milliseconds);
}

inline void stream::timer_expired(void)
{
}

inline void stream::run_now(void)
{
  _stream_provider->run_now();
}

inline void stream::run(void)
{
}

inline void stream::connected(void)
{
}

inline void stream::reconnect(void)
{
  _stream_provider->reconnect();
}

inline void stream::consume(size_t size)
{
  _stream_provider->consume(size);
}

inline void stream::read_eof(void)
{
  shutdown();
}

inline size_t stream::write(uint8_t* buffer, size_t size, bool flush)
{
  return _stream_provider->write(buffer, size, flush);
}

inline void stream::shutdown_write(void)
{
  _stream_provider->shutdown_write();
}

/*
 * Public stream_provider methods.
 */

inline void stream_provider::shutdown(void)
{
  _stream->shutdown();
}

inline void stream_provider::timer_expired(void)
{
  _stream->timer_expired();
}

} /* namespace network */
} /* namespace scalestack */

#endif /* SCALESTACK_NETWORK_STREAM_H */

---