blob: 11788f04bfe68308586c9a0b9a34f4f3238f5a82 [file] [log] [blame]
Junxiao Shi77dcadd2014-10-05 14:40:54 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
Junxiao Shie3ef6ee2014-10-05 14:40:54 -07003 * Copyright (c) 2014, Regents of the University of California,
4 * Arizona Board of Regents,
5 * Colorado State University,
6 * University Pierre & Marie Curie, Sorbonne University,
7 * Washington University in St. Louis,
8 * Beijing Institute of Technology,
9 * The University of Memphis
Junxiao Shi77dcadd2014-10-05 14:40:54 -070010 *
11 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
12 *
13 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
14 * terms of the GNU Lesser General Public License as published by the Free Software
15 * Foundation, either version 3 of the License, or (at your option) any later version.
16 *
17 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
18 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
19 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
20 *
21 * You should have received copies of the GNU General Public License and GNU Lesser
22 * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
23 * <http://www.gnu.org/licenses/>.
24 *
25 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
26 */
27
28#ifndef NDN_UTIL_ETHERNET_HPP
29#define NDN_UTIL_ETHERNET_HPP
30
Vince Lehman8991bb52014-10-15 16:16:01 -050031#include "../common.hpp"
Junxiao Shi77dcadd2014-10-05 14:40:54 -070032
33#include <boost/array.hpp>
34
35namespace ndn {
36namespace util {
37namespace ethernet {
38
39static const uint16_t ETHERTYPE_NDN = 0x8624;
40
41const size_t ADDR_LEN = 6; ///< Octets in one Ethernet address
42const size_t TYPE_LEN = 2; ///< Octets in Ethertype field
43const size_t HDR_LEN = 14; ///< Total octets in Ethernet header (without 802.1Q tag)
44const size_t TAG_LEN = 4; ///< Octets in 802.1Q tag (TPID + priority + VLAN)
45const size_t MIN_DATA_LEN = 46; ///< Min octets in Ethernet payload (assuming no 802.1Q tag)
46const size_t MAX_DATA_LEN = 1500; ///< Max octets in Ethernet payload
47const size_t CRC_LEN = 4; ///< Octets in Ethernet frame check sequence
48
49
50/** \brief represents an Ethernet hardware address
51 */
52class Address : public boost::array<uint8_t, ADDR_LEN>
53{
54public:
55 /// Constructs a null Ethernet address (00:00:00:00:00:00)
56 Address();
57
58 /// Constructs a new Ethernet address with the given octets
59 Address(uint8_t a1, uint8_t a2, uint8_t a3,
60 uint8_t a4, uint8_t a5, uint8_t a6);
61
62 /// Constructs a new Ethernet address with the given octets
63 explicit
64 Address(const uint8_t octets[ADDR_LEN]);
65
66 /// Copy constructor
67 Address(const Address& address);
68
69 /// True if this is a broadcast address (ff:ff:ff:ff:ff:ff)
70 bool
71 isBroadcast() const;
72
73 /// True if this is a multicast address
74 bool
75 isMulticast() const;
76
77 /// True if this is a null address (00:00:00:00:00:00)
78 bool
79 isNull() const;
80
81 /**
82 * \brief Converts the address to a human-readable string
83 *
84 * \param sep A character used to visually separate the octets,
85 * usually ':' (the default value) or '-'
86 */
87 std::string
88 toString(char sep = ':') const;
89
90 /**
91 * \brief Creates an Address from a string containing an Ethernet address
92 * in hexadecimal notation, with colons or hyphens as separators
93 *
94 * \param str The string to be parsed
95 * \return Always an instance of Address, which will be null
96 * if the parsing fails
97 */
98 static Address
99 fromString(const std::string& str);
100};
101
102/// Returns the Ethernet broadcast address (ff:ff:ff:ff:ff:ff)
103Address
104getBroadcastAddress();
105
106/// Returns the default Ethernet multicast address for NDN
107Address
108getDefaultMulticastAddress();
109
110std::ostream&
111operator<<(std::ostream& o, const Address& a);
112
113} // namespace ethernet
114} // namespace util
115} // namespace ndn
116
117#endif // NDN_UTIL_ETHERNET_HPP