1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
/* -*- C++ -*- */
// $Id$
// ============================================================================
//
// = LIBRARY
// ace
//
// = FILENAME
// INET_Addr.h
//
// = AUTHOR
// Doug Schmidt
//
// ============================================================================
#ifndef ACE_INET_ADDR_H
#define ACE_INET_ADDR_H
#include "ace/pre.h"
#include "ace/ACE.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "ace/Addr.h"
class ACE_Export ACE_INET_Addr : public ACE_Addr
{
// = TITLE
// Defines a C++ wrapper facade for the Internet domain address
// family format.
public:
// = Initialization methods.
ACE_INET_Addr (void);
// Default constructor.
ACE_INET_Addr (const ACE_INET_Addr &);
// Copy constructor.
ACE_INET_Addr (const sockaddr_in *, int len);
// Creates an <ACE_INET_Addr> from a sockaddr_in structure.
ACE_INET_Addr (u_short port_number,
const ACE_TCHAR host_name[]);
// Creates an <ACE_INET_Addr> from a <port_number> and the remote
// <host_name>.
ACE_EXPLICIT ACE_INET_Addr (const ACE_TCHAR address[]);
// Initializes an <ACE_INET_Addr> from the <address>, which can be
// "ip-number:port-number" (e.g., "tango.cs.wustl.edu:1234" or
// "128.252.166.57:1234"). If there is no ':' in the <address> it
// is assumed to be a port number, with the IP address being
// INADDR_ANY.
ACE_INET_Addr (u_short port_number,
ACE_UINT32 ip_addr = INADDR_ANY);
// Creates an <ACE_INET_Addr> from a <port_number> and an Internet
// <ip_addr>. This method assumes that <port_number> and <ip_addr>
// are in host byte order.
ACE_INET_Addr (const ACE_TCHAR port_name[],
const ACE_TCHAR host_name[],
const ACE_TCHAR protocol[] = ACE_TEXT ("tcp"));
// Uses <getservbyname> to create an <ACE_INET_Addr> from a
// <port_name>, the remote <host_name>, and the <protocol>.
ACE_INET_Addr (const ACE_TCHAR port_name[],
ACE_UINT32 ip_addr,
const ACE_TCHAR protocol[] = ACE_TEXT ("tcp"));
// Uses <getservbyname> to create an <ACE_INET_Addr> from a
// <port_name>, an Internet <ip_addr>, and the <protocol>. This
// method assumes that <ip_addr> is in host byte order.
~ACE_INET_Addr (void);
// Default dtor.
// = Direct initialization methods.
// These methods are useful after the object has been constructed.
int set (const ACE_INET_Addr &);
// Initializes from another <ACE_INET_Addr>.
int set (u_short port_number,
const ACE_TCHAR host_name[],
int encode = 1);
// Initializes an <ACE_INET_Addr> from a <port_number> and the
// remote <host_name>. If <encode> is enabled then <port_number> is
// converted into network byte order, otherwise it is assumed to be
// in network byte order already and are passed straight through.
int set (u_short port_number,
ACE_UINT32 ip_addr = INADDR_ANY,
int encode = 1);
// Initializes an <ACE_INET_Addr> from a <port_number> and an
// Internet <ip_addr>. If <encode> is enabled then <port_number>
// and <ip_addr> are converted into network byte order, otherwise
// they are assumed to be in network byte order already and are
// passed straight through.
int set (const ACE_TCHAR port_name[],
const ACE_TCHAR host_name[],
const ACE_TCHAR protocol[] = ACE_TEXT ("tcp"));
// Uses <getservbyname> to initialize an <ACE_INET_Addr> from a
// <port_name>, the remote <host_name>, and the <protocol>.
int set (const ACE_TCHAR port_name[],
ACE_UINT32 ip_addr,
const ACE_TCHAR protocol[] = ACE_TEXT ("tcp"));
// Uses <getservbyname> to initialize an <ACE_INET_Addr> from a
// <port_name>, an <ip_addr>, and the <protocol>. This assumes that
// <ip_addr> is already in network byte order.
int set (const ACE_TCHAR addr[]);
// Initializes an <ACE_INET_Addr> from the <addr>, which can be
// "ip-number:port-number" (e.g., "tango.cs.wustl.edu:1234" or
// "128.252.166.57:1234"). If there is no ':' in the <address> it
// is assumed to be a port number, with the IP address being
// INADDR_ANY.
int set (const sockaddr_in *,
int len);
// Creates an <ACE_INET_Addr> from a sockaddr_in structure.
virtual void *get_addr (void) const;
// Return a pointer to the underlying network address.
virtual void set_addr (void *, int len);
// Set a pointer to the address.
virtual int addr_to_string (ACE_TCHAR buffer[],
size_t size,
int ipaddr_format = 1) const;
// Transform the current <ACE_INET_Addr> address into string format.
// If <ipaddr_format> is non-0 this produces "ip-number:port-number"
// (e.g., "128.252.166.57:1234"), whereas if <ipaddr_format> is 0
// this produces "ip-name:port-number" (e.g.,
// "tango.cs.wustl.edu:1234"). Returns -1 if the <size> of the
// <buffer> is too small, else 0.
virtual int string_to_addr (const ACE_TCHAR address[]);
// Initializes an <ACE_INET_Addr> from the <address>, which can be
// "ip-addr:port-number" (e.g., "tango.cs.wustl.edu:1234"),
// "ip-addr:port-name" (e.g., "tango.cs.wustl.edu:telnet"),
// "ip-number:port-number" (e.g., "128.252.166.57:1234"), or
// "ip-number:port-name" (e.g., "128.252.166.57:telnet"). If there
// is no ':' in the <address> it is assumed to be a port number,
// with the IP address being INADDR_ANY.
void set_port_number (u_short,
int encode = 1);
// Sets the port number without affecting the host name. If
// <encode> is enabled then <port_number> is converted into network
// byte order, otherwise it is assumed to be in network byte order
// already and are passed straight through.
u_short get_port_number (void) const;
// Return the port number, converting it into host byte order.
int get_host_name (ACE_TCHAR hostname[],
size_t hostnamelen) const;
// Return the character representation of the name of the host,
// storing it in the <hostname> (which is assumed to be
// <hostnamelen> bytes long). This version is reentrant.
const ACE_TCHAR *get_host_name (void) const;
// Return the character representation of the hostname (this version
// is non-reentrant since it returns a pointer to a static data
// area).
const ACE_TCHAR *get_host_addr (void) const;
// Return the "dotted decimal" Internet address.
ACE_UINT32 get_ip_address (void) const;
// Return the 4-byte IP address, converting it into host byte
// order.
int operator < (const ACE_INET_Addr &rhs);
// Returns true if <this> is less than <rhs>. In this context,
// "less than" is defined in terms of IP address and TCP port
// number. This operator makes it possible to use <ACE_INET_Addr>s
// in STL maps.
int operator == (const ACE_INET_Addr &SAP) const;
// Compare two addresses for equality. The addresses are considered
// equal if they contain the same IP address and port number.
int operator != (const ACE_INET_Addr &SAP) const;
// Compare two addresses for inequality.
virtual u_long hash (void) const;
// Computes and returns hash value.
void dump (void) const;
// Dump the state of an object.
ACE_ALLOC_HOOK_DECLARE;
// Declare the dynamic allocation hooks.
private:
sockaddr_in inet_addr_;
// Underlying representation.
};
#if defined (__ACE_INLINE__)
#include "ace/INET_Addr.i"
#endif /* __ACE_INLINE__ */
#include "ace/post.h"
#endif /* ACE_INET_ADDR_H */
|
