blob: b607fd8d618ae2a2f89aa4c209a72f957a196a91 (
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
|
/*
* Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0/
*
* or in the "license" file accompanying this file. This file 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 VSHL_COMMON_INTERFACES_AFBAPI_H_
#define VSHL_COMMON_INTERFACES_AFBAPI_H_
#include <memory>
#include <string>
#include <json-c/json_object.h>
using namespace std;
namespace vshlcapabilities {
namespace common {
namespace interfaces {
/**
* Interface to represent AFB Request.
*/
class IAFBRequest {
public:
/**
* Gets the native request object.
*/
virtual void* getNativeRequest() = 0;
};
/**
* Interface to encapsulate all AFB (AGL Application Framework Binding)
* functions.
*/
class IAFBApi {
public:
/**
* Interface to represent AFB Event
*/
class IAFBEvent {
public:
/**
* Gets human readable name of the event.
*/
virtual std::string getName() const = 0;
/**
* Returns true if event is valid. False otherwise.
*/
virtual bool isValid() = 0;
/**
* Publish event to all observers.
*
* @return The number of observers that received the event.
*/
virtual int publishEvent(struct json_object* payload) = 0;
/**
* Subscribe to the event
*
* @c request Party interested in the event.
*/
virtual bool subscribe(IAFBRequest& request) = 0;
/**
* Unsubscribe to the event
*
* @c request Party no longer interested in the event.
*/
virtual bool unsubscribe(IAFBRequest& request) = 0;
};
virtual std::shared_ptr<IAFBEvent> createEvent(const std::string& eventName) = 0;
virtual int callSync(
const std::string& api,
const std::string& verb,
struct json_object* request,
struct json_object** result,
std::string& error,
std::string& info) = 0;
};
} // namespace interfaces
} // namespace common
} // namespace vshl
#endif // VSHL_COMMON_INTERFACES_AFBAPI_H_
|
