added more or less meaningful descriptions when throwing SystemExceptions
[senf.git] / senf / Socket / Protocols / Raw / MmapedPacketSocketHandle.hh
1 // $Id:PacketSocketHandle.hh 218 2007-03-20 14:39:32Z tho $
2 //
3 // Copyright (C) 2011
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 //   Thorsten Horstmann <tho@berlios.de>
27
28 /** \file
29     \brief MmapedPacketSocketProtocol and MmapedPacketSocketHandle public header
30  */
31
32 #ifndef HH_SENF_Socket_Protocols_Raw_MmapedPacketSocketHandle_
33 #define HH_SENF_Socket_Protocols_Raw_MmapedPacketSocketHandle_ 1
34
35 // Custom includes
36 #include <senf/Socket/SocketPolicy.hh>
37 #include <senf/Socket/SocketProtocol.hh>
38 #include <senf/Socket/ProtocolClientSocketHandle.hh>
39 #include <senf/Socket/FramingPolicy.hh>
40 #include <senf/Socket/CommunicationPolicy.hh>
41 #include <senf/Socket/ReadWritePolicy.hh>
42 #include "LLAddressing.hh"
43
44 //-/////////////////////////////////////////////////////////////////////////////////////////////////
45
46 namespace senf {
47
48     /// \addtogroup concrete_protocol_group
49     //\{
50
51     typedef MakeSocketPolicy<
52         LLAddressingPolicy,
53         DatagramFramingPolicy,
54         UnconnectedCommunicationPolicy,
55         NotReadablePolicy,
56         NotWriteablePolicy
57         >::policy MmapedPacket_Policy;        ///< Policy of MmapedPacketSocketProtocol
58
59
60     /** \brief
61      */
62     class MmapedPacketSocketProtocol
63         : public ConcreteSocketProtocol<MmapedPacket_Policy, MmapedPacketSocketProtocol>
64     {
65     public:
66         enum SocketType { RawSocket, DatagramSocket };
67                                         ///< Socket types
68
69         ///\name Constructors
70         //\{
71         void init_client(SocketType type = RawSocket, int protocol = -1);
72         //\}
73
74         ///\name Protocol Interface
75         //\{
76
77         //\}
78
79         ///\name Abstract Interface Implementation
80         //\{
81         unsigned available() const;
82         bool eof() const;
83         //\}
84
85     private:
86         char * map_;
87 //        struct iovec * ring_;
88         struct tpacket_req req_;
89         typedef std::vector<struct iovec> iovecRing;
90         iovecRing ring_;
91     };
92
93
94     typedef ProtocolClientSocketHandle<MmapedPacketSocketProtocol> MmapedPacketSocketHandle;
95                                         ///< SocketHandle of the MmapedPacketSocketProtocol
96                                         /**< \related MmapedPacketSocketProtocol */
97
98     //\}
99 }
100
101 //-/////////////////////////////////////////////////////////////////////////////////////////////////
102 //#include "MmapedPacketSocketHandle.cci"
103 //#include "MmapedPacketSocketHandle.ct"
104 //#include "MmapedPacketSocketHandle.cti"
105 #endif
106
107 \f
108 // Local Variables:
109 // mode: c++
110 // fill-column: 100
111 // c-file-style: "senf"
112 // indent-tabs-mode: nil
113 // ispell-local-dictionary: "american"
114 // compile-command: "scons -u test"
115 // comment-column: 40
116 // End: