/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */

/*

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License version 2 as

 * published by the Free Software Foundation;

 *

 * This program 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 this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 *

 * Author: George Riley <riley@ece.gatech.edu>

 */

// Provides an interface to aggregate to MPI-compatible NetDevices 

#ifndef NS3_MPI_RECEIVER_H

#define NS3_MPI_RECEIVER_H

#include "ns3/object.h"

#include "ns3/packet.h"

namespace ns3 {

/**

 * Class to aggregate to a NetDevice if it supports MPI capability

 * 

 * MpiInterface::ReceiveMessages () needs to send packets to a NetDevice

 * Receive() method.  Since each NetDevice's Receive() method is specific

 * to the derived class, and since we do not know whether such a NetDevice

 * is MPI-capable, we aggregate one of these objects to each MPI-capable

 * device.  In addition, we must hook up a NetDevice::Receive() method

 * to the callback.  So the two steps to enable MPI capability are to

 * aggregate this object to a NetDevice, and to set the callback.

 */

class MpiReceiver : public Object

{

public:

  static TypeId GetTypeId (void);

  virtual ~MpiReceiver ();

  /**

   * \brief Direct an incoming packet to the device Receive() method

   * \param p Packet to receive

   */

  void Receive (Ptr<Packet> p);

  /**

   * \brief Set the receive callback to get packets to net devices

   * \param callback the callback itself

   */

  void SetReceiveCallback (Callback<void, Ptr<Packet> > callback);

private:

  Callback<void, Ptr<Packet> > m_rxCallback;

};

} // namespace ns3

#endif /* NS3_MPI_RECEIVER_H */