EMANE  1.2.1
packetstatuspublisherimpl.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015-2016 - Adjacent Link LLC, Bridgewater, New Jersey
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  * * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in
13  * the documentation and/or other materials provided with the
14  * distribution.
15  * * Neither the name of Adjacent Link LLC nor the names of its
16  * contributors may be used to endorse or promote products derived
17  * from this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef EMANEMODELSTDMAPACKETSTATUSPUBLISHERIMPL_HEADER_
34 #define EMANEMODELSTDMAPACKETSTATUSPUBLISHERIMPL_HEADER_
35 
38 
39 #include <array>
40 #include <mutex>
41 #include <map>
42 
43 namespace EMANE
44 {
45  namespace Models
46  {
47  namespace TDMA
48  {
55  {
56  public:
58 
60 
61  void registerStatistics(StatisticRegistrar & registrar);
62 
63  void inbound(NEMId src,
64  const MessageComponent & component,
65  InboundAction action) override;
66 
67  void inbound(NEMId src,
68  const MessageComponents & components,
69  InboundAction action) override;
70 
71  void inbound(NEMId src,
72  NEMId dst,
73  Priority priority,
74  size_t size,
75  InboundAction action) override;
76 
77  void outbound(NEMId src,
78  NEMId dst,
79  Priority priority,
80  size_t size,
81  OutboundAction action) override;
82 
83  void outbound(NEMId src,
84  const MessageComponents & components,
85  OutboundAction action) override;
86 
87  private:
88  enum {QUEUE_COUNT = 5};
89 
90  using PacketAcceptInfo = std::map<NEMId,std::tuple<std::uint64_t, // bytes Tx
91  std::uint64_t>>; // bytes Rx
92 
93  using PacketDropInfo = std::map<NEMId,std::tuple<std::uint64_t, // SINR
94  std::uint64_t, // Reg Id
95  std::uint64_t, // Dst MAC
96  std::uint64_t, // Queue Overflow
97  std::uint64_t, // Bad Control
98  std::uint64_t, // Bad Spectrum Query
99  std::uint64_t, // Flow Control
100  std::uint64_t, // Too Big
101  std::uint64_t, // Too Long
102  std::uint64_t, // Frequency
103  std::uint64_t, // Slot Error
104  std::uint64_t>>; // Miss Fragment
105 
106  using TableArray = std::array<StatisticTable<NEMId> *,QUEUE_COUNT>;
107 
108  TableArray broadcastAcceptTables_;
109  TableArray broadcastDropTables_;
110 
111  TableArray unicastAcceptTables_;
112  TableArray unicastDropTables_;
113 
114  using AcceptInfoArrary = std::array<PacketAcceptInfo,QUEUE_COUNT>;
115  using DropInfoArrary = std::array<PacketDropInfo,QUEUE_COUNT>;
116 
117  AcceptInfoArrary broadcastAcceptInfos_;
118  DropInfoArrary broadcastDropInfos_;
119 
120  AcceptInfoArrary unicastAcceptInfos_;
121  DropInfoArrary unicastDropInfos_;
122 
123  std::mutex mutexBroadcastPacketAcceptTable_;
124  std::mutex mutexUnicastPacketAcceptTable_;
125  std::mutex mutexBroadcastPacketDropTable_;
126  std::mutex mutexUnicastPacketDropTable_;
127  };
128  }
129  }
130 }
131 
132 #endif // EMANEMODELSTDMAPACKETSTATUSPUBLISHERIMPL_HEADER_
void outbound(NEMId src, NEMId dst, Priority priority, size_t size, OutboundAction action) override
void inbound(NEMId src, const MessageComponent &component, InboundAction action) override
union EtherAddr dst
Definition: netutils.h:390
std::uint8_t Priority
Definition: types.h:64
The StatisticRegistrar allows NEM layers to register statistics and statistic tables. Statistics and Statistic tables are owned by the emulator framework and a borrowed reference is returned to the registering NEM layer.
std::list< MessageComponent > MessageComponents
std::uint16_t NEMId
Definition: types.h:52
Packet status interface used to publish statistics and tables showing accepted and rejected byte coun...
Implementation of PacketStatusPublisher.
union EtherAddr src
Definition: netutils.h:391
void registerStatistics(StatisticRegistrar &registrar)
Definition: agent.h:43
Holds a message component that may be all or part of a data or control message.