A Discrete-Event Network Simulator
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2011 UPB
4  * Copyright (c) 2017 NITK Surathkal
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation;
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Author: Radu Lupu <rlupu@elcom.pub.ro>
20  * Ankit Deepak <adadeepak8@gmail.com>
21  * Deepti Rajagopal <deeptir96@gmail.com>
22  *
23  */
25 #ifndef DHCP_HEADER_H
26 #define DHCP_HEADER_H
28 #include "ns3/header.h"
30 namespace ns3 {
81 class DhcpHeader : public Header
82 {
83 public:
88  static TypeId GetTypeId (void);
93  DhcpHeader ();
98  ~DhcpHeader ();
101  enum Options
102  {
103  OP_MASK = 1,
104  OP_ROUTE = 3,
105  OP_ADDREQ = 50,
106  OP_LEASE = 51,
107  OP_MSGTYPE = 53,
108  OP_SERVID = 54,
109  OP_RENEW = 58,
110  OP_REBIND = 59,
111  OP_END = 255
112  };
115  enum Messages
116  {
118  DHCPOFFER = 1,
119  DHCPREQ = 2,
120  DHCPACK = 4,
121  DHCPNACK = 5
122  };
128  void SetType (uint8_t type);
134  uint8_t GetType (void) const;
141  void SetHWType (uint8_t htype, uint8_t hlen);
147  void SetTran (uint32_t tran);
153  uint32_t GetTran (void) const;
158  void SetTime ();
167  void SetChaddr (Address addr);
174  void SetChaddr (uint8_t* addr, uint8_t len);
183  Address GetChaddr (void);
189  void SetYiaddr (Ipv4Address addr);
195  Ipv4Address GetYiaddr (void) const;
201  void SetDhcps (Ipv4Address addr);
207  Ipv4Address GetDhcps (void) const;
213  void SetReq (Ipv4Address addr);
219  Ipv4Address GetReq (void) const;
225  void SetMask (uint32_t addr);
231  uint32_t GetMask (void) const;
237  void SetRouter (Ipv4Address addr);
243  Ipv4Address GetRouter (void) const;
249  void SetLease (uint32_t time);
255  uint32_t GetLease (void) const;
261  void SetRenew (uint32_t time);
267  uint32_t GetRenew (void) const;
273  void SetRebind (uint32_t time);
279  uint32_t GetRebind (void) const;
284  void ResetOpt ();
286 private:
287  virtual TypeId GetInstanceTypeId (void) const;
288  virtual void Print (std::ostream &os) const;
289  virtual uint32_t GetSerializedSize (void) const;
290  virtual void Serialize (Buffer::Iterator start) const;
291  virtual uint32_t Deserialize (Buffer::Iterator start);
293  uint8_t m_op;
294  uint8_t m_bootp;
295  uint8_t m_hType;
296  uint8_t m_hLen;
297  uint8_t m_hops;
298  uint32_t m_xid;
299  uint32_t m_mask;
300  uint32_t m_len;
301  uint16_t m_secs;
302  uint16_t m_flags;
303  uint8_t m_chaddr[16];
311  uint8_t m_sname[64];
312  uint8_t m_file[128];
313  uint8_t m_magic_cookie[4];
314  uint32_t m_lease;
315  uint32_t m_renew;
316  uint32_t m_rebind;
317  bool m_opt[255];
318 };
320 } // namespace ns3
322 #endif /* DHCP_HEADER_H */
Protocol header serialization and deserialization.
Definition: header.h:42
BOOTP Option 255: END.
Definition: dhcp-header.h:111
Ipv4Address m_ciAddr
The IP address of the client.
Definition: dhcp-header.h:305
void SetTime()
Set the time when message is sent.
Definition: dhcp-header.cc:106
BOOTP Option 58: Address Renewal Time.
Definition: dhcp-header.h:109
Ipv4Address m_giAddr
Relay Agent IP address.
Definition: dhcp-header.h:307
virtual void Serialize(Buffer::Iterator start) const
Definition: dhcp-header.cc:283
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
Definition: dhcp-header.cc:272
static TypeId GetTypeId(void)
Get the type ID.
Definition: dhcp-header.cc:262
uint32_t m_renew
The renewal time for the client.
Definition: dhcp-header.h:315
def start()
Definition: core.py:1855
Code for DHCP NACK.
Definition: dhcp-header.h:121
uint32_t m_rebind
The rebinding time for the client.
Definition: dhcp-header.h:316
uint32_t GetMask(void) const
Return the mask of the network.
Definition: dhcp-header.cc:182
void SetYiaddr(Ipv4Address addr)
Set the IPv4Address of the client.
Definition: dhcp-header.cc:132
Ipv4Address m_yiAddr
Your (client) IP address.
Definition: dhcp-header.h:304
DHCP messages.
Definition: dhcp-header.h:115
BOOTP Option 51: Address Lease Time.
Definition: dhcp-header.h:106
Ipv4Address m_route
Router Option Address.
Definition: dhcp-header.h:310
uint32_t m_lease
The lease time of the address.
Definition: dhcp-header.h:314
Address GetChaddr(void)
Get the Address of the client.
Definition: dhcp-header.cc:125
uint8_t GetType(void) const
Return the type of DHCP message.
Definition: dhcp-header.cc:85
Ipv4Address GetRouter(void) const
Return the Ipv4Address of gateway to be used.
Definition: dhcp-header.cc:197
void SetType(uint8_t type)
Set the type of BOOTP and DHCP messages.
Definition: dhcp-header.cc:74
Ipv4Address m_dhcps
DHCP server IP address.
Definition: dhcp-header.h:308
uint32_t GetRebind(void) const
Return the Rebind time of the address.
Definition: dhcp-header.cc:242
iterator in a Buffer instance
Definition: buffer.h:98
a polymophic address class
Definition: address.h:90
uint8_t m_hType
The hardware type.
Definition: dhcp-header.h:295
Ipv4Address GetReq(void) const
Get the IPv4Address requested by the client.
Definition: dhcp-header.cc:167
void SetHWType(uint8_t htype, uint8_t hlen)
Set the hardware information.
Definition: dhcp-header.cc:90
uint32_t GetTran(void) const
Get the transaction id.
Definition: dhcp-header.cc:101
Ipv4Address m_req
Requested Address.
Definition: dhcp-header.h:309
void SetTran(uint32_t tran)
Set the transaction ID.
Definition: dhcp-header.cc:96
uint8_t m_hLen
The hardware length.
Definition: dhcp-header.h:296
BOOTP Option 53: DHCP Message Type.
Definition: dhcp-header.h:107
Ipv4Address m_siAddr
Next Server IP address.
Definition: dhcp-header.h:306
BOOTP Option 50: Requested Address.
Definition: dhcp-header.h:105
BOOTP header with DHCP messages supports the following options: Subnet Mask (1), Address Request (50)...
Definition: dhcp-header.h:81
uint32_t m_len
The length of the header.
Definition: dhcp-header.h:300
virtual void Print(std::ostream &os) const
Definition: dhcp-header.cc:277
Ipv4Address GetYiaddr(void) const
Get the IPv4Address of the client.
Definition: dhcp-header.cc:137
void SetReq(Ipv4Address addr)
Set the Ipv4Address requested by the client.
Definition: dhcp-header.cc:157
uint8_t m_op
The DHCP Message type.
Definition: dhcp-header.h:293
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void SetChaddr(Address addr)
Set the Address of the device.
Definition: dhcp-header.cc:111
BOOTP Option 59: Address Rebind Time.
Definition: dhcp-header.h:110
uint8_t m_file[128]
File name (Padded for now)
Definition: dhcp-header.h:312
bool m_opt[255]
BOOTP option list.
Definition: dhcp-header.h:317
Definition: dhcp-header.cc:36
virtual uint32_t GetSerializedSize(void) const
Definition: dhcp-header.cc:257
BOOTP Option 1: Address Mask.
Definition: dhcp-header.h:103
Code for DHCP Offer.
Definition: dhcp-header.h:118
void ResetOpt()
Reset the BOOTP options.
Definition: dhcp-header.cc:247
uint8_t m_magic_cookie[4]
DHCP Magic Cookie.
Definition: dhcp-header.h:313
void SetDhcps(Ipv4Address addr)
Set the DHCP server information.
Definition: dhcp-header.cc:142
Code for DHCP ACK.
Definition: dhcp-header.h:120
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:41
uint32_t m_xid
The transaction number.
Definition: dhcp-header.h:298
uint8_t m_hops
The number of hops covered by the message.
Definition: dhcp-header.h:297
Ipv4Address GetDhcps(void) const
Get the information about the DHCP server.
Definition: dhcp-header.cc:152
BOOTP options.
Definition: dhcp-header.h:101
uint16_t m_secs
Seconds elapsed.
Definition: dhcp-header.h:301
Definition: dhcp-header.cc:70
void SetLease(uint32_t time)
Set the lease time of the IPv4Address.
Definition: dhcp-header.cc:202
uint8_t m_sname[64]
Server name (Padded for now)
Definition: dhcp-header.h:311
uint32_t m_mask
The mask of the network.
Definition: dhcp-header.h:299
void SetRenew(uint32_t time)
Set the Renewal time of the IPv4Address.
Definition: dhcp-header.cc:217
Code for DHCP Request.
Definition: dhcp-header.h:119
void SetMask(uint32_t addr)
Set the mask of the IPv4Address.
Definition: dhcp-header.cc:172
BOOTP Option 54: Server Identifier.
Definition: dhcp-header.h:108
a unique identifier for an interface.
Definition: type-id.h:58
uint32_t GetLease(void) const
Return the lease time of the IPv4Address.
Definition: dhcp-header.cc:212
BOOTP Option 3: Router Option.
Definition: dhcp-header.h:104
uint16_t m_flags
BOOTP flags.
Definition: dhcp-header.h:302
Code for DHCP Discover.
Definition: dhcp-header.h:117
uint32_t GetRenew(void) const
Return the Renewal time of the address.
Definition: dhcp-header.cc:227
uint8_t m_chaddr[16]
The address identifier.
Definition: dhcp-header.h:303
void SetRouter(Ipv4Address addr)
Set the Ipv4Address of gateway to be used.
Definition: dhcp-header.cc:187
uint8_t m_bootp
The BOOTP Message type.
Definition: dhcp-header.h:294
virtual uint32_t Deserialize(Buffer::Iterator start)
Definition: dhcp-header.cc:352
void SetRebind(uint32_t time)
Set the Rebind time of the IPv4Address.
Definition: dhcp-header.cc:232