--- a/src/core/trace-source-accessor.h Mon Mar 10 14:52:08 2008 -0700
+++ b/src/core/trace-source-accessor.h Mon Mar 10 14:57:04 2008 -0700
@@ -1,3 +1,22 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/*
+ * Copyright (c) 2008 INRIA
+ *
+ * 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
+ *
+ * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
+ */
#ifndef TRACE_SOURCE_ACCESSOR_H
#define TRACE_SOURCE_ACCESSOR_H
@@ -8,6 +27,11 @@
namespace ns3 {
+/**
+ * \brief control access to objects' trace sources
+ *
+ * This class abstracts the kind of trace source to which we want to connect.
+ */
class TraceSourceAccessor : public ObjectBase
{
public:
@@ -16,14 +40,38 @@
void Ref (void) const;
void Unref (void) const;
+ /**
+ * \param obj the object instance which contains the target trace source.
+ * \param cb the callback to connect to the target trace source.
+ */
virtual bool Connect (ObjectBase *obj, const CallbackBase &cb) const = 0;
+ /**
+ * \param obj the object instance which contains the target trace source.
+ * \param context the context to bind to the user callback.
+ * \param cb the callback to connect to the target trace source.
+ */
virtual bool ConnectWithContext (ObjectBase *obj, std::string context, const CallbackBase &cb) const = 0;
+ /**
+ * \param obj the object instance which contains the target trace source.
+ * \param cb the callback to disconnect from the target trace source.
+ */
virtual bool Disconnect (ObjectBase *obj, const CallbackBase &cb) const = 0;
+ /**
+ * \param obj the object instance which contains the target trace source.
+ * \param context the context which was bound to the user callback.
+ * \param cb the callback to disconnect from the target trace source.
+ */
virtual bool DisconnectWithContext (ObjectBase *obj, std::string context, const CallbackBase &cb) const = 0;
private:
mutable uint32_t m_count;
};
+/**
+ * \param a the trace source
+ *
+ * Create a TraceSourceAccessor which will control access to the underlying
+ * trace source.
+ */
template <typename T>
Ptr<const TraceSourceAccessor> MakeTraceSourceAccessor (T a);