From: tho Date: Wed, 11 Aug 2010 07:58:33 +0000 (+0000) Subject: Documentation: fixed links to boost.org X-Git-Url: http://g0dil.de/git?p=senf.git;a=commitdiff_plain;h=d8d169a9fa7f5633171ea83362b0deaaf5bd337e Documentation: fixed links to boost.org PPI: use QueueingDiscipline::NONE in PassiveJoin and PassiveQueueingSocketSink site_scons: allow to set boost configure variables git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@1670 270642c3-0616-0410-b53a-bc976706d245 --- diff --git a/Examples/Sniffer/Mainpage.dox b/Examples/Sniffer/Mainpage.dox index bc69f29..3f88daf 100644 --- a/Examples/Sniffer/Mainpage.dox +++ b/Examples/Sniffer/Mainpage.dox @@ -139,9 +139,10 @@ The senf::scheduler::FdEvent constructor takes several arguments: \li a string describing the event. \li the callback to call whenever the event occurs. The callback is specified as a Boost.Function object. We use the \c - senf::membind helper from the Utils library to build such a function object. This helper - takes an arbitrary class member and binds it to a specific instance. + href="http://www.boost.org/doc/libs/release/doc/html/function.html">Boost.Function + object. We use the \c senf::membind helper from the Utils library to build such a + function object. This helper takes an arbitrary class member and binds it to a specific + instance. \li the handle or file descriptor to monitor. \li and the events to watch for. diff --git a/Examples/UDPClientServer/Mainpage.dox b/Examples/UDPClientServer/Mainpage.dox index 49043d8..b5c7875 100644 --- a/Examples/UDPClientServer/Mainpage.dox +++ b/Examples/UDPClientServer/Mainpage.dox @@ -65,10 +65,11 @@ Scheduler. The \link senf::Scheduler::add add() \endlink call takes two Arguments, the socket to bind to (which can be a lot of things and must not necessarily be a socket instance) and callback function to call, whenever there is an event on that socket.The callback - is specified as a Boost.Function object. - A third argument may be specified to restrict the events, on which the function is called, here we - used the EV_READ Argument, because we just want the program to read from the socket. - The default argument is set to \c senf::Scheduler::EV_ALL, which allows all actions on the socket. + is specified as a + Boost.Function object. A third argument may be specified to restrict the events, on which + the function is called, here we used the EV_READ Argument, because we just want the program to + read from the socket. The default argument is set to \c senf::Scheduler::EV_ALL, which allows + all actions on the socket. \until } diff --git a/HowTos/NewPacket/Mainpage.dox b/HowTos/NewPacket/Mainpage.dox index 4da44fe..0553412 100644 --- a/HowTos/NewPacket/Mainpage.dox +++ b/HowTos/NewPacket/Mainpage.dox @@ -561,8 +561,8 @@ Here we are using the more generic parser assignment expressed using the \c << operator. This operator in the most cases works like an ordinary assignment, however it can also be used to assign parsers to each other efficiently and it supports 'optional values' (as provided by Boost.Optional and as returned - by \c key()). + href="http://www.boost.org/doc/libs/release/libs/optional/index.html">Boost.Optional and + as returned by \c key()). \subsection howto_newpacket_type_dump Writing out a complete packet: The 'dump()' member diff --git a/senf/PPI/Joins.cc b/senf/PPI/Joins.cc index bad31fa..8f4926d 100644 --- a/senf/PPI/Joins.cc +++ b/senf/PPI/Joins.cc @@ -53,6 +53,7 @@ prefix_ void senf::ppi::module::PassiveJoin::connectorSetup(connector::PassiveIn { noroute(conn); conn.onRequest(boost::bind(&PassiveJoin::request,this,boost::ref(conn))); + conn.qdisc( QueueingDiscipline::NONE); } prefix_ void senf::ppi::module::PassiveJoin::onThrottle() diff --git a/senf/PPI/QueueingSocketSink.ct b/senf/PPI/QueueingSocketSink.ct index 594c501..2d991c6 100644 --- a/senf/PPI/QueueingSocketSink.ct +++ b/senf/PPI/QueueingSocketSink.ct @@ -72,6 +72,7 @@ prefix_ senf::ppi::module::PassiveQueueingSocketSink::PassiveQueueingSoc event_.enabled( false); noroute(input); input.onRequest( &PassiveQueueingSocketSink::write); + input.qdisc( QueueingDiscipline::NONE); checkThrottle(); } diff --git a/senf/Packets/Packet.hh b/senf/Packets/Packet.hh index 25d0f56..4698dd3 100644 --- a/senf/Packets/Packet.hh +++ b/senf/Packets/Packet.hh @@ -611,7 +611,7 @@ namespace senf { into the packet representation. The data will \e not be validated in any way. - \param[in] range Boost.Range + \param[in] range Boost.Range of data to construct packet from. */ #endif @@ -673,7 +673,7 @@ namespace senf { header/interpreter after \a packet in that packets interpreter chain. \param[in] packet Packet to append new packet to. - \param[in] range Boost.Range + \param[in] range Boost.Range of data to construct packet from. */ #endif diff --git a/senf/Packets/PacketRegistry.hh b/senf/Packets/PacketRegistry.hh index a82e7b3..868d485 100644 --- a/senf/Packets/PacketRegistry.hh +++ b/senf/Packets/PacketRegistry.hh @@ -170,7 +170,7 @@ namespace senf { \tparam PacketType packet of which the key is requested \returns key of the packet wrapped in a boost::optional or + href="http://www.boost.org/doc/libs/release/libs/optional/index.html">boost::optional or an unbound optional, if the key is not found. */ template @@ -192,7 +192,7 @@ namespace senf { \param packet The packet of which the key is requested \returns key of the packet wrapped in a boost::optional or + href="http://www.boost.org/doc/libs/release/libs/optional/index.html">boost::optional or an unbound optional, if the key is not found. */ static typename boost::optional key(Packet const & packet, NoThrow_t); diff --git a/senf/Scheduler/ClockService.hh b/senf/Scheduler/ClockService.hh index 1ad6e26..59b3de0 100644 --- a/senf/Scheduler/ClockService.hh +++ b/senf/Scheduler/ClockService.hh @@ -83,13 +83,15 @@ namespace senf { /** \brief Absolute time data type - Boost.DateTime datatype used to represent absolute date/time values. + Boost.DateTime + datatype used to represent absolute date/time values. */ typedef boost::posix_time::ptime abstime_type; /** \brief Relative time data type - Boost.DateTime datatype used to represent time intervals + Boost.DateTime + datatype used to represent time intervals */ typedef boost::posix_time::time_duration reltime_type; @@ -99,7 +101,8 @@ namespace senf { static abstime_type abstime(clock_type clock); ///< Convert clock to absolute time /**< This member converts a clock value into an absolute - Boost.DateTime value. + Boost.DateTime + value. \note You should not base timeout calculations on this absolute time value. Clock time is guaranteed to be monotonous, absolute time may be non-monotonous if @@ -107,7 +110,8 @@ namespace senf { static reltime_type reltime(clock_type clock); ///< Convert clock to relative time /**< This member converts a clock value into a relative - Boost.DateTime time interval + Boost.DateTime + time interval \note The resolution of reltime_type might be smaller than the clock_type resolution */ diff --git a/senf/Scheduler/Scheduler.hh b/senf/Scheduler/Scheduler.hh index 69c30ab..6ecef0d 100644 --- a/senf/Scheduler/Scheduler.hh +++ b/senf/Scheduler/Scheduler.hh @@ -105,12 +105,12 @@ namespace senf { \section sched_handlers Specifying handlers All handlers are specified as generic Boost.Function objects. This allows to - pass any callable as a handler. Depending on the type of handler, some additional arguments may - be passed to the handler by the %scheduler. + href="http://www.boost.org/doc/libs/release/libs/functional/index.html">Boost.Function + objects. This allows to pass any callable as a handler. Depending on the type of handler, + some additional arguments may be passed to the handler by the %scheduler. If you need to pass additional information to your handler, use Boost.Bind: + href="http://www.boost.org/doc/libs/release/libs/bind/bind.html">Boost.Bind: \code // Handle callback function void callback(UDPv4ClientSocketHandle handle, senf::Scheduler::EventId event) {..} @@ -125,7 +125,7 @@ namespace senf { \endcode To use member-functions as callbacks, use either Boost.Bind or senf::membind() + href="http://www.boost.org/doc/libs/release/libs/bind/bind.html">Boost.Bind or senf::membind() \code // e.g. in Foo::Foo() constructor: Foo::Foo() @@ -194,7 +194,7 @@ namespace senf { container API. The only difference is, that all elements added to the container \e must be created via \c new and that the pointer containers themselves are \e not copyable (ok, they are, if the elements are cloneable ...). See Boost.PointerContainer + href="http://www.boost.org/doc/libs/release/libs/ptr_container/doc/ptr_container.html">Boost.PointerContainer for the pointer container library reference. diff --git a/senf/Socket/ClientSocketHandle.hh b/senf/Socket/ClientSocketHandle.hh index 9bcbcb7..ce0f82a 100644 --- a/senf/Socket/ClientSocketHandle.hh +++ b/senf/Socket/ClientSocketHandle.hh @@ -98,7 +98,7 @@ namespace senf { /// 'Best' type for passing address as parameter /** Depending on the type of \c Address, this will be either Address or Address const &. See call_traits documentation in + href="http://www.boost.org/doc/libs/release/libs/utility/call_traits.htm">call_traits documentation in the Boost.Utility library. */ typedef typename boost::call_traits
::param_type AddressParam; @@ -195,7 +195,7 @@ namespace senf { \returns past-the-end iterator pointer to after the last read character \see \ref read() \n - Boost.Range */ + Boost.Range */ # endif # ifndef DOXYGEN template @@ -209,7 +209,7 @@ namespace senf { ///< Read data into range /**< \see read(ForwardWritableRange const &) \n read() \n - Boost.Range */ + Boost.Range */ # endif template void read (Sequence & container, unsigned limit); @@ -266,14 +266,14 @@ namespace senf { \returns past-the-end iterator pointer to after the last read character \see \ref readfrom() \n - Boost.Range */ + Boost.Range */ template typename boost::range_iterator::type readfrom (ForwardWritableRange & range, Address & from); ///< Read data into range /**< \see readfrom(ForwardWritableRange const&,Address&) \n readfrom() \n - Boost.Range */ + Boost.Range */ template void readfrom (Sequence & container, Address & from, unsigned limit); ///< Read data into container @@ -328,7 +328,7 @@ namespace senf { \param[in] end past-the-end pointer to area to write \returns past-the-end pointer after last byte written \see \ref write() \n - Boost.Range */ + Boost.Range */ /** \brief Write data to unconnected socket @@ -358,7 +358,7 @@ namespace senf { \param[in] end past-the-end pointer after data to write \returns past-the-end iterator after last byte written \see \ref writeto() \n - Boost.Range */ + Boost.Range */ /////////////////////////////////////////////////////////////////////////// ///\name Addressing diff --git a/senf/Socket/ServerSocketHandle.hh b/senf/Socket/ServerSocketHandle.hh index ccb6bae..cfac27f 100644 --- a/senf/Socket/ServerSocketHandle.hh +++ b/senf/Socket/ServerSocketHandle.hh @@ -82,7 +82,7 @@ namespace senf { /// 'Best' type for passing address as parameter /** Depending on the type of \c Address, this will be either Address or Address const &. See call_traits documentation in + href="http://www.boost.org/doc/libs/release/libs/utility/call_traits.htm">call_traits documentation in the Boost.Utility library. */ typedef typename boost::call_traits
::param_type AddressParam; diff --git a/senf/Socket/SocketPolicy.hh b/senf/Socket/SocketPolicy.hh index 256081a..8da09e9 100644 --- a/senf/Socket/SocketPolicy.hh +++ b/senf/Socket/SocketPolicy.hh @@ -206,14 +206,14 @@ The \c connect member in this example will only be enabled, it the communication policy of the socket handle is ConnectedCommunicationPolicy (or a derived type). See Boost.Enable_If for a discussion of - the third argument (\c senf::ConnectedCommunicationPolicyIs is based on the \c boost::enable_if - template). + href="http://www.boost.org/doc/libs/release/libs/utility/enable_if.html">Boost.Enable_If + for a discussion of the third argument (\c senf::ConnectedCommunicationPolicyIs is based on + the \c boost::enable_if template). \see \ref extend_policy \n - The Boost enable_if utility \n - The Boost.MPL library \n - The Boost.Preprocessor library + The Boost enable_if utility \n + The Boost.MPL library \n + The Boost.Preprocessor library \idea We could combine all the \e Axis \c Is templates into a single template. Since the \e trait argument will automatically specify the axis to be used, it is not necessary to specify @@ -414,9 +414,9 @@ namespace senf { /** \brief Enable template overload depending on policy value This template is an example of the \c If \e Axis \c Is family of templates. It is used like - Boost.enable_if to enable a - templated overload only, if the AddressingPolicy of \e Axis is compatible with \c Trait - (that is the AddressingPolicy of \c Policy is derived from \c Trait). + Boost.enable_if + to enable a templated overload only, if the AddressingPolicy of \e Axis is compatible with + \c Trait (that is the AddressingPolicy of \c Policy is derived from \c Trait). \see policy_group */ @@ -509,7 +509,7 @@ namespace senf { SocketHandle with policy \c Base). The metafunction will return true (that is inherits from \c boost::true_type, see the Boost.MPL library documentation for + href="http://www.boost.org/doc/libs/release/libs/mpl/doc/index.html">Boost.MPL library documentation for more information) if each policy class in \c Base is a baseclass of (or the same as) the corresponding policy class in \c Derived. diff --git a/senf/Utils/Console/Mainpage.dox b/senf/Utils/Console/Mainpage.dox index 3cee767..23c8601 100644 --- a/senf/Utils/Console/Mainpage.dox +++ b/senf/Utils/Console/Mainpage.dox @@ -683,7 +683,7 @@ \endhtmlonly As you can see above, the arguments and tokens are returned as + href="http://www.boost.org/doc/libs/release/libs/range/doc/html/range/reference/utilities/iterator_range.html"> boost::iterator_range instances. These behave much like containers: They have \c begin() and \c end() and some other useful members. diff --git a/senf/Utils/Console/ParsedCommand.hh b/senf/Utils/Console/ParsedCommand.hh index 86a2000..919065e 100644 --- a/senf/Utils/Console/ParsedCommand.hh +++ b/senf/Utils/Console/ParsedCommand.hh @@ -258,7 +258,7 @@ namespace console { /** \brief Keyword argument tags The tags defined in this namespace are used as keyword arguments via the Boost.Parameter + href="http://www.boost.org/doc/libs/release/libs/parameter/doc/html/index.html">Boost.Parameter library. For the keyword tags, the standard C++ scoping rules apply @@ -487,7 +487,7 @@ namespace console { /**< This member changes the attributes for the current argument. The attributes are passed to arg() as keyword arguments using the Boost.Parameter + href="http://www.boost.org/doc/libs/release/libs/parameter/doc/html/index.html">Boost.Parameter library. \code ... diff --git a/senf/Utils/Exception.hh b/senf/Utils/Exception.hh index ffd2bb4..7db4762 100644 --- a/senf/Utils/Exception.hh +++ b/senf/Utils/Exception.hh @@ -59,7 +59,7 @@ This will add the user information to any %senf exception thrown. The Exception is however not a stream. If you need to do more extensive formating, either use an intermediate string-stream or - use Boost.Format: + use Boost.Format: \code try { diff --git a/senf/Utils/Logger/Log.hh b/senf/Utils/Logger/Log.hh index 53e7ba5..30c8d2a 100644 --- a/senf/Utils/Logger/Log.hh +++ b/senf/Utils/Logger/Log.hh @@ -42,8 +42,8 @@ The logging library provides several commands to create %log messages. All these macro commands take a variable number of arguments. Since this is not supported in a usable way by the C++ preprocessor, the arguments are encoded into a Boost.Preprocessor like - sequence: + href="http://www.boost.org/doc/libs/release/libs/preprocessor/doc/index.html">Boost.Preprocessor + like sequence: \code SENF_LOG( (senf::log::Debug)(senf::log::NOTICE)(FroblizerArea)("The log message") ); diff --git a/senf/Utils/Mainpage.dox b/senf/Utils/Mainpage.dox index c96ddab..407bd9e 100644 --- a/senf/Utils/Mainpage.dox +++ b/senf/Utils/Mainpage.dox @@ -31,21 +31,21 @@ namespace senf { + href="http://www.boost.org/doc/libs/release/libs/bind/bind.html">Boost.Bind extension @@ -56,7 +56,7 @@ namespace senf {
\ref membinda simple Boost.Bind extension
\ref senfmplSome simple tools which help to solve common meta-programming tasks
\ref senfppExtensions to the Boost.Preprocessor + href="http://www.boost.org/doc/libs/release/libs/preprocessor/doc/index.html">Boost.Preprocessor library
\ref typetraitsExtensions to the Boost.TypeTraits + href="http://www.boost.org/doc/libs/release/libs/type_traits/index.html">Boost.TypeTraits library
\ref boost_parameterUtilities concerning the Boost.Parameter + href="http://www.boost.org/doc/libs/release/libs/parameter/doc/html/index.html">Boost.Parameter library
\ref phoenix_helpersPhoenix functors
+ href="http://www.boost.org/doc/libs/release/libs/smart_ptr/intrusive_ptr.html">boost::intrusive_ptr
\ref intrusive_refcountmixin to simplify writing classes for use with boost::intrusive_ptr
\ref safe_boola mixin class to provide a really safe replacement for operator bool diff --git a/senf/Utils/Statistics.hh b/senf/Utils/Statistics.hh index 3ac5d43..1e2cb4d 100644 --- a/senf/Utils/Statistics.hh +++ b/senf/Utils/Statistics.hh @@ -55,7 +55,7 @@ namespace senf { parameter is set up by connecting the Statistics instance with an arbitrary statistics source. - %Statistics sources are + %Statistics sources are Boost Signals which are emitted periodically to provide new data. */ diff --git a/senf/Utils/intrusive_refcount.hh b/senf/Utils/intrusive_refcount.hh index d1e1563..d612f4a 100644 --- a/senf/Utils/intrusive_refcount.hh +++ b/senf/Utils/intrusive_refcount.hh @@ -73,7 +73,7 @@ namespace senf { /** \brief Customizable reference count mixin for intrusive_ptr This class provides a simple internally managed refcount and supplies the boost::intrusive_ptr + href="http://www.boost.org/doc/libs/release/libs/smart_ptr/intrusive_ptr.html">boost::intrusive_ptr required interface. To make a class compatible with \c boost::intrusive_ptr, just derive publicly from intrusive_refcount_t. @@ -127,7 +127,7 @@ namespace senf { /** \brief Reference count mixin for intrusive_ptr This class provides a simple internally managed refcount and supplies the boost::intrusive_ptr + href="http://www.boost.org/doc/libs/release/libs/smart_ptr/intrusive_ptr.html">boost::intrusive_ptr required interface. To make a class compatible with \c boost::intrusive_ptr, just derive publicly from intrusive_refcount. diff --git a/senf/Utils/parameter.hh b/senf/Utils/parameter.hh index 0200cda..f83c61a 100644 --- a/senf/Utils/parameter.hh +++ b/senf/Utils/parameter.hh @@ -26,7 +26,7 @@ /** \defgroup boost_parameter Boost.Parameter utilities Here we define some utilities for the Boost.Parameter + href="http://www.boost.org/doc/libs/release/libs/parameter/doc/html/index.html">Boost.Parameter library. */ diff --git a/senf/Utils/pool_alloc_mixin.hh b/senf/Utils/pool_alloc_mixin.hh index 0a3b2af..8a32119 100644 --- a/senf/Utils/pool_alloc_mixin.hh +++ b/senf/Utils/pool_alloc_mixin.hh @@ -40,7 +40,7 @@ namespace senf { This mixin will overload a classes operator new and operator delete so as to make the class use the Boost.Pool memory allocator by + href="http://www.boost.org/doc/libs/release/libs/pool/doc/index.html">Boost.Pool memory allocator by default. Using this allocator does however introduce a few restrictions: \li The operator is defined for a fixed size. Therefore if you derive from the class you @@ -58,7 +58,7 @@ namespace senf { \endcode \note pool_alloc_mixin uses the Boost.Pool singleton + href="http://www.boost.org/doc/libs/release/libs/pool/doc/index.html">Boost.Pool singleton pool interface with the tag pool_alloc_mixin_tag. This class is accessible via the pool member. Using this member, it is simple to call relevant pool functions, e.g. SomeClass::pool<>::release_memory(). diff --git a/site_scons/senfutil.py b/site_scons/senfutil.py index 498f7f0..7a2eb98 100644 --- a/site_scons/senfutil.py +++ b/site_scons/senfutil.py @@ -262,8 +262,8 @@ def Configure(env): help=False, custom_tests=senfconf.Tests(), config_h="#/senf/autoconf.hh") - env.Replace( - BOOST_VERSION = conf.CheckBoostVersion(), + env.SetDefault( + BOOST_VERSION = conf.CheckBoostVersion(), BOOST_VARIANT = conf.CheckBoostVariants( '', 'mt' ), NEED_BOOST_EXT = not conf.CheckCXXHeader("boost/bimap.hpp"), HAVE_BOOST_SPIRIT_INCLUDE_CLASSIC_HPP = conf.CheckCXXHeader(