src/core/trace-resolver.h
author Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Fri, 10 Aug 2007 15:53:43 +0200
changeset 1334 e8e07f44359f
parent 1330 src/common/trace-resolver.h@d67fce6d56f8
child 1363 849b30d0ea86
permissions -rw-r--r--
move trace code to core module

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2007 INRIA
 * All rights reserved.
 *
 * 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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */
#ifndef TRACE_RESOLVER_H
#define TRACE_RESOLVER_H

#include <string>
#include <list>
#include "trace-context.h"

namespace ns3 {

class CallbackBase;

/**
 * \brief the base class which is used to incremental perform trace
 *        namespace resolution.
 * \ingroup lowleveltracing
 *
 * This class provides a public API to the ns3::TraceRoot object:
 *   - ns3::TraceResolver::Connect
 *   - ns3::TraceResolver::Disconnect
 *
 * It also provides an API for its subclasses. Each subclass should 
 * implement one of:
 *   - ns3::TraceResolver::DoLookup
 *   - ns3::TraceResolver::DoConnect and ns3::TraceResolver::DoDisconnect
 * Each subclass must also provide an ns3::TraceContext to the TraceResolver
 * constructor. Finally, each subclass can access the ns3::TraceContext 
 * associated to this  ns3::TraceResolver through the 
 * ns3::TraceResolver::GetContext method.
 */
class TraceResolver
{
public:

  TraceResolver ();
  virtual ~TraceResolver ();
  void Ref (void);
  void Unref (void);

  /**
   * \param path the namespace path to resolver
   * \param cb the callback to connect to the matching namespace
   *
   * This method is typically invoked by ns3::TraceRoot but advanced
   * users could also conceivably call it directly if they want to
   * skip the ns3::TraceRoot.
   */
  virtual void Connect (std::string path, CallbackBase const &cb, const TraceContext &context);
  /**
   * \param path the namespace path to resolver
   * \param cb the callback to disconnect in the matching namespace
   *
   * This method is typically invoked by ns3::TraceRoot but advanced
   * users could also conceivably call it directly if they want to
   * skip the ns3::TraceRoot.
   */
  virtual void Disconnect (std::string path, CallbackBase const &cb);
protected:
  std::string GetElement (std::string path);
  std::string GetSubpath (std::string path);
  uint32_t m_count;
};

}//namespace ns3

#endif /* TRACE_RESOLVER_H */