BaseStreamBuffer.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2005, Vintela, Inc. All rights reserved.
* Copyright (C) 2006, Novell, Inc. All rights reserved.
* 
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 
*     * Redistributions of source code must retain the above copyright notice,
*       this list of conditions and the following disclaimer.
*     * Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in the
*       documentation and/or other materials provided with the distribution.
*     * Neither the name of 
*       Vintela, Inc., 
*       nor Novell, Inc., 
*       nor the names of its contributors or employees may be used to 
*       endorse or promote products derived from this software without 
*       specific prior written permission.
* 
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/


#ifndef BLOCXX_BASESTREAMBUFFER_HPP_INCLUDE_GUARD_
#define BLOCXX_BASESTREAMBUFFER_HPP_INCLUDE_GUARD_
#include "blocxx/BLOCXX_config.h"

#ifdef BLOCXX_HAVE_STREAMBUF
#include <streambuf>
#else
#include <streambuf.h>
#endif

// The classes and functions defined in this file are not meant for general
// use, they are internal implementation details.  They may change at any time.

namespace BLOCXX_NAMESPACE
{

const size_t BASE_BUF_SIZE = 256;
const size_t HTTP_BUF_SIZE = 4096;
class BLOCXX_COMMON_API BaseStreamBuffer : public std::streambuf
{
public:
   enum EDirectionFlag
   {
      E_IN,
      E_OUT,
      E_IN_OUT
   };
   BaseStreamBuffer(EDirectionFlag direction, size_t bufSize = BASE_BUF_SIZE);

   ~BaseStreamBuffer();
protected:
   // for input
   int underflow();
   //int pbackfail(int c);
   // for output
   std::streamsize xsputn(const char* s, std::streamsize n);
   virtual int overflow(int c);
   virtual int sync();
   virtual void initBuffers();
   virtual void initGetBuffer();
   virtual void initPutBuffer();
   // meant to be overwritten (at least one of them)
   virtual int buffer_to_device(const char* c, int n);
   
   virtual int buffer_from_device(char* c, int n);
private:
   std::streamsize m_bufSize;
   char* m_inputBuffer;
   char* m_outputBuffer;
   int buffer_in();
   int buffer_out();
   // prohibit copying and assigning
   // NO IMPLEMENTATION
   BaseStreamBuffer(const BaseStreamBuffer& arg);
   BaseStreamBuffer& operator=(const BaseStreamBuffer& arg);
};

} // end namespace BLOCXX_NAMESPACE

#endif