blob: c7a561355c750dd0e480927176329d8b740e3216 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
/*
* Copyright (c) 2017 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __VOM_EVENT_CMD_H__
#define __VOM_EVENT_CMD_H__
#include <mutex>
#include "vom/rpc_cmd.hpp"
#include <vapi/vapi.hpp>
namespace VOM {
/**
* An Event command base class.
* Events are one of the sub-set of command type to VPP.
* A client performs a one time 'registration/subsription' to VPP for the
* event in question and then is notified asynchronously when those events
* occur.
* The model here then is that the lifetime of the event command represensts
* the during of the clients subscription. When the command is 'issued' the
* subscription begins, when it is 'retired' the subscription ends. For the
* subscription duration the client will be notified as events are recieved.
* The client can then 'pop' these events from this command object.
*/
template <typename WANT, typename EVENT>
class event_cmd : public rpc_cmd<HW::item<bool>, WANT>
{
public:
/**
* Default constructor
*/
event_cmd(HW::item<bool>& b)
: rpc_cmd<HW::item<bool>, WANT>(b)
{
}
/**
* Default destructor
*/
virtual ~event_cmd() {}
/**
* Typedef for the event type
*/
typedef typename vapi::Event_registration<EVENT>::resp_type event_t;
typedef typename vapi::Event_registration<EVENT> reg_t;
typedef typename vapi::Result_set<typename reg_t::resp_type>::const_iterator
const_iterator;
const_iterator begin() { return (m_reg->get_result_set().begin()); }
const_iterator end() { return (m_reg->get_result_set().end()); }
void lock() { m_mutex.lock(); }
void unlock() { m_mutex.unlock(); }
/**
* flush/free all the events thus far reeived.
* Call with the lock held!
*/
void flush() { m_reg->get_result_set().free_all_responses(); }
/**
* Retire the command. This is only appropriate for Event Commands
* As they persist until retired.
*/
virtual void retire(connection& con) = 0;
vapi_error_e operator()(reg_t& dl)
{
notify();
return (VAPI_OK);
}
protected:
/**
* Notify the command that data from VPP has arrived and been stored.
* The command should now inform its clients/listeners.
*/
virtual void notify() = 0;
/**
* The VAPI event registration
*/
std::unique_ptr<vapi::Event_registration<EVENT>> m_reg;
/**
* Mutex protection for the events
*/
std::mutex m_mutex;
};
};
/*
* fd.io coding-style-patch-verification: OFF
*
* Local Variables:
* eval: (c-set-style "mozilla")
* End:
*/
#endif
|
