apps/ndn-app.cc

/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2011 University of California, Los Angeles
 *
 * 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: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
 */

#include "ndn-app.h"
#include "ns3/log.h"
#include "ns3/assert.h"
#include "ns3/packet.h"

#include "ns3/ndn-interest.h"
#include "ns3/ndn-content-object.h"
#include "ns3/ndn-l3-protocol.h"
#include "ns3/ndn-fib.h"
#include "ns3/ndn-app-face.h"
#include "ns3/ndn-forwarding-strategy.h"

NS_LOG_COMPONENT_DEFINE ("ndn.App");

namespace ns3 {
namespace ndn {
    
NS_OBJECT_ENSURE_REGISTERED (App);
    
TypeId
App::GetTypeId (void)
{
  static TypeId tid = TypeId ("ns3::ndn::App")
    .SetGroupName ("Ndn")
    .SetParent<Application> ()
    .AddConstructor<App> ()

    .AddTraceSource ("ReceivedInterests", "ReceivedInterests",
                    MakeTraceSourceAccessor (&App::m_receivedInterests))
    
    .AddTraceSource ("ReceivedNacks", "ReceivedNacks",
                    MakeTraceSourceAccessor (&App::m_receivedNacks))
    
    .AddTraceSource ("ReceivedContentObjects", "ReceivedContentObjects",
                    MakeTraceSourceAccessor (&App::m_receivedContentObjects))

    .AddTraceSource ("TransmittedInterests", "TransmittedInterests",
                    MakeTraceSourceAccessor (&App::m_transmittedInterests))

    .AddTraceSource ("TransmittedContentObjects", "TransmittedContentObjects",
                    MakeTraceSourceAccessor (&App::m_transmittedContentObjects))
    ;
  return tid;
}
    
App::App ()
  : m_protocolHandler (0)
  , m_active (false)
  , m_face (0)
{
}
    
App::~App ()
{
}

void
App::DoDispose (void)
{
  NS_LOG_FUNCTION_NOARGS ();

  // Unfortunately, this causes SEGFAULT
  // The best reason I see is that apps are freed after ndn stack is removed
  // StopApplication ();  
  Application::DoDispose ();
}

void
App::RegisterProtocolHandler (ProtocolHandler handler)
{
  m_protocolHandler = handler;
}

uint32_t
App::GetId () const
{
  if (m_face == 0)
    return (uint32_t)-1;
  else
    return m_face->GetId ();
}

void
App::OnInterest (const Ptr<const InterestHeader> &interest, Ptr<Packet> packet)
{
  NS_LOG_FUNCTION (this << interest);
  m_receivedInterests (interest, this, m_face);
}

void
App::OnNack (const Ptr<const InterestHeader> &interest, Ptr<Packet> packet)
{
  NS_LOG_FUNCTION (this << interest);
  m_receivedNacks (interest, this, m_face);
}

void
App::OnContentObject (const Ptr<const ContentObjectHeader> &contentObject,
                          Ptr<Packet> payload)
{
  NS_LOG_FUNCTION (this << contentObject << payload);
  m_receivedContentObjects (contentObject, payload, this, m_face);
}

// Application Methods
void 
App::StartApplication () // Called at time specified by Start
{
  NS_LOG_FUNCTION_NOARGS ();
  
  NS_ASSERT (m_active != true);
  m_active = true;

  NS_ASSERT_MSG (GetNode ()->GetObject<L3Protocol> () != 0,
                 "Ndn stack should be installed on the node " << GetNode ());

  // step 1. Create a face
  m_face = CreateObject<AppFace> (/*Ptr<App> (this)*/this);
    
  // step 2. Add face to the Ndn stack
  GetNode ()->GetObject<L3Protocol> ()->AddFace (m_face);

  // step 3. Enable face
  m_face->SetUp (true);
}
    
void 
App::StopApplication () // Called at time specified by Stop
{
  NS_LOG_FUNCTION_NOARGS ();

  if (!m_active) return; //don't assert here, just return
 
  NS_ASSERT (GetNode ()->GetObject<L3Protocol> () != 0);

  m_active = false;

  // step 1. Disable face
  m_face->SetUp (false);

  // step 2. Remove face from Ndn stack
  GetNode ()->GetObject<L3Protocol> ()->RemoveFace (m_face);

  // step 3. Destroy face
  if (m_face->GetReferenceCount () != 1)
    {
      NS_LOG_ERROR ("Please a bug report on https://github.com/NDN-Routing/ndnSIM/issues:");
      NS_LOG_ERROR ("At this point, nobody else should have referenced this face, but we have "
                    << m_face->GetReferenceCount () << " references");

    }
  // NS_ASSERT_MSG (m_face->GetReferenceCount ()==2,
  //               "At this point, nobody else should have referenced this face, but we have "
  //               << m_face->GetReferenceCount () << " references");
  m_face = 0;
}

} // namespace ndn
} // namespace ns3