/* Network-Integrated Multimedia Middleware (NMM)
 * http://www.motama.com/nmm.html
 *
 * Copyright (C) 2006-2007
 * Motama GmbH, Saarbruecken, Germany
 * http://www.motama.com
 *
 * This file is part of NMM. 
 * 
 * NMM 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; only version 2 of the License.      
 * 
 * NMM 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 NMM; if not, write to the Free Software Foundation,    
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 */

#ifndef NMM_IBuffersPassedEventReceiverImpl_HPP
#define NMM_IBuffersPassedEventReceiverImpl_HPP

#include "nmm/nmm_prefix.hpp"

#include "nmm/comm/NMMObject.hpp"
#include "IBuffersPassedEventReceiver.hpp"


#include "visibility.hpp"

namespace NMM
{
  /**
   * Interface impemented by objects that receive events containing the number of buffers passed.
   * These events are sent upstream from a node which implements IBuffersPassedEventSender.
   */

  class DLLEXPORT IBuffersPassedEventReceiverImpl  : public virtual NMM::NMMObject { 
  public:
    IBuffersPassedEventReceiverImpl() { addInterface(new IBuffersPassedEventReceiver(*this)); registerEvents(); };

    virtual ~IBuffersPassedEventReceiverImpl() {};

  protected:
    /** Receives number of buffers processed recently.
     * 
     * This is an upstream event. The value is the number of buffers processed since the last event.
     *
     * @param buffers Number of buffers processed recently.
     */

    virtual Result buffersPassed(const nmm_int32& buffers) /* in-stream */  = 0;
    /** Returns number of buffers processed below.
     * 
     * Returns the number of buffers processed below in the graph, according to the upstream events
     * we received.
     *
     * @return Number of buffers processed below.
     */

    virtual nmm_int32 getUpstreamBuffersPassed() const = 0;
    /** Resets number of buffers processed below.
     */

    virtual void resetUpstreamBufferCounter() = 0;


  private:
    void registerEvents();
  };

}

#include "nmm/nmm_suffix.hpp"

#endif
