mirror of
https://github.com/mollyim/webrtc.git
synced 2025-05-13 13:50:40 +01:00
abdb470d00
As documented in webrtc:11908 this cleanup is fairly invasive and when a part of a frequently executed code path, can be quite costly in terms of performance overhead. This is currently the case with synchronous calls between threads (Thread) as well with our proxy api classes. With this CL, all code in WebRTC should now either be using MessageHandlerAutoCleanup or calling MessageHandler(false) explicitly. Next steps will be to update external code to either depend on the AutoCleanup variant, or call MessageHandler(false). Changing the proxy classes to use TaskQueue set of concepts instead of MessageHandler. This avoids the perf overhead related to the cleanup above as well as incompatibility with the thread policy checks in Thread that some current external users of the proxies would otherwise run into (if we were to use Thread::Send() for synchronous call). Following this we'll move the cleanup step into the AutoCleanup class and an RTC_DCHECK that all calls to the MessageHandler are setting the flag to false, before eventually removing the flag and make MessageHandler pure virtual. Bug: webrtc:11908 Change-Id: Idf4ff9bcc8438cb8c583777e282005e0bc511c8f Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/183442 Reviewed-by: Artem Titov <titovartem@webrtc.org> Commit-Queue: Tommi <tommi@webrtc.org> Cr-Commit-Position: refs/heads/master@{#32049}
63 lines
2 KiB
C++
63 lines
2 KiB
C++
/*
|
|
* Copyright 2004 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.
|
|
*/
|
|
|
|
#ifndef RTC_BASE_MESSAGE_HANDLER_H_
|
|
#define RTC_BASE_MESSAGE_HANDLER_H_
|
|
|
|
#include <utility>
|
|
|
|
#include "api/function_view.h"
|
|
#include "rtc_base/constructor_magic.h"
|
|
#include "rtc_base/system/rtc_export.h"
|
|
|
|
namespace rtc {
|
|
|
|
struct Message;
|
|
|
|
// MessageQueue/Thread Messages get dispatched to a MessageHandler via the
|
|
// |OnMessage()| callback method.
|
|
//
|
|
// Note: Besides being an interface, the class can perform automatic cleanup
|
|
// in the destructor.
|
|
// TODO(bugs.webrtc.org/11908): The |auto_cleanup| parameter and associated
|
|
// logic is a temporary step while changing the MessageHandler class to be
|
|
// a pure virtual interface. The automatic cleanup step involves a number of
|
|
// complex operations and as part of this interface, can easily go by unnoticed
|
|
// and bundled into situations where it's not needed.
|
|
class RTC_EXPORT MessageHandler {
|
|
public:
|
|
virtual ~MessageHandler();
|
|
virtual void OnMessage(Message* msg) = 0;
|
|
|
|
protected:
|
|
// TODO(bugs.webrtc.org/11908): The |auto_cleanup| parameter needs to have a
|
|
// backwards compatible default value while external code is being updated.
|
|
explicit MessageHandler(bool auto_cleanup = true)
|
|
: auto_cleanup_(auto_cleanup) {}
|
|
|
|
private:
|
|
RTC_DISALLOW_COPY_AND_ASSIGN(MessageHandler);
|
|
const bool auto_cleanup_;
|
|
};
|
|
|
|
class RTC_EXPORT MessageHandlerAutoCleanup : public MessageHandler {
|
|
public:
|
|
~MessageHandlerAutoCleanup() override;
|
|
|
|
protected:
|
|
MessageHandlerAutoCleanup() : MessageHandler(true) {}
|
|
|
|
private:
|
|
RTC_DISALLOW_COPY_AND_ASSIGN(MessageHandlerAutoCleanup);
|
|
};
|
|
|
|
} // namespace rtc
|
|
|
|
#endif // RTC_BASE_MESSAGE_HANDLER_H_
|