/* * Copyright 2013 The WebRTC project authors. All Rights Reserved. * * Use of this source code is governed by a BSD-style license * that can be found in the LICENSE file in the root of the source * tree. An additional intellectual property rights grant can be found * in the file PATENTS. All contributing project authors may * be found in the AUTHORS file in the root of the source tree. */ // This file contains Macros for creating proxies for webrtc MediaStream and // PeerConnection classes. // The proxied objects are initialized with either one or two thread // objects that operations can be proxied to: The primary and secondary // threads. // In common usage, the primary thread will be the PeerConnection's // signaling thread, and the secondary thread will be either the // PeerConnection's worker thread or the PeerConnection's network thread. // // Example usage: // // class TestInterface : public RefCountInterface { // public: // std::string FooA() = 0; // std::string FooB(bool arg1) const = 0; // std::string FooC(bool arg1) = 0; // }; // // Note that return types can not be a const reference. // // class Test : public TestInterface { // ... implementation of the interface. // }; // // BEGIN_PROXY_MAP(Test) // PROXY_PRIMARY_THREAD_DESTRUCTOR() // PROXY_METHOD0(std::string, FooA) // PROXY_CONSTMETHOD1(std::string, FooB, arg1) // PROXY_SECONDARY_METHOD1(std::string, FooC, arg1) // END_PROXY_MAP() // // Where the destructor and first two methods are invoked on the primary // thread, and the third is invoked on the secondary thread. // // The proxy can be created using // // TestProxy::Create(Thread* signaling_thread, Thread* worker_thread, // TestInterface*). // // The variant defined with BEGIN_PRIMARY_PROXY_MAP is unaware of // the secondary thread, and invokes all methods on the primary thread. // #ifndef PC_PROXY_H_ #define PC_PROXY_H_ #include <stddef.h> #include <memory> #include <string> #include <tuple> #include <type_traits> #include <utility> #include "api/scoped_refptr.h" #include "api/task_queue/task_queue_base.h" #include "rtc_base/event.h" #include "rtc_base/string_utils.h" #include "rtc_base/system/rtc_export.h" #include "rtc_base/thread.h" #include "rtc_base/trace_event.h" #if !defined(RTC_DISABLE_PROXY_TRACE_EVENTS) && !defined(WEBRTC_CHROMIUM_BUILD) #define RTC_DISABLE_PROXY_TRACE_EVENTS #endif namespace webrtc { template <typename R> class ReturnType { … }; template <> class ReturnType<void> { … }; template <typename C, typename R, typename... Args> class MethodCall { … }; template <typename C, typename R, typename... Args> class ConstMethodCall { … }; #define PROXY_STRINGIZE_IMPL(x) … #define PROXY_STRINGIZE(x) … // Helper macros to reduce code duplication. #define PROXY_MAP_BOILERPLATE(class_name) … // clang-format off // clang-format would put the semicolon alone, // leading to a presubmit error (cpplint.py) #define END_PROXY_MAP(class_name) … // clang-format on #define PRIMARY_PROXY_MAP_BOILERPLATE(class_name) … #define SECONDARY_PROXY_MAP_BOILERPLATE(class_name) … // Note that the destructor is protected so that the proxy can only be // destroyed via RefCountInterface. #define REFCOUNTED_PROXY_MAP_BOILERPLATE(class_name) … // Note: This doesn't use a unique_ptr, because it intends to handle a corner // case where an object's deletion triggers a callback that calls back into // this proxy object. If relying on a unique_ptr to delete the object, its // inner pointer would be set to null before this reentrant callback would have // a chance to run, resulting in a segfault. #define OWNED_PROXY_MAP_BOILERPLATE(class_name) … #define BEGIN_PRIMARY_PROXY_MAP(class_name) … #define BEGIN_PROXY_MAP(class_name) … #define PROXY_PRIMARY_THREAD_DESTRUCTOR() … #define PROXY_SECONDARY_THREAD_DESTRUCTOR() … #if defined(RTC_DISABLE_PROXY_TRACE_EVENTS) #define TRACE_BOILERPLATE … #else // if defined(RTC_DISABLE_PROXY_TRACE_EVENTS) #define TRACE_BOILERPLATE(method) … #endif // if defined(RTC_DISABLE_PROXY_TRACE_EVENTS) #define PROXY_METHOD0(r, method) … #define PROXY_CONSTMETHOD0(r, method) … #define PROXY_METHOD1(r, method, t1) … #define PROXY_CONSTMETHOD1(r, method, t1) … #define PROXY_METHOD2(r, method, t1, t2) … #define PROXY_METHOD3(r, method, t1, t2, t3) … #define PROXY_METHOD4(r, method, t1, t2, t3, t4) … #define PROXY_METHOD5(r, method, t1, t2, t3, t4, t5) … // Define methods which should be invoked on the secondary thread. #define PROXY_SECONDARY_METHOD0(r, method) … #define PROXY_SECONDARY_CONSTMETHOD0(r, method) … #define PROXY_SECONDARY_METHOD1(r, method, t1) … #define PROXY_SECONDARY_CONSTMETHOD1(r, method, t1) … #define PROXY_SECONDARY_METHOD2(r, method, t1, t2) … #define PROXY_SECONDARY_CONSTMETHOD2(r, method, t1, t2) … #define PROXY_SECONDARY_METHOD3(r, method, t1, t2, t3) … #define PROXY_SECONDARY_CONSTMETHOD3(r, method, t1, t2) … // For use when returning purely const state (set during construction). // Use with caution. This method should only be used when the return value will // always be the same. #define BYPASS_PROXY_CONSTMETHOD0(r, method) … // Allows a custom implementation of a method where the otherwise proxied // implementation can do a more efficient, yet thread-safe, job than the proxy // can do by default or when more flexibility is needed than can be provided // by a proxy. // Note that calls to these methods should be expected to be made from unknown // threads. #define BYPASS_PROXY_METHOD0(r, method) … // The 1 argument version of `BYPASS_PROXY_METHOD0`. #define BYPASS_PROXY_METHOD1(r, method, t1) … // The 2 argument version of `BYPASS_PROXY_METHOD0`. #define BYPASS_PROXY_METHOD2(r, method, t1, t2) … } // namespace webrtc #endif // PC_PROXY_H_
Codebase Browser
chromium