live
NetAddress.hh
Go to the documentation of this file.
1 /**********
2 This library is free software; you can redistribute it and/or modify it under
3 the terms of the GNU Lesser General Public License as published by the
4 Free Software Foundation; either version 3 of the License, or (at your
5 option) any later version. (See <http://www.gnu.org/copyleft/lesser.html>.)
6 
7 This library is distributed in the hope that it will be useful, but WITHOUT
8 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
9 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
10 more details.
11 
12 You should have received a copy of the GNU Lesser General Public License
13 along with this library; if not, write to the Free Software Foundation, Inc.,
14 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15 **********/
16 // "mTunnel" multicast access service
17 // Copyright (c) 1996-2019 Live Networks, Inc. All rights reserved.
18 // Network Addresses
19 // C++ header
20 
21 #ifndef _NET_ADDRESS_HH
22 #define _NET_ADDRESS_HH
23 
24 #ifndef _HASH_TABLE_HH
25 #include "HashTable.hh"
26 #endif
27 
28 #ifndef _NET_COMMON_H
29 #include "NetCommon.h"
30 #endif
31 
32 #ifndef _USAGE_ENVIRONMENT_HH
33 #include "UsageEnvironment.hh"
34 #endif
35 
36 // Definition of a type representing a low-level network address.
37 // At present, this is 32-bits, for IPv4. Later, generalize it,
38 // to allow for IPv6.
39 typedef u_int32_t netAddressBits;
40 
41 class NetAddress {
42 public:
43  NetAddress(u_int8_t const* data,
44  unsigned length = 4 /* default: 32 bits */);
45  NetAddress(unsigned length = 4); // sets address data to all-zeros
46  NetAddress(NetAddress const& orig);
47  NetAddress& operator=(NetAddress const& rightSide);
48  virtual ~NetAddress();
49 
50  unsigned length() const { return fLength; }
51  u_int8_t const* data() const // always in network byte order
52  { return fData; }
53 
54 private:
55  void assign(u_int8_t const* data, unsigned length);
56  void clean();
57 
58  unsigned fLength;
59  u_int8_t* fData;
60 };
61 
63 public:
64  NetAddressList(char const* hostname);
65  NetAddressList(NetAddressList const& orig);
66  NetAddressList& operator=(NetAddressList const& rightSide);
67  virtual ~NetAddressList();
68 
69  unsigned numAddresses() const { return fNumAddresses; }
70 
71  NetAddress const* firstAddress() const;
72 
73  // Used to iterate through the addresses in a list:
74  class Iterator {
75  public:
76  Iterator(NetAddressList const& addressList);
77  NetAddress const* nextAddress(); // NULL iff none
78  private:
80  unsigned fNextIndex;
81  };
82 
83 private:
84  void assign(netAddressBits numAddresses, NetAddress** addressArray);
85  void clean();
86 
87  friend class Iterator;
88  unsigned fNumAddresses;
90 };
91 
92 typedef u_int16_t portNumBits;
93 
94 class Port {
95 public:
96  Port(portNumBits num /* in host byte order */);
97 
98  portNumBits num() const { return fPortNum; } // in network byte order
99 
100 private:
101  portNumBits fPortNum; // stored in network byte order
102 #ifdef IRIX
103  portNumBits filler; // hack to overcome a bug in IRIX C++ compiler
104 #endif
105 };
106 
108 
109 
110 // A generic table for looking up objects by (address1, address2, port)
112 public:
114  virtual ~AddressPortLookupTable();
115 
116  void* Add(netAddressBits address1, netAddressBits address2, Port port, void* value);
117  // Returns the old value if different, otherwise 0
118  Boolean Remove(netAddressBits address1, netAddressBits address2, Port port);
119  void* Lookup(netAddressBits address1, netAddressBits address2, Port port);
120  // Returns 0 if not found
121  void* RemoveNext() { return fTable->RemoveNext(); }
122 
123  // Used to iterate through the entries in the table
124  class Iterator {
125  public:
127  virtual ~Iterator();
128 
129  void* next(); // NULL iff none
130 
131  private:
133  };
134 
135 private:
136  friend class Iterator;
138 };
139 
140 
142 
143 
144 // A mechanism for displaying an IPv4 address in ASCII. This is intended to replace "inet_ntoa()", which is not thread-safe.
146 public:
147  AddressString(struct sockaddr_in const& addr);
148  AddressString(struct in_addr const& addr);
149  AddressString(netAddressBits addr); // "addr" is assumed to be in host byte order here
150 
151  virtual ~AddressString();
152 
153  char const* val() const { return fVal; }
154 
155 private:
156  void init(netAddressBits addr); // used to implement each of the constructors
157 
158 private:
159  char* fVal; // The result ASCII string: allocated by the constructor; deleted by the destructor
160 };
161 
162 #endif
unsigned char Boolean
Definition: Boolean.hh:25
Iterator(NetAddressList const &addressList)
portNumBits fPortNum
Definition: NetAddress.hh:101
void * Lookup(netAddressBits address1, netAddressBits address2, Port port)
NetAddressList & operator=(NetAddressList const &rightSide)
u_int32_t netAddressBits
Definition: NetAddress.hh:39
u_int8_t const * data() const
Definition: NetAddress.hh:51
u_int16_t portNumBits
Definition: NetAddress.hh:92
unsigned length() const
Definition: NetAddress.hh:50
Boolean IsMulticastAddress(netAddressBits address)
Iterator(AddressPortLookupTable &table)
void assign(u_int8_t const *data, unsigned length)
virtual ~NetAddress()
void init(netAddressBits addr)
void assign(netAddressBits numAddresses, NetAddress **addressArray)
portNumBits num() const
Definition: NetAddress.hh:98
Boolean Remove(netAddressBits address1, netAddressBits address2, Port port)
unsigned numAddresses() const
Definition: NetAddress.hh:69
AddressString(struct sockaddr_in const &addr)
NetAddress & operator=(NetAddress const &rightSide)
UsageEnvironment & operator<<(UsageEnvironment &s, const Port &p)
NetAddressList(char const *hostname)
void * RemoveNext()
virtual ~AddressString()
NetAddress(u_int8_t const *data, unsigned length=4)
virtual ~NetAddressList()
HashTable::Iterator * fIter
Definition: NetAddress.hh:132
NetAddress const * nextAddress()
unsigned fLength
Definition: NetAddress.hh:58
NetAddress const * firstAddress() const
unsigned fNumAddresses
Definition: NetAddress.hh:88
u_int8_t * fData
Definition: NetAddress.hh:59
virtual ~AddressPortLookupTable()
NetAddress ** fAddressArray
Definition: NetAddress.hh:89
void * Add(netAddressBits address1, netAddressBits address2, Port port, void *value)
void clean()
NetAddressList const & fAddressList
Definition: NetAddress.hh:79
char const * val() const
Definition: NetAddress.hh:153
Port(portNumBits num)