EMANE  1.2.1
basicqueuemanager.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 - 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 EMANEMODELSTDMABASICQUEUEMANAGER_HEADER_
34 #define EMANEMODELSTDMABASICQUEUEMANAGER_HEADER_
35 
37 
38 namespace EMANE
39 {
40  namespace Models
41  {
42  namespace TDMA
43  {
50  {
51  public:
53  PlatformServiceProvider * pPlatformServiceProvider);
54 
56 
57  void initialize(Registrar & registrar) override;
58 
59  void configure(const ConfigurationUpdate & update) override;
60 
61  void start() override;
62 
63  void postStart() override;
64 
65  void stop() override;
66 
67  void destroy() throw() override;
68 
69  size_t enqueue(std::uint8_t u8QueueIndex, DownstreamPacket && pkt) override;
70 
72  size_t>
73  dequeue(std::uint8_t u8QueueIndex,
74  size_t length,
75  NEMId destination) override;
76 
77  QueueInfos getPacketQueueInfo() const override;
78 
79  private:
80  class Implementation;
81  std::unique_ptr<Implementation> pImpl_;
82  };
83  }
84  }
85 }
86 
87 
88 #endif // EMANEMODELSTDMABASICQUEUEMANAGER_HEADER_
The Registrar interface provides access to all of the emulator registrars.
Definition: registrar.h:50
void configure(const ConfigurationUpdate &update) override
Reference QueueManager implementation.
The PlatformServiceProvider interface provides access to emulator services.
QueueInfos getPacketQueueInfo() const override
size_t enqueue(std::uint8_t u8QueueIndex, DownstreamPacket &&pkt) override
std::vector< QueueInfo > QueueInfos
Specialized packet the allows downstream processing to add layer specific headers as the packet trave...
std::list< MessageComponent > MessageComponents
std::uint16_t NEMId
Definition: types.h:52
Queue management interface used by BaseModel
Definition: queuemanager.h:57
void initialize(Registrar &registrar) override
std::vector< ConfigurationNameAnyValues > ConfigurationUpdate
BasicQueueManager(NEMId id, PlatformServiceProvider *pPlatformServiceProvider)
std::tuple< EMANE::Models::TDMA::MessageComponents, size_t > dequeue(std::uint8_t u8QueueIndex, size_t length, NEMId destination) override
Definition: agent.h:43