EMANE  1.2.1
commonlayerstatistics.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013-2014 - 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 EMANEUTILSCOMMONLAYERSTATISTICS_HEADER_
34 #define EMANEUTILSCOMMONLAYERSTATISTICS_HEADER_
35 
36 #include "emane/downstreampacket.h"
37 #include "emane/upstreampacket.h"
39 #include "emane/types.h"
40 
41 #include <memory>
42 
43 namespace EMANE
44 {
45  namespace Utils
46  {
53  {
54  public:
63  CommonLayerStatistics(const StatisticTableLabels & unicastDropTableLabels,
64  const StatisticTableLabels & broadcastDropTableLabels = {},
65  const std::string & sInstance = {});
66 
71 
80  void registerStatistics(StatisticRegistrar & statisticRegistrar);
81 
87  void processInbound(const UpstreamPacket & pkt);
88 
89 
97  void processOutbound(const UpstreamPacket & pkt, Microseconds delay, size_t dropCode = {});
98 
104  void processInbound(const DownstreamPacket & pkt);
105 
115  void processOutbound(const DownstreamPacket & pkt,
116  Microseconds delay,
117  size_t dropCode = {},
118  bool bSelfGenerated = {});
119 
120  private:
121  class Implementation;
122  std::unique_ptr<Implementation> pImpl_;
123 
125  CommonLayerStatistics & operator = (const CommonLayerStatistics &) = delete;
126  };
127  }
128 }
129 
130 
131 #endif // EMANEUTILSCOMMONLAYERSTATISTICS_HEADER_
A Packet class that allows upstream processing to strip layer headers as the packet travels up the st...
void processOutbound(const UpstreamPacket &pkt, Microseconds delay, size_t dropCode={})
Common NEM layer statistics and drop reason tables.
void registerStatistics(StatisticRegistrar &statisticRegistrar)
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::vector< std::string > StatisticTableLabels
Specialized packet the allows downstream processing to add layer specific headers as the packet trave...
std::chrono::microseconds Microseconds
Definition: types.h:45
void processInbound(const UpstreamPacket &pkt)
Definition: agent.h:43
CommonLayerStatistics(const StatisticTableLabels &unicastDropTableLabels, const StatisticTableLabels &broadcastDropTableLabels={}, const std::string &sInstance={})