From: tho Date: Tue, 12 Feb 2008 12:41:01 +0000 (+0000) Subject: doclib: link new berlios wiki X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=9dfdf00953c3cabd0ce74e5b316905bb53bbba80;p=senf.git doclib: link new berlios wiki Packets/DefaultBundle/extra_tests: use unittest include from utils /grrr Socket/Protocols/AddressExceptions: fixes Socket: fixed documentation git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@688 270642c3-0616-0410-b53a-bc976706d245 --- diff --git a/Packets/DefaultBundle/extra_tests/PacketLink.test.cc b/Packets/DefaultBundle/extra_tests/PacketLink.test.cc index 11b0d74..e84cd9d 100644 --- a/Packets/DefaultBundle/extra_tests/PacketLink.test.cc +++ b/Packets/DefaultBundle/extra_tests/PacketLink.test.cc @@ -30,7 +30,7 @@ #include "../EthernetPacket.hh" #include "../IPv6Packet.hh" -#include +#include "../../../Utils/auto_unit_test.hh" #include #define prefix_ diff --git a/Socket/Protocols/AddressExceptions.hh b/Socket/Protocols/AddressExceptions.hh index ff59751..2409cd0 100644 --- a/Socket/Protocols/AddressExceptions.hh +++ b/Socket/Protocols/AddressExceptions.hh @@ -34,7 +34,7 @@ namespace senf { - /** \brief Base-class for INet4Address exceptions */ + /** \brief Base-class for Address exceptions */ struct AddressException : public senf::Exception { protected: @@ -42,13 +42,19 @@ namespace senf { : senf::Exception(msg) {} }; - /** \brief Invalid INet4 address syntax */ + /** \brief Invalid address syntax */ struct AddressSyntaxException : public AddressException - { AddressSyntaxException() : AddressException("invalid INet4 address syntax") {} }; + { + AddressSyntaxException() : AddressException("invalid address syntax") {} + AddressSyntaxException(std::string const & msg) : AddressException(msg) {} + }; /** \brief Resolver failure */ struct UnknownHostnameException : public AddressException - { UnknownHostnameException() : AddressException("failed to resolve INet4 hostname") {} }; + { + UnknownHostnameException() : AddressException("failed to resolve hostname") {} + UnknownHostnameException(std::string const & msg) : AddressException(msg) {} + }; } diff --git a/Socket/Protocols/INet/ConnectedRawINetSocketHandle.hh b/Socket/Protocols/INet/ConnectedRawINetSocketHandle.hh index 0f29279..eecde8e 100644 --- a/Socket/Protocols/INet/ConnectedRawINetSocketHandle.hh +++ b/Socket/Protocols/INet/ConnectedRawINetSocketHandle.hh @@ -56,11 +56,10 @@ namespace senf { \par Policy Interface: ClientSocketHandle::read(), ClientSocketHandle::write(), ClientSocketHandle::bind(), - ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer(), - ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf() + ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer() \par Address Type: - INet4Address + INet4SocketAddress ConnectedRawV4SocketProtocol provides an internet protocol raw socket based on IPv4 addressing. This socket will put data written to it onto the IPv4 layer: if you call writeto don't inlude the header! @@ -125,9 +124,8 @@ namespace senf { \par Policy Interface: ClientSocketHandle::read(), ClientSocketHandle::write(), ClientSocketHandle::bind(), - ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer(), - ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf() - + ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer() + \par Address Type: INet6Address diff --git a/Socket/Protocols/INet/ConnectedUDPSocketHandle.hh b/Socket/Protocols/INet/ConnectedUDPSocketHandle.hh index 53c8433..f1b9106 100644 --- a/Socket/Protocols/INet/ConnectedUDPSocketHandle.hh +++ b/Socket/Protocols/INet/ConnectedUDPSocketHandle.hh @@ -63,11 +63,10 @@ namespace senf { \par Policy Interface: ClientSocketHandle::read(), ClientSocketHandle::write(), ClientSocketHandle::bind(), - ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer(), - ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf() + ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer() \par Address Type: - INet4Address + INet4SocketAddress ConnectedUDPv4SocketProtocol provides an internet protocol stream socket based on the UDP protocol and IPv4 addressing. @@ -123,9 +122,8 @@ namespace senf { \par Policy Interface: ClientSocketHandle::read(), ClientSocketHandle::write(), ClientSocketHandle::bind(), - ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer(), - ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf() - + ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer() + \par Address Type: INet6Address diff --git a/Socket/Protocols/INet/INetAddressing.hh b/Socket/Protocols/INet/INetAddressing.hh index 9a30aff..2bd59cc 100644 --- a/Socket/Protocols/INet/INetAddressing.hh +++ b/Socket/Protocols/INet/INetAddressing.hh @@ -213,7 +213,7 @@ namespace senf { /** \brief Addressing policy supporting IPv4 addressing \par Address Type: - INet4Address + INet4SocketAddress This addressing policy implements addressing using Internet V4 addresses. diff --git a/Socket/Protocols/INet/RawINetSocketHandle.hh b/Socket/Protocols/INet/RawINetSocketHandle.hh index 73a20d3..ed2ae74 100644 --- a/Socket/Protocols/INet/RawINetSocketHandle.hh +++ b/Socket/Protocols/INet/RawINetSocketHandle.hh @@ -58,11 +58,10 @@ namespace senf { \par Policy Interface: ClientSocketHandle::read(), ClientSocketHandle::readfrom(), - ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local(), - ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf() + ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local() \par Address Type: - INet4Address + INet4SocketAddress RawV4SocketProtocol provides an internet protocol raw socket based on IPv4 addressing. This socket will put data written to it onto the IPv4 layer: if you call writeto don't inlude the header! @@ -127,8 +126,7 @@ namespace senf { \par Policy Interface: ClientSocketHandle::read(), ClientSocketHandle::readfrom(), - ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local(), - ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf() + ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local() \par Address Type: INet6Address diff --git a/Socket/Protocols/INet/TCPSocketHandle.hh b/Socket/Protocols/INet/TCPSocketHandle.hh index fb5d4d6..15aba83 100644 --- a/Socket/Protocols/INet/TCPSocketHandle.hh +++ b/Socket/Protocols/INet/TCPSocketHandle.hh @@ -64,11 +64,10 @@ namespace senf { \par Policy Interface: ClientSocketHandle::read(), ClientSocketHandle::write(), ClientSocketHandle::bind(), - ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer(), - ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf() + ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer() \par Address Type: - INet4Address + INet4SocketAddress TCPv4SocketProtocol provides an internet protocol stream socket based on the TCP protocol and IPv4 addressing. @@ -139,11 +138,10 @@ namespace senf { \par Policy Interface: ClientSocketHandle::read(), ClientSocketHandle::write(), ClientSocketHandle::bind(), - ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer(), - ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf() + ClientSocketHandle::local(), ClientSocketHandle::connect(), ClientSocketHandle::peer() \par Address Type: - INet6Address + INet6Address TCPv6SocketProtocol provides an internet protocol stream socket based on the TCP protocol and IPv6 addressing. diff --git a/Socket/Protocols/INet/UDPSocketHandle.hh b/Socket/Protocols/INet/UDPSocketHandle.hh index cbb427b..a90163e 100644 --- a/Socket/Protocols/INet/UDPSocketHandle.hh +++ b/Socket/Protocols/INet/UDPSocketHandle.hh @@ -64,11 +64,10 @@ namespace senf { \par Policy Interface: ClientSocketHandle::read(), ClientSocketHandle::readfrom(), - ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local(), - ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf() + ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local() \par Address Type: - INet4Address + INet4SocketAddress UDPv4SocketProtocol provides an internet protocol stream socket based on the UDP protocol and IPv4 addressing. @@ -125,8 +124,7 @@ namespace senf { \par Policy Interface: ClientSocketHandle::read(), ClientSocketHandle::readfrom(), - ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local(), - ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf() + ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local() \par Address Type: INet6Address diff --git a/Socket/Protocols/Raw/PacketSocketHandle.hh b/Socket/Protocols/Raw/PacketSocketHandle.hh index 8a0f320..56aaadb 100644 --- a/Socket/Protocols/Raw/PacketSocketHandle.hh +++ b/Socket/Protocols/Raw/PacketSocketHandle.hh @@ -62,11 +62,10 @@ namespace senf { \par Policy Interface: ClientSocketHandle::read(), ClientSocketHandle::readfrom(), ClientSocketHandle::writeto(), - ClientSocketHandle::bind(), ClientSocketHandle::local(), ClientSocketHandle::rcvbuf(), - ClientSocketHandle::sndbuf() + ClientSocketHandle::bind(), ClientSocketHandle::local() \par Address Type: - LLSocketAddress + LLSocketAddress The PacketSocketProtocol provides access to the linux packet socket API. This API gives access to the low level network packets. The packet socket allows read() and write() operations. The diff --git a/Socket/Protocols/UN/ConnectedUNDatagramSocketHandle.hh b/Socket/Protocols/UN/ConnectedUNDatagramSocketHandle.hh index fc7493b..ba5db71 100644 --- a/Socket/Protocols/UN/ConnectedUNDatagramSocketHandle.hh +++ b/Socket/Protocols/UN/ConnectedUNDatagramSocketHandle.hh @@ -58,11 +58,10 @@ namespace senf { \par Policy Interface: (to be checked) ClientSocketHandle::read(), ClientSocketHandle::readfrom(), - ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local(), - ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf() + ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local() \par Address Type: - UNAddress + UNSocketAddress ConnectedUNDatagramSocketProtocol provides an datagram protocol socket based on the unix domain addressing which operates in a connected mode. diff --git a/Socket/Protocols/UN/UNAddressing.hh b/Socket/Protocols/UN/UNAddressing.hh index fc918a3..82109e0 100644 --- a/Socket/Protocols/UN/UNAddressing.hh +++ b/Socket/Protocols/UN/UNAddressing.hh @@ -94,7 +94,7 @@ namespace senf { /** \brief Addressing policy supporting unix domain addressing \par Address Type: - UNAddress + UNSocketAddress This addressing policy implements addressing using unix domain addresses. diff --git a/Socket/Protocols/UN/UNDatagramSocketHandle.hh b/Socket/Protocols/UN/UNDatagramSocketHandle.hh index 03e5d53..4f47dd9 100644 --- a/Socket/Protocols/UN/UNDatagramSocketHandle.hh +++ b/Socket/Protocols/UN/UNDatagramSocketHandle.hh @@ -58,11 +58,10 @@ namespace senf { \par Policy Interface: (to be checked) ClientSocketHandle::read(), ClientSocketHandle::readfrom(), - ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local(), - ClientSocketHandle::rcvbuf(), ClientSocketHandle::sndbuf() + ClientSocketHandle::writeto(), ClientSocketHandle::bind(), ClientSocketHandle::local() \par Address Type: - UNAddress + UNSocketAddress UNDatagramSocketProtocol provides an datagram protocol socket based on the unix domain addressing. diff --git a/Utils/auto_unit_test.hh b/Utils/auto_unit_test.hh index 0651fde..9ae6577 100644 --- a/Utils/auto_unit_test.hh +++ b/Utils/auto_unit_test.hh @@ -28,7 +28,9 @@ any necessary workarounds. So, instead of \#include , you should always write - \#include "../Utils/auto_unit_test.hh" (with possibliy adjusted path). + 
+        #include "../Utils/auto_unit_test.hh"
+
(with possibliy adjusted path). */ #ifndef HH_auto_unit_test_ diff --git a/doclib/SConscript b/doclib/SConscript index 276ec2d..4c3bac7 100644 --- a/doclib/SConscript +++ b/doclib/SConscript @@ -261,7 +261,7 @@ div.tabs li.$projectname a { background-color: #EDE497; }
  • Browse SVN
  • ChangeLog
  • BerliOS
    • -
  • Wiki
    • +
  • Wiki
  • Home

    • ${TITLE}