C:/knet/include/kNet/RingBuffer.h

Go to the documentation of this file.

/* Copyright 2010 Jukka Jylänki

   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. */
#pragma once

#include <vector>

namespace kNet
{

class RingBuffer
{
public:
   std::vector<char> data;
   int start; 
   int end; 

   explicit RingBuffer(int capacity)
   {
      data.resize(capacity);
      start = 0;
      end = 0;
   }

   int Size() const { return end - start; }

   void Compact()
   {
      // If already compacted, do nothing.
      if (start == 0)
         return;

      const int numBytes = Size();
      for(int i = 0; i < numBytes; ++i)
         data[i] = data[start+i];

      start = 0;
      end = numBytes;
   }

   void Clear()
   {
      start = end = 0;
   }

   char *Begin() { return &data[start]; }

   char *End() { return &data[end]; }

   int StartIndex() const { return start; }

   void Inserted(int numBytes)
   { 
      end += numBytes; 
      assert(end <= (int)data.size());
   }

   void Consumed(int numBytes)
   { 
      start += numBytes; 
      assert(start <= end); 
      if (start == end) // Free compact?
         start = end = 0;
   }

   int TotalFreeBytesLeft() const { return data.size() - Size(); }

   int ContiguousFreeBytesLeft() const { return data.size() - end; }
};

} // ~kNet