OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef BASE_SYNC_SOCKET_H_ | 5 #ifndef BASE_SYNC_SOCKET_H_ |
6 #define BASE_SYNC_SOCKET_H_ | 6 #define BASE_SYNC_SOCKET_H_ |
7 | 7 |
8 // A socket abstraction used for sending and receiving plain | 8 // A socket abstraction used for sending and receiving plain |
9 // data. Because the receiving is blocking, they can be used to perform | 9 // data. Because the receiving is blocking, they can be used to perform |
10 // rudimentary cross-process synchronization with low latency. | 10 // rudimentary cross-process synchronization with low latency. |
(...skipping 88 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
99 DISALLOW_COPY_AND_ASSIGN(SyncSocket); | 99 DISALLOW_COPY_AND_ASSIGN(SyncSocket); |
100 }; | 100 }; |
101 | 101 |
102 // Derives from SyncSocket and adds support for shutting down the socket from | 102 // Derives from SyncSocket and adds support for shutting down the socket from |
103 // another thread while a blocking Receive or Send is being done from the | 103 // another thread while a blocking Receive or Send is being done from the |
104 // thread that owns the socket. | 104 // thread that owns the socket. |
105 class BASE_EXPORT CancelableSyncSocket : public SyncSocket { | 105 class BASE_EXPORT CancelableSyncSocket : public SyncSocket { |
106 public: | 106 public: |
107 CancelableSyncSocket(); | 107 CancelableSyncSocket(); |
108 explicit CancelableSyncSocket(Handle handle); | 108 explicit CancelableSyncSocket(Handle handle); |
109 virtual ~CancelableSyncSocket() {} | 109 ~CancelableSyncSocket() override {} |
110 | 110 |
111 // Initializes a pair of cancelable sockets. See documentation for | 111 // Initializes a pair of cancelable sockets. See documentation for |
112 // SyncSocket::CreatePair for more details. | 112 // SyncSocket::CreatePair for more details. |
113 static bool CreatePair(CancelableSyncSocket* socket_a, | 113 static bool CreatePair(CancelableSyncSocket* socket_a, |
114 CancelableSyncSocket* socket_b); | 114 CancelableSyncSocket* socket_b); |
115 | 115 |
116 // A way to shut down a socket even if another thread is currently performing | 116 // A way to shut down a socket even if another thread is currently performing |
117 // a blocking Receive or Send. | 117 // a blocking Receive or Send. |
118 bool Shutdown(); | 118 bool Shutdown(); |
119 | 119 |
120 #if defined(OS_WIN) | 120 #if defined(OS_WIN) |
121 // Since the Linux and Mac implementations actually use a socket, shutting | 121 // Since the Linux and Mac implementations actually use a socket, shutting |
122 // them down from another thread is pretty simple - we can just call | 122 // them down from another thread is pretty simple - we can just call |
123 // shutdown(). However, the Windows implementation relies on named pipes | 123 // shutdown(). However, the Windows implementation relies on named pipes |
124 // and there isn't a way to cancel a blocking synchronous Read that is | 124 // and there isn't a way to cancel a blocking synchronous Read that is |
125 // supported on <Vista. So, for Windows only, we override these | 125 // supported on <Vista. So, for Windows only, we override these |
126 // SyncSocket methods in order to support shutting down the 'socket'. | 126 // SyncSocket methods in order to support shutting down the 'socket'. |
127 virtual bool Close() override; | 127 virtual bool Close() override; |
128 virtual size_t Receive(void* buffer, size_t length) override; | 128 virtual size_t Receive(void* buffer, size_t length) override; |
129 virtual size_t ReceiveWithTimeout(void* buffer, | 129 virtual size_t ReceiveWithTimeout(void* buffer, |
130 size_t length, | 130 size_t length, |
131 TimeDelta timeout) override; | 131 TimeDelta timeout) override; |
132 #endif | 132 #endif |
133 | 133 |
134 // Send() is overridden to catch cases where the remote end is not responding | 134 // Send() is overridden to catch cases where the remote end is not responding |
135 // and we fill the local socket buffer. When the buffer is full, this | 135 // and we fill the local socket buffer. When the buffer is full, this |
136 // implementation of Send() will not block indefinitely as | 136 // implementation of Send() will not block indefinitely as |
137 // SyncSocket::Send will, but instead return 0, as no bytes could be sent. | 137 // SyncSocket::Send will, but instead return 0, as no bytes could be sent. |
138 // Note that the socket will not be closed in this case. | 138 // Note that the socket will not be closed in this case. |
139 virtual size_t Send(const void* buffer, size_t length) override; | 139 size_t Send(const void* buffer, size_t length) override; |
140 | 140 |
141 private: | 141 private: |
142 #if defined(OS_WIN) | 142 #if defined(OS_WIN) |
143 WaitableEvent shutdown_event_; | 143 WaitableEvent shutdown_event_; |
144 WaitableEvent file_operation_; | 144 WaitableEvent file_operation_; |
145 #endif | 145 #endif |
146 DISALLOW_COPY_AND_ASSIGN(CancelableSyncSocket); | 146 DISALLOW_COPY_AND_ASSIGN(CancelableSyncSocket); |
147 }; | 147 }; |
148 | 148 |
149 #if defined(OS_WIN) && !defined(COMPONENT_BUILD) | 149 #if defined(OS_WIN) && !defined(COMPONENT_BUILD) |
150 // TODO(cpu): remove this once chrome is split in two dlls. | 150 // TODO(cpu): remove this once chrome is split in two dlls. |
151 __declspec(selectany) | 151 __declspec(selectany) |
152 const SyncSocket::Handle SyncSocket::kInvalidHandle = INVALID_HANDLE_VALUE; | 152 const SyncSocket::Handle SyncSocket::kInvalidHandle = INVALID_HANDLE_VALUE; |
153 #endif | 153 #endif |
154 | 154 |
155 } // namespace base | 155 } // namespace base |
156 | 156 |
157 #endif // BASE_SYNC_SOCKET_H_ | 157 #endif // BASE_SYNC_SOCKET_H_ |
OLD | NEW |