Utils/Logger: Documentation

Utils/Console: Add chroot() member ConfigBundle

git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@1187 270642c3-0616-0410-b53a-bc976706d245

diff --git a/Utils/Console/Config.cci b/Utils/Console/Config.cci
index 99bccc8..9988f03 100644 (file)
--- a/Utils/Console/Config.cci
+++ b/Utils/Console/Config.cci
@@ -53,6 +53,11 @@ prefix_ senf::console::DirectoryNode & senf::console::detail::RestrictedExecutor
     return executor_.chroot();
 }
 
+prefix_ void senf::console::detail::RestrictedExecutor::chroot(DirectoryNode & node)
+{
+    executor_.chroot(node);
+}
+
 prefix_ std::ostream & senf::console::detail::RestrictedExecutor::stream()
 {
     return stream_;
@@ -85,6 +90,17 @@ prefix_ void senf::console::ConfigBundle::reset()
     executor_.reset();
 }
 
+prefix_ senf::console::DirectoryNode & senf::console::ConfigBundle::root()
+    const
+{
+    return executor_.root();
+}
+
+prefix_ void senf::console::ConfigBundle::chroot(DirectoryNode & node)
+{
+    executor_.chroot(node);
+}
+
 ///////////////////////////////////////////////////////////////////////////
 // senf::console::detail::ConfigSource
 

diff --git a/Utils/Console/Config.hh b/Utils/Console/Config.hh
index 5bd384c..412c61a 100644 (file)
--- a/Utils/Console/Config.hh
+++ b/Utils/Console/Config.hh
@@ -90,6 +90,9 @@ namespace console {
                                              parsed nodes is cleared. Calling parse() will parse the
                                              complete config bundle again. */
 
+        DirectoryNode & root() const;
+        void chroot(DirectoryNode & node);
+
     protected:
 
     private:

diff --git a/Utils/Console/Config.ih b/Utils/Console/Config.ih
index 3c9ec54..4b54736 100644 (file)
--- a/Utils/Console/Config.ih
+++ b/Utils/Console/Config.ih
@@ -77,6 +77,7 @@ namespace detail {
                                              complete config file again. */
 
         DirectoryNode & root() const;
+        void chroot(DirectoryNode & node);
 
         std::ostream & stream();
 

diff --git a/Utils/Logger/Target.hh b/Utils/Logger/Target.hh
index f08ceb1..dbbad15 100644 (file)
--- a/Utils/Logger/Target.hh
+++ b/Utils/Logger/Target.hh
@@ -84,7 +84,7 @@ namespace log {
 
         Each parameter (stream, area and level) has two representations: A static (compile time
         constant) representation, which is the representation also used in the %log statements, and a
-        dynamic representation, which may be used for manipulating the routing table.
+        dynamic (runtime) representation.
 
         The static representation is used, when passing routing parameters via template arguments:
         \code
@@ -114,6 +114,21 @@ namespace log {
             loglevels. Dynamically, it is represented by an unsigned integer number, the \c value
             member of that class.
 
+        \subsection target_routing_processing Ordering routing entries and route processing
+
+        The routing table is processed from first route to last route, the first matching entry
+        determines the fate of a log messages. Therefore, the ordering of routing entries is
+        important.
+        
+        If no position is explicitly specified, new routing entries are added to the end of the
+        routing table. All routing statements however take an index as optional argument to
+        explicitly specify the position of the new routing entry.
+
+        The index value starts from 0 for the first route. The value gives the position the new
+        routing entry will have after it has been added. An index of 0 will thus insert the new
+        routing entry at the beginning of the table. Negative values count from the back, -1 being
+        the last entry.
+
         \section target_impl Implementing new targets
 
         To implement a new target type, you need to derive from senf::log::Target and implement the

diff --git a/senf.dict b/senf.dict
index 1851f05..bb7d7e5 100644 (file)
--- a/senf.dict
+++ b/senf.dict
@@ -6,6 +6,7 @@ ActiveFeederSink
 ActiveFeederSource
 ActiveInput
 ActiveOutput
+ActiveOutputJack
 ActiveSink
 ActiveSocketReader
 ActiveSource
@@ -15,12 +16,14 @@ AddressingPolicyBase
 AddressParser
 addrs
 addtogroup
+aka
 aListCollection
 alloc
 AnnotationRouter
 AnnotationType
 anotherCallback
 api
+ApplyInterfaceDecorator
 arg
 argattributes
 argc
@@ -60,6 +63,7 @@ cci
 cd
 cerr
 cfi
+ChannelGroupTable
 checksumEnabled
 checksumPresent
 CIDR
@@ -126,6 +130,10 @@ DTCP
 DTCPHelloPacket
 DVB
 ElementParser
+EmulatedInterface
+EmulatedReceiver
+EmulatedTransmitter
+EmulatedWLANInterface
 enableChecksum
 endcode
 endhtmlonly
@@ -231,6 +239,7 @@ IDE
 IdleEvent
 ietf
 iface
+ifconfig
 ifndef
 ih
 impl
@@ -246,6 +255,7 @@ InputConnector
 inputSocket
 Institut
 int
+InterfaceAPI
 IntervalTimer
 IntField
 InvalidPacketChainException
@@ -317,11 +327,14 @@ multicast
 MulticastSocketProtocol
 MyClass
 mycommand
+MyDecoration
 mydir
 myDirectory
 MyEnum
+MyInputGroup
 MyList
 MyNodeType
+MyOutputGroup
 MyParser
 myserver
 MySpecialObject
@@ -329,10 +342,12 @@ mytarget
 MyVariant
 MyVariantPolicy
 MyVector
+MyWLANInterface
 namespace
 nbar
 nc
 netcat
+NetEmu
 NETwork
 newpacket
 NewPacket
@@ -345,11 +360,13 @@ NoAddressingPolicy
 NoBuiltin
 NodeCreateTraits
 noinit
+noop
 noroute
 nothrow
 nrOfRecords
 nrOfSources
 nUsing
+NyInputGroup
 ob
 ObjectDirectory
 offene
@@ -412,6 +429,7 @@ ParseVariant
 ParseVec
 PassiveConnector
 PassiveInput
+PassiveInputJack
 PassiveJoin
 PassiveOutput
 PassiveQueue
@@ -460,6 +478,7 @@ RP
 SafePacketParser
 SatCom
 Satelitenkommunikation
+sbund
 SConfig
 scons
 SCons
@@ -575,6 +594,7 @@ TruncatedPacketException
 tt
 ttl
 TunTapSocketHandle
+txpower
 TypeA
 TypeB
 typeField
@@ -611,6 +631,13 @@ Ver
 vlanId
 VLanId
 VoidPacketParser
+WiredInterface
+WiredReceiver
+WiredTransmitter
+WirelessInterface
+WirelessReceiver
+WirelessTransmitter
+WLAN
 Wno
 Woverloaded
 WrapException