switch to new MPL based Fraunhofer FOKUS Public License
[senf.git] / senf / Socket / ClientSocketHandle.ih
1 // $Id$
2 //
3 // Copyright (C) 2007
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 //
6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
7 // Version 1.0 (the "License"); you may not use this file except in compliance
8 // with the License. You may obtain a copy of the License at 
9 // http://senf.berlios.de/license.html
10 //
11 // The Fraunhofer FOKUS Public License Version 1.0 is based on, 
12 // but modifies the Mozilla Public License Version 1.1.
13 // See the full license text for the amendments.
14 //
15 // Software distributed under the License is distributed on an "AS IS" basis, 
16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
17 // for the specific language governing rights and limitations under the License.
18 //
19 // The Original Code is Fraunhofer FOKUS code.
20 //
21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. 
22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
23 // All Rights Reserved.
24 //
25 // Contributor(s):
26 //   Stefan Bund <g0dil@berlios.de>
27
28 /** \file
29     \brief ClientSocketHandle internal header */
30
31 #ifndef IH_SENF_Socket_ClientSocketHandle_
32 #define IH_SENF_Socket_ClientSocketHandle_ 1
33
34 // Custom includes
35 #include <senf/Utils/IteratorTraits.hh>
36
37 //-/////////////////////////////////////////////////////////////////////////////////////////////////
38
39 namespace senf {
40 namespace detail {
41
42     //-/////////////////////////////////////////////////////////////////////////////////////////////
43     // senf::detail::ReadRange
44
45     /** \brief Internal: Choose optimal read implementation
46
47         \internal
48
49         If the range iterator is a contiguous_storage_iterator, the data is *directly* read into the
50         range, otherwise a temporary storage area is used.
51      */
52     template <class Handle, class ForwardWritableRange, bool IsContiguous>
53     struct ReadRange
54     {
55         static typename boost::range_iterator<ForwardWritableRange>::type
56         read(Handle & handle, ForwardWritableRange & range);
57
58         static typename boost::range_iterator<ForwardWritableRange>::type
59         readfrom(Handle & handle, ForwardWritableRange & range, typename Handle::Address & addr);
60     };
61
62 #   ifndef DOXYGEN
63
64     template <class Handle, class ForwardWritableRange>
65     struct ReadRange<Handle, ForwardWritableRange, true>
66     {
67         static typename boost::range_iterator<ForwardWritableRange>::type
68         read(Handle & handle, ForwardWritableRange & range);
69
70         static typename boost::range_iterator<ForwardWritableRange>::type
71         readfrom(Handle & handle, ForwardWritableRange & range, typename Handle::Address & addr);
72     };
73
74 #   endif
75
76     //-/////////////////////////////////////////////////////////////////////////////////////////////
77     // senf::detail::WriteRange
78
79     /** \brief Internal: Choose optimal write implementation
80
81         \internal
82
83         If the range iterator is a contiguous_storage_iterator, the data is *directly* written from
84         the range, otherwise a temporary storage area is used.
85      */
86     template <class Handle, class ForwardReadableRange, bool IsContiguous>
87     struct WriteRange
88     {
89         static typename boost::range_const_iterator<ForwardReadableRange>::type
90         write(Handle & handle, ForwardReadableRange & range);
91
92         static typename boost::range_const_iterator<ForwardReadableRange>::type
93         writeto(Handle & handle, ForwardReadableRange & range,
94                 typename Handle::Address const & addr);
95     };
96
97 #   ifndef DOXYGEN
98
99     template <class Handle, class ForwardReadableRange>
100     struct WriteRange<Handle, ForwardReadableRange, true>
101     {
102         static typename boost::range_const_iterator<ForwardReadableRange>::type
103         write(Handle & handle, ForwardReadableRange & range);
104
105         static typename boost::range_const_iterator<ForwardReadableRange>::type
106         writeto(Handle & handle, ForwardReadableRange & range,
107                 typename Handle::Address const & addr);
108     };
109
110 #   endif
111
112 }}
113
114 //-/////////////////////////////////////////////////////////////////////////////////////////////////
115 #endif
116
117 \f
118 // Local Variables:
119 // mode: c++
120 // fill-column: 100
121 // c-file-style: "senf"
122 // indent-tabs-mode: nil
123 // ispell-local-dictionary: "american"
124 // compile-command: "scons -u test"
125 // comment-column: 40
126 // End: