blob: 7068e73881b9aa9d18a2bba9021fa6b7548e3f83 [file] [log] [blame]
henrike@webrtc.orgf0488722014-05-13 18:00:261/*
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 17:11:0011#ifndef RTC_BASE_TEST_UTILS_H_
12#define RTC_BASE_TEST_UTILS_H_
henrike@webrtc.orgf0488722014-05-13 18:00:2613
Henrik Kjellanderec78f1c2017-06-29 05:52:5014// Utilities for testing rtc infrastructure in unittests
henrike@webrtc.orgf0488722014-05-13 18:00:2615
Henrik Kjellanderec78f1c2017-06-29 05:52:5016#include <map>
Yves Gerey3e707812018-11-28 15:47:4917#include <utility>
18
Steve Anton10542f22019-01-11 17:11:0019#include "rtc_base/async_socket.h"
Yves Gerey3e707812018-11-28 15:47:4920#include "rtc_base/third_party/sigslot/sigslot.h"
Henrik Kjellanderec78f1c2017-06-29 05:52:5021
22namespace webrtc {
23namespace testing {
24
Henrik Kjellanderec78f1c2017-06-29 05:52:5025///////////////////////////////////////////////////////////////////////////////
Niels Möller392d0df2021-03-29 11:00:2626// StreamSink - Monitor asynchronously signalled events from AsyncSocket.
Henrik Kjellanderec78f1c2017-06-29 05:52:5027///////////////////////////////////////////////////////////////////////////////
28
Niels Möller392d0df2021-03-29 11:00:2629// Note: Any event that is an error is treated as SSE_ERROR instead of that
Henrik Kjellanderec78f1c2017-06-29 05:52:5030// event.
31
32enum StreamSinkEvent {
Niels Möller392d0df2021-03-29 11:00:2633 SSE_OPEN = 1,
34 SSE_READ = 2,
35 SSE_WRITE = 4,
36 SSE_CLOSE = 8,
Henrik Kjellanderec78f1c2017-06-29 05:52:5037 SSE_ERROR = 16
38};
39
40class StreamSink : public sigslot::has_slots<> {
41 public:
Steve Anton9de3aac2017-10-24 17:08:2642 StreamSink();
43 ~StreamSink() override;
44
Mirko Bonadeie10b1632018-12-11 17:43:4045 void Monitor(rtc::AsyncSocket* socket) {
Yves Gerey665174f2018-06-19 13:03:0546 socket->SignalConnectEvent.connect(this, &StreamSink::OnConnectEvent);
47 socket->SignalReadEvent.connect(this, &StreamSink::OnReadEvent);
48 socket->SignalWriteEvent.connect(this, &StreamSink::OnWriteEvent);
49 socket->SignalCloseEvent.connect(this, &StreamSink::OnCloseEvent);
50 // In case you forgot to unmonitor a previous object with this address
51 events_.erase(socket);
Henrik Kjellanderec78f1c2017-06-29 05:52:5052 }
Mirko Bonadeie10b1632018-12-11 17:43:4053 void Unmonitor(rtc::AsyncSocket* socket) {
Yves Gerey665174f2018-06-19 13:03:0554 socket->SignalConnectEvent.disconnect(this);
55 socket->SignalReadEvent.disconnect(this);
56 socket->SignalWriteEvent.disconnect(this);
57 socket->SignalCloseEvent.disconnect(this);
58 events_.erase(socket);
Henrik Kjellanderec78f1c2017-06-29 05:52:5059 }
Mirko Bonadeie10b1632018-12-11 17:43:4060 bool Check(rtc::AsyncSocket* socket,
61 StreamSinkEvent event,
62 bool reset = true) {
Henrik Kjellanderec78f1c2017-06-29 05:52:5063 return DoCheck(socket, event, reset);
64 }
Henrik Kjellanderec78f1c2017-06-29 05:52:5065
66 private:
Niels Möller392d0df2021-03-29 11:00:2667 typedef std::map<rtc::AsyncSocket*, int> EventMap;
Henrik Kjellanderec78f1c2017-06-29 05:52:5068
Mirko Bonadeie10b1632018-12-11 17:43:4069 void OnConnectEvent(rtc::AsyncSocket* socket) { AddEvents(socket, SSE_OPEN); }
70 void OnReadEvent(rtc::AsyncSocket* socket) { AddEvents(socket, SSE_READ); }
71 void OnWriteEvent(rtc::AsyncSocket* socket) { AddEvents(socket, SSE_WRITE); }
72 void OnCloseEvent(rtc::AsyncSocket* socket, int error) {
Henrik Kjellanderec78f1c2017-06-29 05:52:5073 AddEvents(socket, (0 == error) ? SSE_CLOSE : SSE_ERROR);
74 }
75
Niels Möller392d0df2021-03-29 11:00:2676 void AddEvents(rtc::AsyncSocket* obj, int events) {
Henrik Kjellanderec78f1c2017-06-29 05:52:5077 EventMap::iterator it = events_.find(obj);
78 if (events_.end() == it) {
79 events_.insert(EventMap::value_type(obj, events));
80 } else {
81 it->second |= events;
82 }
83 }
Niels Möller392d0df2021-03-29 11:00:2684 bool DoCheck(rtc::AsyncSocket* obj, StreamSinkEvent event, bool reset) {
Henrik Kjellanderec78f1c2017-06-29 05:52:5085 EventMap::iterator it = events_.find(obj);
86 if ((events_.end() == it) || (0 == (it->second & event))) {
87 return false;
88 }
89 if (reset) {
90 it->second &= ~event;
91 }
92 return true;
93 }
Henrik Kjellanderec78f1c2017-06-29 05:52:5094
95 EventMap events_;
96};
97
Henrik Kjellanderec78f1c2017-06-29 05:52:5098} // namespace testing
99} // namespace webrtc
100
Steve Anton10542f22019-01-11 17:11:00101#endif // RTC_BASE_TEST_UTILS_H_