/* -*- 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: Hossam Khader <hossamkhader@gmail.com>

 */

#include "ns3/core-module.h"

#include "ns3/node-container.h"

#include "ns3/mobility-helper.h"

#include "ns3/mobility-model.h"

#include "ns3/basic-energy-source-helper.h"

#include "ns3/energy-source-container.h"

#include "ns3/uan-helper.h"

#include "ns3/uan-channel.h"

#include "ns3/acoustic-modem-energy-model-helper.h"

#include "ns3/uan-raw-application-helper.h"

#include "ns3/uan-raw-application.h"

using namespace ns3;

/**

 *

 * This example shows the usage of UanRawApplication to transfer data.

 * Two nodes are sending their remaining energy percentage (1 byte)

 * to a gateway node, that prints the received data.

 * The transmissions are scheduled at random times to avoid collisions

 *

 */

NS_LOG_COMPONENT_DEFINE ("UanRawApplicationExample");

void SetupPositions ();

void SetupEnergy ();

void SetupCommunications ();

void PrintReceivedPacket (Address src, Buffer data);

void SetupApplications ();

void SendPacket ();

void Run ();

NodeContainer nodeContainer;

void

SetupPositions ()

{

  MobilityHelper mobilityHelper;

  mobilityHelper.SetMobilityModel ("ns3::ConstantPositionMobilityModel");

  mobilityHelper.Install (nodeContainer);

  nodeContainer.Get (0)->GetObject<MobilityModel> ()->SetPosition (Vector (0, 0, 0));

  nodeContainer.Get (1)->GetObject<MobilityModel> ()->SetPosition (Vector (100, 0, 0));

  nodeContainer.Get (2)->GetObject<MobilityModel> ()->SetPosition (Vector (-100, 0, 0));

}

void

SetupEnergy ()

{

  BasicEnergySourceHelper energySourceHelper;

  energySourceHelper.Set ("BasicEnergySourceInitialEnergyJ", DoubleValue (900000));

  energySourceHelper.Install (nodeContainer);

}

void

SetupCommunications ()

{

  Ptr<UanChannel> channel = CreateObject<UanChannel> ();

  UanHelper uanHelper;

  NetDeviceContainer netDeviceContainer = uanHelper.Install (nodeContainer, channel);

  EnergySourceContainer energySourceContainer;

  NodeContainer::Iterator node = nodeContainer.Begin ();

  while (node != nodeContainer.End ())

    {

      energySourceContainer.Add ((*node)->GetObject<EnergySourceContainer> ()->Get (0));

      node++;

    }

  AcousticModemEnergyModelHelper acousticModemEnergyModelHelper;

  acousticModemEnergyModelHelper.Install (netDeviceContainer, energySourceContainer);

}

void

PrintReceivedPacket (Address src, Buffer data)

{

  std::cout << "Time:" << Simulator::Now ().GetHours () << "|"

            << "Node:" << (int)(UanAddress::ConvertFrom (src).GetAsInt ())

            << "|Energy:" << (int)(data.Begin ().ReadU8 ()) << "%" << std::endl;

}

void

SetupApplications ()

{

  UanRawApplicationHelper uanRawApplicationHelper;

  ApplicationContainer applicationContainer;

  applicationContainer = uanRawApplicationHelper.Install (nodeContainer);

  applicationContainer.Start (Seconds (0));

  NodeContainer::Iterator node = nodeContainer.Begin ();

  while (node != nodeContainer.End ())

    {

      Ptr<UanRawApplication> uanRawApplication = (*node)->GetApplication (0)->GetObject<UanRawApplication> ();

      uanRawApplication->SetPacketReceivedCallback (MakeCallback<void, Address, Buffer>(&PrintReceivedPacket));

      node++;

    }

}

void

SendPacket ()

{

  Ptr<UniformRandomVariable> uniformRandomVariable = CreateObject<UniformRandomVariable> ();

  NodeContainer::Iterator node = nodeContainer.Begin ();

  node++;

  while (node != nodeContainer.End ())

    {

      uint8_t energy = ((*node)->GetObject<EnergySourceContainer> ()->Get (0)->GetEnergyFraction ()) * 100;

      Ptr<UanRawApplication> uanRawApplication = (*node)->GetApplication (0)->GetObject<UanRawApplication> ();

      Buffer dataBuffer;

      dataBuffer.AddAtEnd (sizeof (uint8_t));

      Buffer::Iterator i = dataBuffer.Begin ();

      double time = uniformRandomVariable->GetValue (0, 15);

      i.WriteU8 (energy);

      Simulator::Schedule (Seconds (time), &UanRawApplication::Send, uanRawApplication, UanAddress (0), dataBuffer);

      node++;

    }

  Simulator::Schedule (Minutes (5), &SendPacket);

}

void

Run ()

{

  Packet::EnablePrinting ();

  nodeContainer.Create (3);

  SetupPositions ();

  SetupEnergy ();

  SetupCommunications ();

  SetupApplications ();

  SendPacket ();

}

int

main (int argc, char *argv[])

{

  CommandLine cmd;

  cmd.Parse (argc, argv);

  Run ();

  Simulator::Stop (Days (20));

  Simulator::Run ();

  Simulator::Destroy ();

  return 0;

}

    obj = bld.create_ns3_program('uan-raw-application-example', ['internet', 'uan', 'mobility', 'energy'])

    obj.source = 'uan-raw-application-example.cc'

/* -*- 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: Hossam Khader <hossamkhader@gmail.com>

 */

#include "uan-raw-application-helper.h"

#include "ns3/names.h"

#include "ns3/packet-socket-factory.h"

#include "ns3/packet-socket-helper.h"

#include "ns3/net-device.h"

#include "ns3/address.h"

namespace ns3 {

UanRawApplicationHelper::UanRawApplicationHelper ()

{

  m_factory.SetTypeId ("ns3::UanRawApplication");

}

void 

UanRawApplicationHelper::SetAttribute (std::string name, const AttributeValue &value)

{

  m_factory.Set (name, value);

}

ApplicationContainer

UanRawApplicationHelper::Install (Ptr<Node> node) const

{

  return ApplicationContainer (DoInstall (node));

}

ApplicationContainer

UanRawApplicationHelper::Install (std::string nodeName) const

{

  Ptr<Node> node = Names::Find<Node> (nodeName);

  return ApplicationContainer (DoInstall (node));

}

ApplicationContainer

UanRawApplicationHelper::Install (NodeContainer c) const

{

  ApplicationContainer apps;

  for (NodeContainer::Iterator i = c.Begin (); i != c.End (); ++i)

    {

      apps.Add (DoInstall (*i));

    }

  return apps;

}

Ptr<Application>

UanRawApplicationHelper::DoInstall (Ptr<Node> node) const

{

  if(node->GetObject<PacketSocketFactory> () == NULL)

    {

      PacketSocketHelper packetSocketHelper;

      packetSocketHelper.Install (node);

    }

  Ptr<Application> app = m_factory.Create<Application> ();

  node->AddApplication (app);

  return app;

}

} // namespace ns3

/* -*- 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: Hossam Khader <hossamkhader@gmail.com>

 */

#ifndef UAN_RAW_APPLICATION_HELPER_H

#define UAN_RAW_APPLICATION_HELPER_H

#include "ns3/object-factory.h"

#include "ns3/attribute.h"

#include "ns3/node-container.h"

#include "ns3/application-container.h"

namespace ns3 {

/**

 * \ingroup uan

 * \brief A helper to make it easier to instantiate an ns3::UanRawApplication 

 * on a set of nodes.

 */

class UanRawApplicationHelper

{

public:

  /**

   * Create an UanRawApplicationHelper to make it easier to work with UanRawApplication

   */

  UanRawApplicationHelper ();

  /**

   * Helper function used to set the underlying application attributes.

   */

  void SetAttribute (std::string name, const AttributeValue &value);

  /**

   * Install an ns3::UanRawApplication on each node of the input container

   * configured with all the attributes set with SetAttribute.

   *

   * \param c NodeContainer of the set of nodes on which an UanRawApplication 

   * will be installed.

   * \returns Container of Ptr to the applications installed.

   */

  ApplicationContainer Install (NodeContainer c) const;

  /**

   * Install an ns3::UanRawApplication on the node configured with all the 

   * attributes set with SetAttribute.

   *

   * \param node The node on which an UanRawApplication will be installed.

   * \returns Container of Ptr to the applications installed.

   */

  ApplicationContainer Install (Ptr<Node> node) const;

  /**

   * Install an ns3::UanRawApplication on the node configured with all the 

   * attributes set with SetAttribute.

   *

   * \param nodeName The node on which an UanRawApplication will be installed.

   * \returns Container of Ptr to the applications installed.

   */

  ApplicationContainer Install (std::string nodeName) const;

private:

  /**

   * Install an ns3::UanRawApplication on the node configured with all the 

   * attributes set with SetAttribute.

   *

   * \param node The node on which an UanRawApplication will be installed.

   * \returns Ptr to the application installed.

   */

  Ptr<Application> DoInstall (Ptr<Node> node) const;

  ObjectFactory m_factory; //!< Object factory.

};

} // namespace ns3

#endif /* UAN_RAW_APPLICATION_HELPER_H */

/* -*- 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: Hossam Khader <hossamkhader@gmail.com>

 */

#include "uan-raw-application.h"

#include "ns3/log.h"

#include "ns3/socket-factory.h"

#include "ns3/packet-socket-address.h"

#include "ns3/packet-socket.h"

namespace ns3 {

NS_LOG_COMPONENT_DEFINE ("UanRawApplication");

NS_OBJECT_ENSURE_REGISTERED (UanRawApplication);

TypeId 

UanRawApplication::GetTypeId (void)

{

  static TypeId tid = TypeId ("ns3::UanRawApplication")

    .SetParent<Application> ()

    .SetGroupName ("Applications")

    .AddConstructor<UanRawApplication> ()

  ;

  return tid;

}

UanRawApplication::UanRawApplication ()

{

  NS_LOG_FUNCTION (this);

  m_socket = NULL;

  m_packetReceivedCallback.Nullify ();

}

UanRawApplication::~UanRawApplication ()

{

  NS_LOG_FUNCTION (this);

}

void

UanRawApplication::DoDispose (void)

{

  NS_LOG_FUNCTION (this);

  m_socket = NULL;

  m_packetReceivedCallback.Nullify ();

  Application::DoDispose ();

}

uint32_t

UanRawApplication::GetApplicationId (void) const

{

  NS_LOG_FUNCTION (this);

  Ptr<Node> node = GetNode ();

  for (uint32_t i = 0; i < node->GetNApplications (); ++i)

    {

      if (node->GetApplication (i) == this)

        {

          return i;

        }

    }

  NS_ASSERT_MSG (false, "forgot to add application to node");

  return 0;

}

void 

UanRawApplication::Send (Address dst, const Buffer dataBuffer)

{

  NS_LOG_FUNCTION (this);

  const uint8_t * data = dataBuffer.PeekData ();

  if(UanAddress::ConvertFrom (dst).GetAsInt () != 

     UanAddress::ConvertFrom (GetNode ()->GetDevice (0)->GetAddress ()).GetAsInt ())

    { 

      PacketSocketAddress socketAddress;

      socketAddress.SetSingleDevice (GetNode ()->GetDevice (0)->GetIfIndex ());

      socketAddress.SetPhysicalAddress (dst);

      socketAddress.SetProtocol (0);

      Ptr<Packet> packet = Create<Packet> (data, dataBuffer.GetSize ());

      if(m_socket == NULL)

        {

          StartApplication ();

        }

      m_socket->SendTo (packet, 0, socketAddress);

    }

}

void

UanRawApplication::Receive (Ptr<Socket> socket)

{

  NS_LOG_FUNCTION (this << socket);

  NS_ASSERT (m_socket != NULL);

  while (m_socket->GetRxAvailable () > 0)

    {

      Ptr<Packet> packet = m_socket->Recv ();

      uint8_t *buffer = new uint8_t[packet->GetSize ()];

      packet->CopyData (buffer, packet->GetSize ());

      Address srcAddress;

      PacketTagIterator i = packet->GetPacketTagIterator ();

      while (i.HasNext ())

        {

          PacketTagIterator::Item item = i.Next ();

          if (item.GetTypeId () == TypeId::LookupByName ("ns3::SocketAddressTag"))

            {

              SocketAddressTag tag;

              item.GetTag (tag);

              Address address = tag.GetAddress ();

              uint8_t *addressBuffer = new uint8_t[address.GetLength ()];

              address.CopyTo (addressBuffer);

              srcAddress = UanAddress (addressBuffer[address.GetLength () -1]);

              delete [] addressBuffer;

            }

        }

      if(!m_packetReceivedCallback.IsNull ())

        {

          Buffer dataBuffer;

          dataBuffer.AddAtEnd ( packet->GetSize ());

          Buffer::Iterator iterator = dataBuffer.Begin ();

          iterator.Write (buffer, packet->GetSize ());

          m_packetReceivedCallback (srcAddress, dataBuffer);

        }

      delete[] buffer;

    }

} 

void 

UanRawApplication::StartApplication (void)

{

  NS_LOG_FUNCTION (this);

  PacketSocketAddress socketAddress;

  socketAddress.SetSingleDevice (GetNode ()->GetDevice (0)->GetIfIndex ());

  socketAddress.SetPhysicalAddress (UanAddress (UanAddress::GetBroadcast ()));

  socketAddress.SetProtocol (0);

  if (!m_socket)

    {

      m_socket = Socket::CreateSocket (GetNode (), TypeId::LookupByName ("ns3::PacketSocketFactory"));

    }

  m_socket->Bind ();

  m_socket->Connect (socketAddress);

  m_socket->SetRecvCallback (MakeCallback (&UanRawApplication::Receive, this));

}

void 

UanRawApplication::StopApplication (void)

{

  NS_LOG_FUNCTION (this);

  if(m_socket != NULL)

    {

      m_socket->Close ();

    }

  else

    {

      NS_LOG_WARN ("UanRawApplication found null socket to close in StopApplication");

    }

}

void

UanRawApplication::SetPacketReceivedCallback (PacketReceivedCallback callback)

{

  NS_LOG_FUNCTION (this);

  if (callback.IsNull ())

    {

      NS_LOG_DEBUG ("UanRawApplication:Setting NULL packet received callback!");

    }

  m_packetReceivedCallback = callback;

}

} // namespace ns3

/* -*- 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: Hossam Khader <hossamkhader@gmail.com>

 */

#ifndef UAN_RAW_APPLICATION_H

#define UAN_RAW_APPLICATION_H

#include "ns3/application.h"

#include "ns3/packet.h"

#include "ns3/uan-address.h"

#include "ns3/socket.h"

namespace ns3 {

/**

 * \ingroup uan

 * \brief a simple Raw application to be used in UAN networks

 * 

 * The Application combines both the client-side and the server-side 

 * functionality, and provides an easy to use bidirectional communications 

 * between the UAN nodes. It runs directly on top of the UAN data link layer, so

 * raw data is sent in the payload of the UAN frame.

 * 

 * The user interacts with the application mainly through two functions:

 * Send () : Used to send the data in the buffer parameter to the

 * destination UAN address.

 * SetPacketReceivedCallback (): Used to set a receive callback where the raw 

 * packet payload, and the source UAN address will be passed as

 * parameters.

 */

class UanRawApplication : public Application

{

public:

  typedef Callback<void, Address, Buffer> PacketReceivedCallback;

  /**

   * \brief Get the type ID.

   * \return the object TypeId

   */

  static TypeId GetTypeId (void);

  /**

   * create a uan application

   */

  UanRawApplication ();

  virtual ~UanRawApplication ();

  /**

   * \brief Send a packet to the destination

   * \param dst the destination UAN address

   * \param dataBuffer the data to be sent

   */

  void Send (Address dst, const Buffer dataBuffer);

  /**

   * \brief Set a callback when a packet is received

   * \param callback the packet received callback

   */

  void SetPacketReceivedCallback (PacketReceivedCallback callback);

private:

  // inherited from Application base class.

  virtual void StartApplication (void);

  virtual void StopApplication (void);

  virtual void DoDispose (void);

  /**

   * \brief Return the application ID in the node.

   * \returns the application id

   */

  uint32_t GetApplicationId (void) const;

  /**

   * \brief Receive a packet

   * \param socket the receiving socket

   *

   * This function is called by lower layers through a callback.

   */

  void Receive (Ptr<Socket> socket);

  Ptr<Socket> m_socket; //!< Associated socket

  PacketReceivedCallback m_packetReceivedCallback;

};

} // namespace ns3

#endif /* UAN_RAW_APPLICATION_H */

        'model/uan-raw-application.cc',

        'helper/uan-raw-application-helper.cc',

        'model/uan-mac-rc-gw.h',

        'model/uan-raw-application.h',