1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
// Copyright 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef BASE_MESSAGE_PUMP_IO_IOS_H_
#define BASE_MESSAGE_PUMP_IO_IOS_H_
#include "base/base_export.h"
#include "base/mac/scoped_cffiledescriptorref.h"
#include "base/mac/scoped_cftyperef.h"
#include "base/memory/ref_counted.h"
#include "base/message_pump_mac.h"
#include "base/observer_list.h"
namespace base {
// This file introduces a class to monitor sockets and issue callbacks when
// sockets are ready for I/O on iOS.
class BASE_EXPORT MessagePumpIOSForIO : public MessagePumpNSRunLoop {
public:
class IOObserver {
public:
IOObserver() {}
// An IOObserver is an object that receives IO notifications from the
// MessagePump.
//
// NOTE: An IOObserver implementation should be extremely fast!
virtual void WillProcessIOEvent() = 0;
virtual void DidProcessIOEvent() = 0;
protected:
virtual ~IOObserver() {}
};
// Used with WatchFileDescriptor to asynchronously monitor the I/O readiness
// of a file descriptor.
class Watcher {
public:
// Called from MessageLoop::Run when an FD can be read from/written to
// without blocking
virtual void OnFileCanReadWithoutBlocking(int fd) = 0;
virtual void OnFileCanWriteWithoutBlocking(int fd) = 0;
protected:
virtual ~Watcher() {}
};
// Object returned by WatchFileDescriptor to manage further watching.
class FileDescriptorWatcher {
public:
FileDescriptorWatcher();
~FileDescriptorWatcher(); // Implicitly calls StopWatchingFileDescriptor.
// NOTE: These methods aren't called StartWatching()/StopWatching() to
// avoid confusion with the win32 ObjectWatcher class.
// Stop watching the FD, always safe to call. No-op if there's nothing
// to do.
bool StopWatchingFileDescriptor();
private:
friend class MessagePumpIOSForIO;
friend class MessagePumpIOSForIOTest;
// Called by MessagePumpIOSForIO, ownership of |fdref| and |fd_source|
// is transferred to this object.
void Init(CFFileDescriptorRef fdref,
CFOptionFlags callback_types,
CFRunLoopSourceRef fd_source,
bool is_persistent);
void set_pump(MessagePumpIOSForIO* pump) { pump_ = pump; }
MessagePumpIOSForIO* pump() const { return pump_; }
void set_watcher(Watcher* watcher) { watcher_ = watcher; }
void OnFileCanReadWithoutBlocking(int fd, MessagePumpIOSForIO* pump);
void OnFileCanWriteWithoutBlocking(int fd, MessagePumpIOSForIO* pump);
bool is_persistent_; // false if this event is one-shot.
base::mac::ScopedCFFileDescriptorRef fdref_;
CFOptionFlags callback_types_;
base::mac::ScopedCFTypeRef<CFRunLoopSourceRef> fd_source_;
scoped_refptr<MessagePumpIOSForIO> pump_;
Watcher* watcher_;
DISALLOW_COPY_AND_ASSIGN(FileDescriptorWatcher);
};
enum Mode {
WATCH_READ = 1 << 0,
WATCH_WRITE = 1 << 1,
WATCH_READ_WRITE = WATCH_READ | WATCH_WRITE
};
MessagePumpIOSForIO();
// Have the current thread's message loop watch for a a situation in which
// reading/writing to the FD can be performed without blocking.
// Callers must provide a preallocated FileDescriptorWatcher object which
// can later be used to manage the lifetime of this event.
// If a FileDescriptorWatcher is passed in which is already attached to
// an event, then the effect is cumulative i.e. after the call |controller|
// will watch both the previous event and the new one.
// If an error occurs while calling this method in a cumulative fashion, the
// event previously attached to |controller| is aborted.
// Returns true on success.
// Must be called on the same thread the message_pump is running on.
bool WatchFileDescriptor(int fd,
bool persistent,
int mode,
FileDescriptorWatcher *controller,
Watcher *delegate);
void RemoveRunLoopSource(CFRunLoopSourceRef source);
void AddIOObserver(IOObserver* obs);
void RemoveIOObserver(IOObserver* obs);
protected:
virtual ~MessagePumpIOSForIO();
private:
friend class MessagePumpIOSForIOTest;
void WillProcessIOEvent();
void DidProcessIOEvent();
static void HandleFdIOEvent(CFFileDescriptorRef fdref,
CFOptionFlags callback_types,
void* context);
ObserverList<IOObserver> io_observers_;
ThreadChecker watch_file_descriptor_caller_checker_;
DISALLOW_COPY_AND_ASSIGN(MessagePumpIOSForIO);
};
} // namespace base
#endif // BASE_MESSAGE_PUMP_IO_IOS_H_
|
