Consumer.h

// Copyright 2008 Michael Marsh, University of Maryland.
//
// This file is part of pydtn.
//
// pydtn is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// pydtn is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with pydtn.  If not, see <http://www.gnu.org/licenses/>.
//
// The views and conclusions contained in the software and documentation
// are those of the authors and should not be interpreted as representing
// official policies, either expressed or implied, of the University
// of Maryland.
//
// pydtn extends and embeds the Python interpreter, which is
// Copyright 2001-2006 Python Software Foundation, All Rights Reserved,
// and is released under the PSF License Agreement.
//
// RANLUX random number generation uses the Boost library,
// Copyright 1994-2006 by various authors (details in individual files),
// which is released under the Boost Software License, Version 1.0.

#ifndef __DTN_CONSUMER_H__
#define __DTN_CONSUMER_H__

#include "config.h"

#include "DropCause.h"

namespace DTN
{
   class Bundle;
   class Node;

   class Consumer
   {
      public :
         Consumer( Node* owner ) : m_owner(owner) {}
         virtual ~Consumer() {}

         virtual void setOwner( Node* owner ) {m_owner = owner;}

         virtual void operator()( const Bundle& b ) = 0;

         virtual void drop( const Bundle& b,
                            const DropCause& c=DropCause::inst ) {}

         virtual void custody( const Bundle& b ) {}

         virtual void persistentStore( const Bundle& b ) {}

         virtual void persistentRemove( const Bundle& b, bool cleanup=true ) {}

         virtual void send( const Bundle& b ) {}

         virtual void recv( const Bundle& b ) {}

         virtual void exhausted( const Bundle& b ) {}

      protected :
         Node*  m_owner;
   };
};

#endif /* __DTN_CONSUMER_H__ */

---