henrike@webrtc.org | f048872 | 2014-05-13 18:00:26 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2004 The WebRTC Project Authors. All rights reserved. |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license |
| 5 | * that can be found in the LICENSE file in the root of the source |
| 6 | * tree. An additional intellectual property rights grant can be found |
| 7 | * in the file PATENTS. All contributing project authors may |
| 8 | * be found in the AUTHORS file in the root of the source tree. |
| 9 | */ |
| 10 | |
Steve Anton | 10542f2 | 2019-01-11 09:11:00 -0800 | [diff] [blame] | 11 | #ifndef RTC_BASE_MESSAGE_HANDLER_H_ |
| 12 | #define RTC_BASE_MESSAGE_HANDLER_H_ |
henrike@webrtc.org | f048872 | 2014-05-13 18:00:26 +0000 | [diff] [blame] | 13 | |
Henrik Kjellander | ec78f1c | 2017-06-29 07:52:50 +0200 | [diff] [blame] | 14 | #include <utility> |
kwiberg | 0eb15ed | 2015-12-17 03:04:15 -0800 | [diff] [blame] | 15 | |
Danil Chapovalov | b877e71 | 2019-11-29 15:19:27 +0100 | [diff] [blame] | 16 | #include "api/function_view.h" |
Steve Anton | 10542f2 | 2019-01-11 09:11:00 -0800 | [diff] [blame] | 17 | #include "rtc_base/constructor_magic.h" |
Mirko Bonadei | 35214fc | 2019-09-23 14:54:28 +0200 | [diff] [blame] | 18 | #include "rtc_base/system/rtc_export.h" |
Henrik Kjellander | ec78f1c | 2017-06-29 07:52:50 +0200 | [diff] [blame] | 19 | |
| 20 | namespace rtc { |
| 21 | |
| 22 | struct Message; |
| 23 | |
Tomas Gunnarsson | abdb470 | 2020-09-05 18:43:36 +0200 | [diff] [blame^] | 24 | // MessageQueue/Thread Messages get dispatched to a MessageHandler via the |
| 25 | // |OnMessage()| callback method. |
| 26 | // |
| 27 | // Note: Besides being an interface, the class can perform automatic cleanup |
| 28 | // in the destructor. |
| 29 | // TODO(bugs.webrtc.org/11908): The |auto_cleanup| parameter and associated |
| 30 | // logic is a temporary step while changing the MessageHandler class to be |
| 31 | // a pure virtual interface. The automatic cleanup step involves a number of |
| 32 | // complex operations and as part of this interface, can easily go by unnoticed |
| 33 | // and bundled into situations where it's not needed. |
Mirko Bonadei | 35214fc | 2019-09-23 14:54:28 +0200 | [diff] [blame] | 34 | class RTC_EXPORT MessageHandler { |
Henrik Kjellander | ec78f1c | 2017-06-29 07:52:50 +0200 | [diff] [blame] | 35 | public: |
| 36 | virtual ~MessageHandler(); |
| 37 | virtual void OnMessage(Message* msg) = 0; |
| 38 | |
| 39 | protected: |
Tomas Gunnarsson | abdb470 | 2020-09-05 18:43:36 +0200 | [diff] [blame^] | 40 | // TODO(bugs.webrtc.org/11908): The |auto_cleanup| parameter needs to have a |
| 41 | // backwards compatible default value while external code is being updated. |
| 42 | explicit MessageHandler(bool auto_cleanup = true) |
| 43 | : auto_cleanup_(auto_cleanup) {} |
Henrik Kjellander | ec78f1c | 2017-06-29 07:52:50 +0200 | [diff] [blame] | 44 | |
| 45 | private: |
| 46 | RTC_DISALLOW_COPY_AND_ASSIGN(MessageHandler); |
Tomas Gunnarsson | abdb470 | 2020-09-05 18:43:36 +0200 | [diff] [blame^] | 47 | const bool auto_cleanup_; |
| 48 | }; |
| 49 | |
| 50 | class RTC_EXPORT MessageHandlerAutoCleanup : public MessageHandler { |
| 51 | public: |
| 52 | ~MessageHandlerAutoCleanup() override; |
| 53 | |
| 54 | protected: |
| 55 | MessageHandlerAutoCleanup() : MessageHandler(true) {} |
| 56 | |
| 57 | private: |
| 58 | RTC_DISALLOW_COPY_AND_ASSIGN(MessageHandlerAutoCleanup); |
Henrik Kjellander | ec78f1c | 2017-06-29 07:52:50 +0200 | [diff] [blame] | 59 | }; |
| 60 | |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 61 | } // namespace rtc |
henrike@webrtc.org | f048872 | 2014-05-13 18:00:26 +0000 | [diff] [blame] | 62 | |
Steve Anton | 10542f2 | 2019-01-11 09:11:00 -0800 | [diff] [blame] | 63 | #endif // RTC_BASE_MESSAGE_HANDLER_H_ |