X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Socket%2FLLAddressing.hh;h=cedd2a03834eeb74b55dd84e594fd1051e4804ce;hb=9a988902090d28007578e93bffd809f6bd913155;hp=5a114a5b061c961e11c48dac79c6125f504d394d;hpb=a4911c1fd3f53dc2a7bda6c1d2b00bdc4b864cff;p=senf.git diff --git a/Socket/LLAddressing.hh b/Socket/LLAddressing.hh index 5a114a5..cedd2a0 100644 --- a/Socket/LLAddressing.hh +++ b/Socket/LLAddressing.hh @@ -1,6 +1,6 @@ // $Id$ // -// Copyright (C) 2006 +// Copyright (C) 2006 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS) // Kompetenzzentrum fuer Satelitenkommunikation (SatCom) // Stefan Bund @@ -50,21 +50,21 @@ namespace senf { /** \brief Link local address - LLSocketAddress wrapps the standard sockaddr_ll datatype. - - \todo I don't think the current implementation is - sensible. I'll have to reimplement this class probably - from scratch. - - \implementation The class relies uses a very flexible - 'ForwardRange' representation for a raw ll - address (See Boost.Range). - This representation allows zero-copy imlementations of - many operations, however it is probably not worth the - effort since the ll address is restricted to a max of 8 - bytes. Therefore this will be changed and the concrete - implementation is not documented very well ... + LLSocketAddress wraps the standard sockaddr_ll datatype. + + \todo I don't think the current implementation is + sensible. I'll have to reimplement this class probably + from scratch. + + \implementation The class relies uses a very flexible + 'ForwardRange' representation for a raw ll + address (See Boost.Range). + This representation allows zero-copy implementations of + many operations, however it is probably not worth the + effort since the ll address is restricted to a max of 8 + bytes. Therefore this will be changed and the concrete + implementation is not documented very well ... */ class LLSocketAddress { @@ -73,7 +73,7 @@ namespace senf { // as the representation for a hardware address. The restrictions // for the range are: // a) the range must never be larger than 8 elements - // b) the value_type must be convertible to unsigend char + // b) the value_type must be convertible to unsigned char // and really we need only a single-pass range. // // Since a hardware address is so short (a maximum of 8 @@ -88,7 +88,7 @@ namespace senf { // I'll leave it as it is ... typedef boost::iterator_range LLAddress; - + LLSocketAddress(); // And this is for bind explicit LLSocketAddress(unsigned protocol, std::string interface=""); @@ -125,7 +125,7 @@ namespace senf { }; /** \brief - \related LLSocketAddress + \related LLSocketAddress */ detail::LLAddressFromStringRange llAddress(std::string address); @@ -135,14 +135,14 @@ namespace senf { // except for academic cases // STOP: ... how about std::vector<...>::iterator ?? isn't that a ..pointer ? /** \brief Convert raw link-local address into printable form - \related LLSocketAddress + \related LLSocketAddress */ template std::string llAddress(ForwardRange const & address, typename boost::enable_if< boost::is_class >::type * = 0); /** \brief Signal invalid link local address syntax - \related LLSocketAddress + \related LLSocketAddress */ struct InvalidLLSocketAddressException : public std::exception { char const * what() const throw() { return "invalid ll address"; } }; @@ -154,16 +154,16 @@ namespace senf { /** \brief Addressing policy supporting link-local addressing - \par Address Type: - LLSocketAddress - - This addressing policy implements generic link local - addressing. The predominant type of link local addressing is - Ethernet addressing. + \par Address Type: + LLSocketAddress + + This addressing policy implements generic link local + addressing. The predominant type of link local addressing is + Ethernet addressing. - Since the link layer does not support the notion of - connections, link local addresses do not support the connect() - or peer() members. + Since the link layer does not support the notion of + connections, link local addresses do not support the connect() + or peer() members. */ struct LLAddressingPolicy : public AddressingPolicyBase, @@ -188,5 +188,8 @@ namespace senf { // Local Variables: // mode: c++ +// fill-column: 100 // c-file-style: "senf" +// indent-tabs-mode: nil +// ispell-local-dictionary: "american" // End: