src/node/ipv4-address-generator.h
author Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Tue, 02 Sep 2008 10:12:14 -0700
changeset 3576 f6abfdf47163
parent 3183 fc3b2e03e61e
permissions -rw-r--r--
bug 303: return value should not be const
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2722
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
     1
/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
     2
/*
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
     3
 * Copyright (c) 2008 University of Washington
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
     4
 *
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License version 2 as
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
     7
 * published by the Free Software Foundation;
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
     8
 *
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    12
 * GNU General Public License for more details.
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    13
 *
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    15
 * along with this program; if not, write to the Free Software
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    16
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    17
 */
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    18
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    19
#ifndef IPV4_ADDRESS_GENERATOR_H
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    20
#define IPV4_ADDRESS_GENERATOR_H
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    21
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    22
#include "ns3/ipv4-address.h"
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    23
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    24
namespace ns3 {
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    25
3183
fc3b2e03e61e more doxygen
Tom Henderson <tomh@tomh.org>
parents: 2722
diff changeset
    26
/**
fc3b2e03e61e more doxygen
Tom Henderson <tomh@tomh.org>
parents: 2722
diff changeset
    27
 * \ingroup address
fc3b2e03e61e more doxygen
Tom Henderson <tomh@tomh.org>
parents: 2722
diff changeset
    28
 *
fc3b2e03e61e more doxygen
Tom Henderson <tomh@tomh.org>
parents: 2722
diff changeset
    29
 * \brief This generator assigns addresses sequentially from a provided
fc3b2e03e61e more doxygen
Tom Henderson <tomh@tomh.org>
parents: 2722
diff changeset
    30
 * network address; used in topology code.
fc3b2e03e61e more doxygen
Tom Henderson <tomh@tomh.org>
parents: 2722
diff changeset
    31
 */
2722
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    32
class Ipv4AddressGenerator {
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    33
public:
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    34
  static void Init (const Ipv4Address net, const Ipv4Mask mask, 
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    35
    const Ipv4Address addr = "0.0.0.1");
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    36
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    37
  static Ipv4Address NextNetwork (const Ipv4Mask mask);
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    38
  static Ipv4Address GetNetwork (const Ipv4Mask mask);
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    39
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    40
  static void InitAddress (const Ipv4Address addr, const Ipv4Mask mask);
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    41
  static Ipv4Address NextAddress (const Ipv4Mask mask);
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    42
  static Ipv4Address GetAddress (const Ipv4Mask mask);
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    43
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    44
  static void Reset (void);
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    45
  static bool AddAllocated (const Ipv4Address addr);
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    46
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    47
  static void TestMode (void);
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    48
};
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    49
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    50
}; // namespace ns3
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    51
f59635c9c679 address generator, address collision checker
Craig Dowell <craigdo@ee.washington.edu>
parents:
diff changeset
    52
#endif /* IPV4_ADDRESS_GENERATOR_H */