Packets/PacketImpl.cci

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief PacketImpl inline non-template implementation */
  25
  26 // Custom includes
  27 #include "../Utils/senfassert.hh"
  28 // #include "PacketInterpreter.hh"
  29
  30 #define prefix_ inline
  31 ///////////////////////////////cci.p///////////////////////////////////////
  32
  33 // Memory management:
  34 //
  35 // * The PacketImpl destructor will *explicitly* clean-up the interpreters_ list by removing
  36 //   each element from the list and deleting it if it's (intrusive) refcount is 0
  37 // * The PacketInterpreters use safe hooks -> they know wether they are part of a list or not
  38 // * PacketHandle has an intrusive_ptr to PacketInterpreterBase. The intrusive_ptr_add_ref
  39 //   will refcount both the PacketImpl as well as the PacketInterpreterBase
  40 // * intrusive_ptr_remove will only delete the object if it's not in a container
  41 // * removing an object from the list will decrement the PacketImpl refcount accordingly
  42 // * inserting an object into the list will incroment the PacketImpl refcount accordingly
  43 // * each PacketInterpreterBase instance holds a *raw* pointer to the PacketImpl
  44 //
  45 // The following operations change refcounts:
  46 //
  47 // * intrusive_ptr_add_ref(PacketInterpreterBase *);
  48 // * intrusive_ptr_remove(PacketInterpreterBase *);
  49 // * PacketImpl::appendInterpreter();
  50 // * PacketImpl::prependInterpreter();
  51 // * PacketImpl::truncateInterpreters();
  52 //
  53 // The last three also modify the impl_ member accordingly by calling
  54 // PacketInterpreterBase::assign/release
  55
  56 ///////////////////////////////////////////////////////////////////////////
  57 // senf::detail::PacketImpl
  58
  59 prefix_ senf::detail::PacketImpl::PacketImpl()
  60     : refcount_(0)
  61 {}
  62
  63 prefix_ senf::detail::PacketImpl::PacketImpl(size_type size, byte initValue)
  64     : refcount_(0), data_(size,initValue)
  65 {}
  66
  67 prefix_ senf::detail::PacketImpl::~PacketImpl()
  68 {
  69     // We increment refcount_ to ensure, release() won't call delete again
  70     ++refcount_;
  71     eraseInterpreters(interpreters_.begin(), interpreters_.end());
  72 }
  73
  74 // rerference/memory management
  75
  76 prefix_ void senf::detail::PacketImpl::add_ref(refcount_t n)
  77 {
  78     refcount_ += n;
  79 }
  80
  81 prefix_ senf::detail::PacketImpl::refcount_t senf::detail::PacketImpl::refcount()
  82     const
  83 {
  84     return refcount_;
  85 }
  86
  87 // Interpreter chain
  88
  89 prefix_ senf::PacketInterpreterBase * senf::detail::PacketImpl::first()
  90 {
  91     return interpreters_.empty() ? 0 : & interpreters_.front();
  92 }
  93
  94 prefix_ senf::PacketInterpreterBase * senf::detail::PacketImpl::last()
  95 {
  96     return interpreters_.empty() ? 0 : & interpreters_.back();
  97 }
  98
  99 prefix_ senf::PacketInterpreterBase * senf::detail::PacketImpl::next(PacketInterpreterBase * p)
 100 {
 101     interpreter_list::iterator i (interpreter_list::current(*p));
 102     return (++i == interpreters_.end()) ? 0 : &*i;
 103 }
 104
 105 prefix_ senf::PacketInterpreterBase * senf::detail::PacketImpl::prev(PacketInterpreterBase * p)
 106 {
 107     interpreter_list::iterator i (interpreter_list::current(*p));
 108     return (i == interpreters_.begin()) ? 0 : &*(--i);
 109 }
 110
 111 prefix_ void senf::detail::PacketImpl::truncateInterpreters(PacketInterpreterBase * p)
 112 {
 113     Guard guard (this);
 114     eraseInterpreters(interpreter_list::current(*p),interpreters_.end());
 115 }
 116
 117 prefix_ void senf::detail::PacketImpl::truncateInterpretersBackwards(PacketInterpreterBase * p)
 118 {
 119     Guard guard (this);
 120     eraseInterpreters(interpreters_.begin(),boost::next(interpreter_list::current(*p)));
 121 }
 122
 123 // Data container
 124
 125 prefix_ senf::detail::PacketImpl::iterator senf::detail::PacketImpl::begin()
 126 {
 127     return data_.begin();
 128 }
 129
 130 prefix_ senf::detail::PacketImpl::iterator senf::detail::PacketImpl::end()
 131 {
 132     return data_.end();
 133 }
 134
 135 prefix_ senf::detail::PacketImpl::size_type senf::detail::PacketImpl::size()
 136 {
 137     return data_.size();
 138 }
 139
 140 prefix_ void senf::detail::PacketImpl::insert(PacketData * self, iterator pos, byte v)
 141 {
 142     difference_type ix (std::distance(begin(),pos));
 143     data_.insert(pos,v);
 144     updateIterators(self,ix,1);
 145 }
 146
 147 prefix_ void senf::detail::PacketImpl::insert(PacketData * self, iterator pos, size_type n,
 148                                               byte v)
 149 {
 150     difference_type ix (std::distance(begin(),pos));
 151     data_.insert(pos,n,v);
 152     updateIterators(self,ix,n);
 153 }
 154
 155 prefix_ void senf::detail::PacketImpl::erase(PacketData * self, iterator pos)
 156 {
 157     difference_type ix (std::distance(begin(),pos));
 158     data_.erase(pos);
 159     updateIterators(self,ix,-1);
 160 }
 161
 162 prefix_ void senf::detail::PacketImpl::erase(PacketData * self, iterator first, iterator last)
 163 {
 164     difference_type ix (std::distance(begin(),first));
 165     difference_type delta (std::distance(first,last));
 166     data_.erase(first,last);
 167     updateIterators(self,ix,-delta);
 168 }
 169
 170 ///////////////////////////////////////////////////////////////////////////
 171 // senf::detail::PacketImpl::Guard
 172
 173 prefix_ senf::detail::PacketImpl::Guard::Guard(PacketImpl * impl)
 174     : p (impl)
 175 {
 176     p->add_ref();
 177 }
 178
 179 prefix_ senf::detail::PacketImpl::Guard::~Guard()
 180 {
 181     p->release();
 182 }
 183
 184 ///////////////////////////////cci.e///////////////////////////////////////
 185 #undef prefix_
 186
 187 \f
 188 // Local Variables:
 189 // mode: c++
 190 // fill-column: 100
 191 // c-file-style: "senf"
 192 // indent-tabs-mode: nil
 193 // ispell-local-dictionary: "american"
 194 // compile-command: "scons -u test"
 195 // comment-column: 40
 196 // End: