Socket/Protocols/INet: Fix address class documentation
[senf.git] / Socket / Protocols / INet / INetAddressing.cci
1 // $Id$
2 //
3 // Copyright (C) 2006
4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
6 //     Stefan Bund <stefan.bund@fokus.fraunhofer.de>
7 //
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
12 //
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 // GNU General Public License for more details.
17 //
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22
23 /** \file
24     \brief INet[46]Address and INet[46]AddressingPolicy inline non-template implementation
25  */
26
27 // Custom includes
28 #include <arpa/inet.h>
29
30 #define prefix_ inline
31 ///////////////////////////////cci.p///////////////////////////////////////
32
33 ///////////////////////////////////////////////////////////////////////////
34 // senf::INet4Address
35
36 prefix_ senf::INet4SocketAddress::INet4SocketAddress()
37 {
38     clear();
39 }
40
41 prefix_ bool senf::INet4SocketAddress::operator==(INet4SocketAddress const & other)
42     const
43 {
44     return addr_.sin_port == other.addr_.sin_port &&
45         addr_.sin_addr.s_addr == other.addr_.sin_addr.s_addr;
46 }
47
48 prefix_ senf::INet4Address senf::INet4SocketAddress::address()
49     const
50 {
51     return INet4Address::from_inaddr(addr_.sin_addr.s_addr);
52 }
53
54 prefix_ unsigned senf::INet4SocketAddress::port()
55     const
56 {
57     return ntohs(addr_.sin_port);
58 }
59
60 prefix_ bool senf::INet4SocketAddress::boolean_test()
61     const
62 {
63     return port() || address();
64 }
65
66 prefix_ void senf::INet4SocketAddress::address(INet4Address const & addr)
67 {
68     addr_.sin_addr.s_addr = addr.inaddr();
69 }
70
71 prefix_ void senf::INet4SocketAddress::port(unsigned p)
72 {
73     addr_.sin_port = htons(p);
74 }
75
76 prefix_ struct sockaddr * senf::INet4SocketAddress::sockaddr_p()
77 {
78     return reinterpret_cast<struct sockaddr *>(&addr_);
79 }
80
81 prefix_ struct sockaddr const * senf::INet4SocketAddress::sockaddr_p()
82     const
83 {
84     return reinterpret_cast<struct sockaddr const *>(&addr_);
85 }
86
87 prefix_ unsigned senf::INet4SocketAddress::sockaddr_len()
88     const
89 {
90     return sizeof(addr_);
91 }
92
93 prefix_ std::ostream & senf::operator<<(std::ostream & os, INet4SocketAddress const & addr)
94 {
95     os << addr.address() << ":" << addr.port();
96     return os;
97 }
98
99 ///////////////////////////////////////////////////////////////////////////
100 // senf::INet6SocketAddress
101
102 prefix_ senf::INet6SocketAddress::INet6SocketAddress()
103 {
104     clear();
105 }
106
107 prefix_ senf::INet6SocketAddress::INet6SocketAddress(std::string const & addr)
108 {
109     clear();
110     assignAddr(addr);
111 }
112
113 prefix_ senf::INet6SocketAddress::INet6SocketAddress(INet6Address const & addr, unsigned port)
114 {
115     clear();
116     std::copy(addr.begin(), addr.end(), &sockaddr_.sin6_addr.s6_addr[0]);
117     sockaddr_.sin6_port = htons(port);
118 }
119
120 prefix_ senf::INet6SocketAddress::INet6SocketAddress(INet6Address const & addr, unsigned port,
121                                                      std::string const & iface)
122 {
123     clear();
124     std::copy(addr.begin(), addr.end(), &sockaddr_.sin6_addr.s6_addr[0]);
125     sockaddr_.sin6_port = htons(port);
126     assignIface(iface);
127 }
128
129 prefix_ senf::INet6SocketAddress::INet6SocketAddress(std::string const & addr,
130                                                      std::string const & iface)
131 {
132     clear();
133     assignAddr(addr);
134     assignIface(iface);
135 }
136
137 prefix_ senf::INet6Address senf::INet6SocketAddress::address()
138     const
139 {
140     return INet6Address::from_data(&sockaddr_.sin6_addr.s6_addr[0]);
141 }
142
143 prefix_ void senf::INet6SocketAddress::address(INet6Address const & addr)
144 {
145     std::copy(addr.begin(), addr.end(), &sockaddr_.sin6_addr.s6_addr[0]);
146 }
147
148 prefix_ unsigned senf::INet6SocketAddress::port()
149     const
150 {
151     return ntohs(sockaddr_.sin6_port);
152 }
153
154 prefix_ void senf::INet6SocketAddress::port(unsigned port)
155 {
156     sockaddr_.sin6_port = htons(port);
157 }
158
159 prefix_ void senf::INet6SocketAddress::iface(std::string const & iface)
160 {
161     assignIface(iface);
162 }
163
164 prefix_ struct sockaddr * senf::INet6SocketAddress::sockaddr_p()
165 {
166     return reinterpret_cast<struct sockaddr *>(&sockaddr_);
167 }
168
169 prefix_ struct sockaddr const * senf::INet6SocketAddress::sockaddr_p()
170     const
171 {
172     return reinterpret_cast<struct sockaddr const *>(&sockaddr_);
173 }
174
175 prefix_ unsigned senf::INet6SocketAddress::sockaddr_len()
176     const
177 {
178     return sizeof(sockaddr_);
179 }
180
181 prefix_ std::ostream & senf::operator<<(std::ostream & os, INet6SocketAddress const & addr)
182 {
183     os << '[' << addr.address();
184     std::string iface (addr.iface());
185     if (! iface.empty())
186         os << '%' << iface;
187     os << "]:" << addr.port();
188     return os;
189 }
190
191 ///////////////////////////////cci.e///////////////////////////////////////
192 #undef prefix_
193
194 \f
195 // Local Variables:
196 // mode: c++
197 // fill-column: 100
198 // c-file-style: "senf"
199 // indent-tabs-mode: nil
200 // ispell-local-dictionary: "american"
201 // compile-command: "scons -u test"
202 // comment-column: 40
203 // End: