blob: 7b6e682e297dc23819821321aa1c4eeaffc54657 [file] [log] [blame]
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001/*
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 Anton10542f22019-01-11 09:11:00 -080011#ifndef RTC_BASE_MESSAGE_HANDLER_H_
12#define RTC_BASE_MESSAGE_HANDLER_H_
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000013
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +020014#include <utility>
kwiberg0eb15ed2015-12-17 03:04:15 -080015
Danil Chapovalovb877e712019-11-29 15:19:27 +010016#include "api/function_view.h"
Steve Anton10542f22019-01-11 09:11:00 -080017#include "rtc_base/constructor_magic.h"
Mirko Bonadei35214fc2019-09-23 14:54:28 +020018#include "rtc_base/system/rtc_export.h"
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +020019
20namespace rtc {
21
22struct Message;
23
Tomas Gunnarssonabdb4702020-09-05 18:43:36 +020024// 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 Bonadei35214fc2019-09-23 14:54:28 +020034class RTC_EXPORT MessageHandler {
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +020035 public:
36 virtual ~MessageHandler();
37 virtual void OnMessage(Message* msg) = 0;
38
39 protected:
Tomas Gunnarssonabdb4702020-09-05 18:43:36 +020040 // 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 Kjellanderec78f1c2017-06-29 07:52:50 +020044
45 private:
46 RTC_DISALLOW_COPY_AND_ASSIGN(MessageHandler);
Tomas Gunnarssonabdb4702020-09-05 18:43:36 +020047 const bool auto_cleanup_;
48};
49
50class 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 Kjellanderec78f1c2017-06-29 07:52:50 +020059};
60
Yves Gerey665174f2018-06-19 15:03:05 +020061} // namespace rtc
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000062
Steve Anton10542f22019-01-11 09:11:00 -080063#endif // RTC_BASE_MESSAGE_HANDLER_H_