From ba21e8f247f65eb16f8e22895d8797430a1fe51f Mon Sep 17 00:00:00 2001
From: tho <tho@wiback.org>
Date: Tue, 12 Feb 2008 12:41:01 +0000
Subject: [PATCH] doclib: link new berlios wiki
Packets/DefaultBundle/extra_tests: use unittest include from utils /grrr
Socket/Protocols/AddressExceptions: fixes Socket: fixed documentation
---
.../DefaultBundle/extra_tests/PacketLink.test.cc | 2 +-
Socket/Protocols/AddressExceptions.hh | 14 ++++++++++----
.../Protocols/INet/ConnectedRawINetSocketHandle.hh | 10 ++++------
Socket/Protocols/INet/ConnectedUDPSocketHandle.hh | 10 ++++------
Socket/Protocols/INet/INetAddressing.hh | 2 +-
Socket/Protocols/INet/RawINetSocketHandle.hh | 8 +++-----
Socket/Protocols/INet/TCPSocketHandle.hh | 10 ++++------
Socket/Protocols/INet/UDPSocketHandle.hh | 8 +++-----
Socket/Protocols/Raw/PacketSocketHandle.hh | 5 ++---
.../UN/ConnectedUNDatagramSocketHandle.hh | 5 ++---
Socket/Protocols/UN/UNAddressing.hh | 2 +-
Socket/Protocols/UN/UNDatagramSocketHandle.hh | 5 ++---
Utils/auto_unit_test.hh | 4 +++-
doclib/SConscript | 2 +-
14 files changed, 41 insertions(+), 46 deletions(-)
diff --git a/Packets/DefaultBundle/extra_tests/PacketLink.test.cc b/Packets/DefaultBundle/extra_tests/PacketLink.test.cc
index 11b0d7437..e84cd9d3b 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 <boost/test/auto_unit_test.hpp>
+#include "../../../Utils/auto_unit_test.hh"
#include <boost/test/test_tools.hpp>
#define prefix_
diff --git a/Socket/Protocols/AddressExceptions.hh b/Socket/Protocols/AddressExceptions.hh
index ff59751f6..2409cd025 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 0f2927990..eecde8e68 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 53c843317..f1b91060b 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 9a30affdc..2bd59ccb2 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 73a20d3bb..ed2ae74e5 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 fb5d4d632..15aba836c 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 cbb427b8c..a90163e44 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 8a0f3201b..56aaadb2c 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 fc7493b31..ba5db7113 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 fc918a304..82109e044 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 03e5d53a4..4f47dd947 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 0651fde9f..9ae6577f1 100644
--- a/Utils/auto_unit_test.hh
+++ b/Utils/auto_unit_test.hh
@@ -28,7 +28,9 @@
any necessary workarounds.
So, instead of <tt>\#include <boost/test/auto_unit_test.hpp></tt>, you should always write
- <tt>\#include "../Utils/auto_unit_test.hh"</tt> (with possibliy adjusted path).
+ <pre>
+ #include "../Utils/auto_unit_test.hh"
+ </pre> (with possibliy adjusted path).
*/
#ifndef HH_auto_unit_test_
diff --git a/doclib/SConscript b/doclib/SConscript
index 276ec2d65..4c3bac750 100644
--- a/doclib/SConscript
+++ b/doclib/SConscript
@@ -261,7 +261,7 @@ div.tabs li.$projectname a { background-color: #EDE497; }
<li><a class="ext" href="http://svn.berlios.de/viewcvs/senf/trunk/">Browse SVN</a></li>
<li><a class="ext" href="http://svn.berlios.de/wsvn/senf/?op=log&rev=0&sc=0&isdir=1">ChangeLog</a></li>
<li><a class="ext" href="http://developer.berlios.de/projects/senf">BerliOS</a></li>
- <li><a class="ext" href="http://openfacts.berlios.de/index-en.phtml?title=SENF+Network+Framework">Wiki</a></li>
+ <li><a class="ext" href="http://openfacts2.berlios.de/wikien/index.php/BerliosProject:SENF_Network_Framework">Wiki</a></li>
<li><a href="@TOPDIR@/doc/html/index.html">Home</a></li>
</ul>
<h2>${TITLE}</h2>
--
GitLab