Agora C++ API Reference for All Platforms
signaling_engine_i.h
1 //
2 // Agora Media SDK
3 //
4 // Created by Sting Feng in 2015-05.
5 // Copyright (c) 2015 Agora IO. All rights reserved.
6 //
7 #pragma once
8 
9 #include <string>
10 
11 #include "IAgoraSignalingEngine.h"
12 
13 namespace agora {
14 namespace commons {
15 namespace cjson {
16 class JsonWrapper;
17 } // namespace cjson
18 } // namespace commons
19 
20 typedef agora::commons::cjson::JsonWrapper any_document_t;
21 
22 namespace signaling {
23 
24 enum class SIGNALING_EVENT
25 {
26  NATIVE_LOG = 100,
27  ERROR_EVENT = 101,
28  WARNING_EVENT = 102,
29 
30  API_CALL_EXECUTED = 1000,
31  PEER_JOIN_CHANNEL = 1001,
32  PEER_LEAVE_CHANNEL = 1002,
35  CONNECTION_LOST = 1005,
37  CONNECTION_RESTORED = 1007,
38 };
39 
40 class ISignalingEngineEventHandlerEx : public ISignalingEngineEventHandler
41 {
42 public:
43  virtual bool onEvent(SIGNALING_EVENT evt, std::string* payload) {
44  (void)evt;
45  (void)payload;
46 
47  /* return false to indicate this event is not handled */
48  return false;
49  }
50 };
51 
52 class ISignalingEngineEx : public ISignalingEngine
53 {
54 public:
55  virtual int setParameters(const char* parameters) = 0;
56  virtual int getParameters(const char* key, any_document_t& result) = 0;
57 };
58 
59 } // namespace signaling
60 } // namespace agora
agora::signaling::ISignalingEngineEx::getParameters
virtual int getParameters(const char *key, any_document_t &result)=0
agora::any_document_t
agora::commons::cjson::JsonWrapper any_document_t
Definition: agora_service_i.h:52
agora::signaling::ISignalingEngineEventHandlerEx::onEvent
virtual bool onEvent(SIGNALING_EVENT evt, std::string *payload)
Definition: signaling_engine_i.h:43
agora::signaling::ISignalingEngineEx
Definition: signaling_engine_i.h:53
agora::signaling::SIGNALING_EVENT::PEER_LEAVE_CHANNEL
@ PEER_LEAVE_CHANNEL
agora
Definition: AgoraAtomicOps.h:21
agora::signaling::SIGNALING_EVENT::CONNECTION_INTERRUPTED
@ CONNECTION_INTERRUPTED
agora::signaling::SIGNALING_EVENT
SIGNALING_EVENT
Definition: signaling_engine_i.h:25
agora::signaling::SIGNALING_EVENT::PEER_JOIN_CHANNEL
@ PEER_JOIN_CHANNEL
agora::signaling::SIGNALING_EVENT::CONNECTION_RESTORED
@ CONNECTION_RESTORED
agora::signaling::SIGNALING_EVENT::ERROR_EVENT
@ ERROR_EVENT
agora::signaling::SIGNALING_EVENT::CONNECTION_LOST
@ CONNECTION_LOST
agora::signaling::SIGNALING_EVENT::CHANNEL_PEER_LIST_UPDATED
@ CHANNEL_PEER_LIST_UPDATED
agora::signaling::SIGNALING_EVENT::API_CALL_EXECUTED
@ API_CALL_EXECUTED
agora::signaling::SIGNALING_EVENT::CHANNEL_ATTRIBUTES_UPDATED
@ CHANNEL_ATTRIBUTES_UPDATED
agora::signaling::ISignalingEngineEventHandlerEx
Definition: signaling_engine_i.h:41
agora::signaling::SIGNALING_EVENT::NATIVE_LOG
@ NATIVE_LOG
agora::signaling::ISignalingEngineEx::setParameters
virtual int setParameters(const char *parameters)=0
agora::signaling::SIGNALING_EVENT::WARNING_EVENT
@ WARNING_EVENT