InputQueue.cs 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107
  1. //------------------------------------------------------------
  2. // Copyright (c) Microsoft Corporation. All rights reserved.
  3. //------------------------------------------------------------
  4. namespace System.Runtime
  5. {
  6. using System;
  7. using System.Collections.Generic;
  8. using System.Threading;
  9. [Fx.Tag.SynchronizationPrimitive(Fx.Tag.BlocksUsing.PrivatePrimitive, SupportsAsync = true, ReleaseMethod = "Dispatch")]
  10. sealed class InputQueue<T> : IDisposable where T : class
  11. {
  12. static Action<object> completeOutstandingReadersCallback;
  13. static Action<object> completeWaitersFalseCallback;
  14. static Action<object> completeWaitersTrueCallback;
  15. static Action<object> onDispatchCallback;
  16. static Action<object> onInvokeDequeuedCallback;
  17. QueueState queueState;
  18. [Fx.Tag.SynchronizationObject(Blocking = false, Kind = Fx.Tag.SynchronizationKind.LockStatement)]
  19. ItemQueue itemQueue;
  20. [Fx.Tag.SynchronizationObject]
  21. Queue<IQueueReader> readerQueue;
  22. [Fx.Tag.SynchronizationObject]
  23. List<IQueueWaiter> waiterList;
  24. public InputQueue()
  25. {
  26. this.itemQueue = new ItemQueue();
  27. this.readerQueue = new Queue<IQueueReader>();
  28. this.waiterList = new List<IQueueWaiter>();
  29. this.queueState = QueueState.Open;
  30. }
  31. public InputQueue(Func<Action<AsyncCallback, IAsyncResult>> asyncCallbackGenerator)
  32. : this()
  33. {
  34. Fx.Assert(asyncCallbackGenerator != null, "use default ctor if you don't have a generator");
  35. AsyncCallbackGenerator = asyncCallbackGenerator;
  36. }
  37. public int PendingCount
  38. {
  39. get
  40. {
  41. lock (ThisLock)
  42. {
  43. return this.itemQueue.ItemCount;
  44. }
  45. }
  46. }
  47. // Users like ServiceModel can hook this abort ICommunicationObject or handle other non-IDisposable objects
  48. public Action<T> DisposeItemCallback
  49. {
  50. get;
  51. set;
  52. }
  53. // Users like ServiceModel can hook this to wrap the AsyncQueueReader callback functionality for tracing, etc
  54. Func<Action<AsyncCallback, IAsyncResult>> AsyncCallbackGenerator
  55. {
  56. get;
  57. set;
  58. }
  59. object ThisLock
  60. {
  61. get { return this.itemQueue; }
  62. }
  63. public IAsyncResult BeginDequeue(TimeSpan timeout, AsyncCallback callback, object state)
  64. {
  65. Item item = default(Item);
  66. lock (ThisLock)
  67. {
  68. if (queueState == QueueState.Open)
  69. {
  70. if (itemQueue.HasAvailableItem)
  71. {
  72. item = itemQueue.DequeueAvailableItem();
  73. }
  74. else
  75. {
  76. AsyncQueueReader reader = new AsyncQueueReader(this, timeout, callback, state);
  77. readerQueue.Enqueue(reader);
  78. return reader;
  79. }
  80. }
  81. else if (queueState == QueueState.Shutdown)
  82. {
  83. if (itemQueue.HasAvailableItem)
  84. {
  85. item = itemQueue.DequeueAvailableItem();
  86. }
  87. else if (itemQueue.HasAnyItem)
  88. {
  89. AsyncQueueReader reader = new AsyncQueueReader(this, timeout, callback, state);
  90. readerQueue.Enqueue(reader);
  91. return reader;
  92. }
  93. }
  94. }
  95. InvokeDequeuedCallback(item.DequeuedCallback);
  96. return new CompletedAsyncResult<T>(item.GetValue(), callback, state);
  97. }
  98. public IAsyncResult BeginWaitForItem(TimeSpan timeout, AsyncCallback callback, object state)
  99. {
  100. lock (ThisLock)
  101. {
  102. if (queueState == QueueState.Open)
  103. {
  104. if (!itemQueue.HasAvailableItem)
  105. {
  106. AsyncQueueWaiter waiter = new AsyncQueueWaiter(timeout, callback, state);
  107. waiterList.Add(waiter);
  108. return waiter;
  109. }
  110. }
  111. else if (queueState == QueueState.Shutdown)
  112. {
  113. if (!itemQueue.HasAvailableItem && itemQueue.HasAnyItem)
  114. {
  115. AsyncQueueWaiter waiter = new AsyncQueueWaiter(timeout, callback, state);
  116. waiterList.Add(waiter);
  117. return waiter;
  118. }
  119. }
  120. }
  121. return new CompletedAsyncResult<bool>(true, callback, state);
  122. }
  123. public void Close()
  124. {
  125. Dispose();
  126. }
  127. [Fx.Tag.Blocking(CancelMethod = "Close")]
  128. public T Dequeue(TimeSpan timeout)
  129. {
  130. T value;
  131. if (!this.Dequeue(timeout, out value))
  132. {
  133. throw Fx.Exception.AsError(new TimeoutException(InternalSR.TimeoutInputQueueDequeue(timeout)));
  134. }
  135. return value;
  136. }
  137. [Fx.Tag.Blocking(CancelMethod = "Close")]
  138. public bool Dequeue(TimeSpan timeout, out T value)
  139. {
  140. WaitQueueReader reader = null;
  141. Item item = new Item();
  142. lock (ThisLock)
  143. {
  144. if (queueState == QueueState.Open)
  145. {
  146. if (itemQueue.HasAvailableItem)
  147. {
  148. item = itemQueue.DequeueAvailableItem();
  149. }
  150. else
  151. {
  152. reader = new WaitQueueReader(this);
  153. readerQueue.Enqueue(reader);
  154. }
  155. }
  156. else if (queueState == QueueState.Shutdown)
  157. {
  158. if (itemQueue.HasAvailableItem)
  159. {
  160. item = itemQueue.DequeueAvailableItem();
  161. }
  162. else if (itemQueue.HasAnyItem)
  163. {
  164. reader = new WaitQueueReader(this);
  165. readerQueue.Enqueue(reader);
  166. }
  167. else
  168. {
  169. value = default(T);
  170. return true;
  171. }
  172. }
  173. else // queueState == QueueState.Closed
  174. {
  175. value = default(T);
  176. return true;
  177. }
  178. }
  179. if (reader != null)
  180. {
  181. return reader.Wait(timeout, out value);
  182. }
  183. else
  184. {
  185. InvokeDequeuedCallback(item.DequeuedCallback);
  186. value = item.GetValue();
  187. return true;
  188. }
  189. }
  190. public void Dispatch()
  191. {
  192. IQueueReader reader = null;
  193. Item item = new Item();
  194. IQueueReader[] outstandingReaders = null;
  195. IQueueWaiter[] waiters = null;
  196. bool itemAvailable = true;
  197. lock (ThisLock)
  198. {
  199. itemAvailable = !((queueState == QueueState.Closed) || (queueState == QueueState.Shutdown));
  200. this.GetWaiters(out waiters);
  201. if (queueState != QueueState.Closed)
  202. {
  203. itemQueue.MakePendingItemAvailable();
  204. if (readerQueue.Count > 0)
  205. {
  206. item = itemQueue.DequeueAvailableItem();
  207. reader = readerQueue.Dequeue();
  208. if (queueState == QueueState.Shutdown && readerQueue.Count > 0 && itemQueue.ItemCount == 0)
  209. {
  210. outstandingReaders = new IQueueReader[readerQueue.Count];
  211. readerQueue.CopyTo(outstandingReaders, 0);
  212. readerQueue.Clear();
  213. itemAvailable = false;
  214. }
  215. }
  216. }
  217. }
  218. if (outstandingReaders != null)
  219. {
  220. if (completeOutstandingReadersCallback == null)
  221. {
  222. completeOutstandingReadersCallback = new Action<object>(CompleteOutstandingReadersCallback);
  223. }
  224. ActionItem.Schedule(completeOutstandingReadersCallback, outstandingReaders);
  225. }
  226. if (waiters != null)
  227. {
  228. CompleteWaitersLater(itemAvailable, waiters);
  229. }
  230. if (reader != null)
  231. {
  232. InvokeDequeuedCallback(item.DequeuedCallback);
  233. reader.Set(item);
  234. }
  235. }
  236. [Fx.Tag.Blocking(CancelMethod = "Close", Conditional = "!result.IsCompleted")]
  237. public bool EndDequeue(IAsyncResult result, out T value)
  238. {
  239. CompletedAsyncResult<T> typedResult = result as CompletedAsyncResult<T>;
  240. if (typedResult != null)
  241. {
  242. value = CompletedAsyncResult<T>.End(result);
  243. return true;
  244. }
  245. return AsyncQueueReader.End(result, out value);
  246. }
  247. [Fx.Tag.Blocking(CancelMethod = "Close", Conditional = "!result.IsCompleted")]
  248. public T EndDequeue(IAsyncResult result)
  249. {
  250. T value;
  251. if (!this.EndDequeue(result, out value))
  252. {
  253. throw Fx.Exception.AsError(new TimeoutException());
  254. }
  255. return value;
  256. }
  257. [Fx.Tag.Blocking(CancelMethod = "Dispatch", Conditional = "!result.IsCompleted")]
  258. public bool EndWaitForItem(IAsyncResult result)
  259. {
  260. CompletedAsyncResult<bool> typedResult = result as CompletedAsyncResult<bool>;
  261. if (typedResult != null)
  262. {
  263. return CompletedAsyncResult<bool>.End(result);
  264. }
  265. return AsyncQueueWaiter.End(result);
  266. }
  267. public void EnqueueAndDispatch(T item)
  268. {
  269. EnqueueAndDispatch(item, null);
  270. }
  271. // dequeuedCallback is called as an item is dequeued from the InputQueue. The
  272. // InputQueue lock is not held during the callback. However, the user code will
  273. // not be notified of the item being available until the callback returns. If you
  274. // are not sure if the callback will block for a long time, then first call
  275. // IOThreadScheduler.ScheduleCallback to get to a "safe" thread.
  276. public void EnqueueAndDispatch(T item, Action dequeuedCallback)
  277. {
  278. EnqueueAndDispatch(item, dequeuedCallback, true);
  279. }
  280. public void EnqueueAndDispatch(Exception exception, Action dequeuedCallback, bool canDispatchOnThisThread)
  281. {
  282. Fx.Assert(exception != null, "EnqueueAndDispatch: exception parameter should not be null");
  283. EnqueueAndDispatch(new Item(exception, dequeuedCallback), canDispatchOnThisThread);
  284. }
  285. public void EnqueueAndDispatch(T item, Action dequeuedCallback, bool canDispatchOnThisThread)
  286. {
  287. Fx.Assert(item != null, "EnqueueAndDispatch: item parameter should not be null");
  288. EnqueueAndDispatch(new Item(item, dequeuedCallback), canDispatchOnThisThread);
  289. }
  290. public bool EnqueueWithoutDispatch(T item, Action dequeuedCallback)
  291. {
  292. Fx.Assert(item != null, "EnqueueWithoutDispatch: item parameter should not be null");
  293. return EnqueueWithoutDispatch(new Item(item, dequeuedCallback));
  294. }
  295. public bool EnqueueWithoutDispatch(Exception exception, Action dequeuedCallback)
  296. {
  297. Fx.Assert(exception != null, "EnqueueWithoutDispatch: exception parameter should not be null");
  298. return EnqueueWithoutDispatch(new Item(exception, dequeuedCallback));
  299. }
  300. public void Shutdown()
  301. {
  302. this.Shutdown(null);
  303. }
  304. // Don't let any more items in. Differs from Close in that we keep around
  305. // existing items in our itemQueue for possible future calls to Dequeue
  306. public void Shutdown(Func<Exception> pendingExceptionGenerator)
  307. {
  308. IQueueReader[] outstandingReaders = null;
  309. lock (ThisLock)
  310. {
  311. if (queueState == QueueState.Shutdown)
  312. {
  313. return;
  314. }
  315. if (queueState == QueueState.Closed)
  316. {
  317. return;
  318. }
  319. this.queueState = QueueState.Shutdown;
  320. if (readerQueue.Count > 0 && this.itemQueue.ItemCount == 0)
  321. {
  322. outstandingReaders = new IQueueReader[readerQueue.Count];
  323. readerQueue.CopyTo(outstandingReaders, 0);
  324. readerQueue.Clear();
  325. }
  326. }
  327. if (outstandingReaders != null)
  328. {
  329. for (int i = 0; i < outstandingReaders.Length; i++)
  330. {
  331. Exception exception = (pendingExceptionGenerator != null) ? pendingExceptionGenerator() : null;
  332. outstandingReaders[i].Set(new Item(exception, null));
  333. }
  334. }
  335. }
  336. [Fx.Tag.Blocking(CancelMethod = "Dispatch")]
  337. public bool WaitForItem(TimeSpan timeout)
  338. {
  339. WaitQueueWaiter waiter = null;
  340. bool itemAvailable = false;
  341. lock (ThisLock)
  342. {
  343. if (queueState == QueueState.Open)
  344. {
  345. if (itemQueue.HasAvailableItem)
  346. {
  347. itemAvailable = true;
  348. }
  349. else
  350. {
  351. waiter = new WaitQueueWaiter();
  352. waiterList.Add(waiter);
  353. }
  354. }
  355. else if (queueState == QueueState.Shutdown)
  356. {
  357. if (itemQueue.HasAvailableItem)
  358. {
  359. itemAvailable = true;
  360. }
  361. else if (itemQueue.HasAnyItem)
  362. {
  363. waiter = new WaitQueueWaiter();
  364. waiterList.Add(waiter);
  365. }
  366. else
  367. {
  368. return true;
  369. }
  370. }
  371. else // queueState == QueueState.Closed
  372. {
  373. return true;
  374. }
  375. }
  376. if (waiter != null)
  377. {
  378. return waiter.Wait(timeout);
  379. }
  380. else
  381. {
  382. return itemAvailable;
  383. }
  384. }
  385. public void Dispose()
  386. {
  387. bool dispose = false;
  388. lock (ThisLock)
  389. {
  390. if (queueState != QueueState.Closed)
  391. {
  392. queueState = QueueState.Closed;
  393. dispose = true;
  394. }
  395. }
  396. if (dispose)
  397. {
  398. while (readerQueue.Count > 0)
  399. {
  400. IQueueReader reader = readerQueue.Dequeue();
  401. reader.Set(default(Item));
  402. }
  403. while (itemQueue.HasAnyItem)
  404. {
  405. Item item = itemQueue.DequeueAnyItem();
  406. DisposeItem(item);
  407. InvokeDequeuedCallback(item.DequeuedCallback);
  408. }
  409. }
  410. }
  411. void DisposeItem(Item item)
  412. {
  413. T value = item.Value;
  414. if (value != null)
  415. {
  416. if (value is IDisposable)
  417. {
  418. ((IDisposable)value).Dispose();
  419. }
  420. else
  421. {
  422. Action<T> disposeItemCallback = this.DisposeItemCallback;
  423. if (disposeItemCallback != null)
  424. {
  425. disposeItemCallback(value);
  426. }
  427. }
  428. }
  429. }
  430. static void CompleteOutstandingReadersCallback(object state)
  431. {
  432. IQueueReader[] outstandingReaders = (IQueueReader[])state;
  433. for (int i = 0; i < outstandingReaders.Length; i++)
  434. {
  435. outstandingReaders[i].Set(default(Item));
  436. }
  437. }
  438. static void CompleteWaiters(bool itemAvailable, IQueueWaiter[] waiters)
  439. {
  440. for (int i = 0; i < waiters.Length; i++)
  441. {
  442. waiters[i].Set(itemAvailable);
  443. }
  444. }
  445. static void CompleteWaitersFalseCallback(object state)
  446. {
  447. CompleteWaiters(false, (IQueueWaiter[])state);
  448. }
  449. static void CompleteWaitersLater(bool itemAvailable, IQueueWaiter[] waiters)
  450. {
  451. if (itemAvailable)
  452. {
  453. if (completeWaitersTrueCallback == null)
  454. {
  455. completeWaitersTrueCallback = new Action<object>(CompleteWaitersTrueCallback);
  456. }
  457. ActionItem.Schedule(completeWaitersTrueCallback, waiters);
  458. }
  459. else
  460. {
  461. if (completeWaitersFalseCallback == null)
  462. {
  463. completeWaitersFalseCallback = new Action<object>(CompleteWaitersFalseCallback);
  464. }
  465. ActionItem.Schedule(completeWaitersFalseCallback, waiters);
  466. }
  467. }
  468. static void CompleteWaitersTrueCallback(object state)
  469. {
  470. CompleteWaiters(true, (IQueueWaiter[])state);
  471. }
  472. static void InvokeDequeuedCallback(Action dequeuedCallback)
  473. {
  474. if (dequeuedCallback != null)
  475. {
  476. dequeuedCallback();
  477. }
  478. }
  479. static void InvokeDequeuedCallbackLater(Action dequeuedCallback)
  480. {
  481. if (dequeuedCallback != null)
  482. {
  483. if (onInvokeDequeuedCallback == null)
  484. {
  485. onInvokeDequeuedCallback = new Action<object>(OnInvokeDequeuedCallback);
  486. }
  487. ActionItem.Schedule(onInvokeDequeuedCallback, dequeuedCallback);
  488. }
  489. }
  490. static void OnDispatchCallback(object state)
  491. {
  492. ((InputQueue<T>)state).Dispatch();
  493. }
  494. static void OnInvokeDequeuedCallback(object state)
  495. {
  496. Fx.Assert(state != null, "InputQueue.OnInvokeDequeuedCallback: (state != null)");
  497. Action dequeuedCallback = (Action)state;
  498. dequeuedCallback();
  499. }
  500. void EnqueueAndDispatch(Item item, bool canDispatchOnThisThread)
  501. {
  502. bool disposeItem = false;
  503. IQueueReader reader = null;
  504. bool dispatchLater = false;
  505. IQueueWaiter[] waiters = null;
  506. bool itemAvailable = true;
  507. lock (ThisLock)
  508. {
  509. itemAvailable = !((queueState == QueueState.Closed) || (queueState == QueueState.Shutdown));
  510. this.GetWaiters(out waiters);
  511. if (queueState == QueueState.Open)
  512. {
  513. if (canDispatchOnThisThread)
  514. {
  515. if (readerQueue.Count == 0)
  516. {
  517. itemQueue.EnqueueAvailableItem(item);
  518. }
  519. else
  520. {
  521. reader = readerQueue.Dequeue();
  522. }
  523. }
  524. else
  525. {
  526. if (readerQueue.Count == 0)
  527. {
  528. itemQueue.EnqueueAvailableItem(item);
  529. }
  530. else
  531. {
  532. itemQueue.EnqueuePendingItem(item);
  533. dispatchLater = true;
  534. }
  535. }
  536. }
  537. else // queueState == QueueState.Closed || queueState == QueueState.Shutdown
  538. {
  539. disposeItem = true;
  540. }
  541. }
  542. if (waiters != null)
  543. {
  544. if (canDispatchOnThisThread)
  545. {
  546. CompleteWaiters(itemAvailable, waiters);
  547. }
  548. else
  549. {
  550. CompleteWaitersLater(itemAvailable, waiters);
  551. }
  552. }
  553. if (reader != null)
  554. {
  555. InvokeDequeuedCallback(item.DequeuedCallback);
  556. reader.Set(item);
  557. }
  558. if (dispatchLater)
  559. {
  560. if (onDispatchCallback == null)
  561. {
  562. onDispatchCallback = new Action<object>(OnDispatchCallback);
  563. }
  564. ActionItem.Schedule(onDispatchCallback, this);
  565. }
  566. else if (disposeItem)
  567. {
  568. InvokeDequeuedCallback(item.DequeuedCallback);
  569. DisposeItem(item);
  570. }
  571. }
  572. // This will not block, however, Dispatch() must be called later if this function
  573. // returns true.
  574. bool EnqueueWithoutDispatch(Item item)
  575. {
  576. lock (ThisLock)
  577. {
  578. // Open
  579. if (queueState != QueueState.Closed && queueState != QueueState.Shutdown)
  580. {
  581. if (readerQueue.Count == 0 && waiterList.Count == 0)
  582. {
  583. itemQueue.EnqueueAvailableItem(item);
  584. return false;
  585. }
  586. else
  587. {
  588. itemQueue.EnqueuePendingItem(item);
  589. return true;
  590. }
  591. }
  592. }
  593. DisposeItem(item);
  594. InvokeDequeuedCallbackLater(item.DequeuedCallback);
  595. return false;
  596. }
  597. void GetWaiters(out IQueueWaiter[] waiters)
  598. {
  599. if (waiterList.Count > 0)
  600. {
  601. waiters = waiterList.ToArray();
  602. waiterList.Clear();
  603. }
  604. else
  605. {
  606. waiters = null;
  607. }
  608. }
  609. // Used for timeouts. The InputQueue must remove readers from its reader queue to prevent
  610. // dispatching items to timed out readers.
  611. bool RemoveReader(IQueueReader reader)
  612. {
  613. Fx.Assert(reader != null, "InputQueue.RemoveReader: (reader != null)");
  614. lock (ThisLock)
  615. {
  616. if (queueState == QueueState.Open || queueState == QueueState.Shutdown)
  617. {
  618. bool removed = false;
  619. for (int i = readerQueue.Count; i > 0; i--)
  620. {
  621. IQueueReader temp = readerQueue.Dequeue();
  622. if (object.ReferenceEquals(temp, reader))
  623. {
  624. removed = true;
  625. }
  626. else
  627. {
  628. readerQueue.Enqueue(temp);
  629. }
  630. }
  631. return removed;
  632. }
  633. }
  634. return false;
  635. }
  636. enum QueueState
  637. {
  638. Open,
  639. Shutdown,
  640. Closed
  641. }
  642. interface IQueueReader
  643. {
  644. void Set(Item item);
  645. }
  646. interface IQueueWaiter
  647. {
  648. void Set(bool itemAvailable);
  649. }
  650. struct Item
  651. {
  652. Action dequeuedCallback;
  653. Exception exception;
  654. T value;
  655. public Item(T value, Action dequeuedCallback)
  656. : this(value, null, dequeuedCallback)
  657. {
  658. }
  659. public Item(Exception exception, Action dequeuedCallback)
  660. : this(null, exception, dequeuedCallback)
  661. {
  662. }
  663. Item(T value, Exception exception, Action dequeuedCallback)
  664. {
  665. this.value = value;
  666. this.exception = exception;
  667. this.dequeuedCallback = dequeuedCallback;
  668. }
  669. public Action DequeuedCallback
  670. {
  671. get { return this.dequeuedCallback; }
  672. }
  673. public Exception Exception
  674. {
  675. get { return this.exception; }
  676. }
  677. public T Value
  678. {
  679. get { return this.value; }
  680. }
  681. public T GetValue()
  682. {
  683. if (this.exception != null)
  684. {
  685. throw Fx.Exception.AsError(this.exception);
  686. }
  687. return this.value;
  688. }
  689. }
  690. [Fx.Tag.SynchronizationPrimitive(Fx.Tag.BlocksUsing.AsyncResult, SupportsAsync = true, ReleaseMethod = "Set")]
  691. class AsyncQueueReader : AsyncResult, IQueueReader
  692. {
  693. static Action<object> timerCallback = new Action<object>(AsyncQueueReader.TimerCallback);
  694. bool expired;
  695. InputQueue<T> inputQueue;
  696. T item;
  697. IOThreadTimer timer;
  698. public AsyncQueueReader(InputQueue<T> inputQueue, TimeSpan timeout, AsyncCallback callback, object state)
  699. : base(callback, state)
  700. {
  701. if (inputQueue.AsyncCallbackGenerator != null)
  702. {
  703. base.VirtualCallback = inputQueue.AsyncCallbackGenerator();
  704. }
  705. this.inputQueue = inputQueue;
  706. if (timeout != TimeSpan.MaxValue)
  707. {
  708. this.timer = new IOThreadTimer(timerCallback, this, false);
  709. this.timer.Set(timeout);
  710. }
  711. }
  712. [Fx.Tag.Blocking(Conditional = "!result.IsCompleted", CancelMethod = "Set")]
  713. public static bool End(IAsyncResult result, out T value)
  714. {
  715. AsyncQueueReader readerResult = AsyncResult.End<AsyncQueueReader>(result);
  716. if (readerResult.expired)
  717. {
  718. value = default(T);
  719. return false;
  720. }
  721. else
  722. {
  723. value = readerResult.item;
  724. return true;
  725. }
  726. }
  727. public void Set(Item item)
  728. {
  729. this.item = item.Value;
  730. if (this.timer != null)
  731. {
  732. this.timer.Cancel();
  733. }
  734. Complete(false, item.Exception);
  735. }
  736. static void TimerCallback(object state)
  737. {
  738. AsyncQueueReader thisPtr = (AsyncQueueReader)state;
  739. if (thisPtr.inputQueue.RemoveReader(thisPtr))
  740. {
  741. thisPtr.expired = true;
  742. thisPtr.Complete(false);
  743. }
  744. }
  745. }
  746. [Fx.Tag.SynchronizationPrimitive(Fx.Tag.BlocksUsing.AsyncResult, SupportsAsync = true, ReleaseMethod = "Set")]
  747. class AsyncQueueWaiter : AsyncResult, IQueueWaiter
  748. {
  749. static Action<object> timerCallback = new Action<object>(AsyncQueueWaiter.TimerCallback);
  750. bool itemAvailable;
  751. [Fx.Tag.SynchronizationObject(Blocking = false)]
  752. object thisLock = new object();
  753. IOThreadTimer timer;
  754. public AsyncQueueWaiter(TimeSpan timeout, AsyncCallback callback, object state) : base(callback, state)
  755. {
  756. if (timeout != TimeSpan.MaxValue)
  757. {
  758. this.timer = new IOThreadTimer(timerCallback, this, false);
  759. this.timer.Set(timeout);
  760. }
  761. }
  762. object ThisLock
  763. {
  764. get
  765. {
  766. return this.thisLock;
  767. }
  768. }
  769. [Fx.Tag.Blocking(Conditional = "!result.IsCompleted", CancelMethod = "Set")]
  770. public static bool End(IAsyncResult result)
  771. {
  772. AsyncQueueWaiter waiterResult = AsyncResult.End<AsyncQueueWaiter>(result);
  773. return waiterResult.itemAvailable;
  774. }
  775. public void Set(bool itemAvailable)
  776. {
  777. bool timely;
  778. lock (ThisLock)
  779. {
  780. timely = (this.timer == null) || this.timer.Cancel();
  781. this.itemAvailable = itemAvailable;
  782. }
  783. if (timely)
  784. {
  785. Complete(false);
  786. }
  787. }
  788. static void TimerCallback(object state)
  789. {
  790. AsyncQueueWaiter thisPtr = (AsyncQueueWaiter)state;
  791. thisPtr.Complete(false);
  792. }
  793. }
  794. class ItemQueue
  795. {
  796. int head;
  797. Item[] items;
  798. int pendingCount;
  799. int totalCount;
  800. public ItemQueue()
  801. {
  802. this.items = new Item[1];
  803. }
  804. public bool HasAnyItem
  805. {
  806. get { return this.totalCount > 0; }
  807. }
  808. public bool HasAvailableItem
  809. {
  810. get { return this.totalCount > this.pendingCount; }
  811. }
  812. public int ItemCount
  813. {
  814. get { return this.totalCount; }
  815. }
  816. public Item DequeueAnyItem()
  817. {
  818. if (this.pendingCount == this.totalCount)
  819. {
  820. this.pendingCount--;
  821. }
  822. return DequeueItemCore();
  823. }
  824. public Item DequeueAvailableItem()
  825. {
  826. Fx.AssertAndThrow(this.totalCount != this.pendingCount, "ItemQueue does not contain any available items");
  827. return DequeueItemCore();
  828. }
  829. public void EnqueueAvailableItem(Item item)
  830. {
  831. EnqueueItemCore(item);
  832. }
  833. public void EnqueuePendingItem(Item item)
  834. {
  835. EnqueueItemCore(item);
  836. this.pendingCount++;
  837. }
  838. public void MakePendingItemAvailable()
  839. {
  840. Fx.AssertAndThrow(this.pendingCount != 0, "ItemQueue does not contain any pending items");
  841. this.pendingCount--;
  842. }
  843. Item DequeueItemCore()
  844. {
  845. Fx.AssertAndThrow(totalCount != 0, "ItemQueue does not contain any items");
  846. Item item = this.items[this.head];
  847. this.items[this.head] = new Item();
  848. this.totalCount--;
  849. this.head = (this.head + 1) % this.items.Length;
  850. return item;
  851. }
  852. void EnqueueItemCore(Item item)
  853. {
  854. if (this.totalCount == this.items.Length)
  855. {
  856. Item[] newItems = new Item[this.items.Length * 2];
  857. for (int i = 0; i < this.totalCount; i++)
  858. {
  859. newItems[i] = this.items[(head + i) % this.items.Length];
  860. }
  861. this.head = 0;
  862. this.items = newItems;
  863. }
  864. int tail = (this.head + this.totalCount) % this.items.Length;
  865. this.items[tail] = item;
  866. this.totalCount++;
  867. }
  868. }
  869. [Fx.Tag.SynchronizationObject(Blocking = false)]
  870. [Fx.Tag.SynchronizationPrimitive(Fx.Tag.BlocksUsing.ManualResetEvent, ReleaseMethod = "Set")]
  871. class WaitQueueReader : IQueueReader
  872. {
  873. Exception exception;
  874. InputQueue<T> inputQueue;
  875. T item;
  876. [Fx.Tag.SynchronizationObject]
  877. ManualResetEvent waitEvent;
  878. public WaitQueueReader(InputQueue<T> inputQueue)
  879. {
  880. this.inputQueue = inputQueue;
  881. waitEvent = new ManualResetEvent(false);
  882. }
  883. public void Set(Item item)
  884. {
  885. lock (this)
  886. {
  887. Fx.Assert(this.item == null, "InputQueue.WaitQueueReader.Set: (this.item == null)");
  888. Fx.Assert(this.exception == null, "InputQueue.WaitQueueReader.Set: (this.exception == null)");
  889. this.exception = item.Exception;
  890. this.item = item.Value;
  891. waitEvent.Set();
  892. }
  893. }
  894. [Fx.Tag.Blocking(CancelMethod = "Set")]
  895. public bool Wait(TimeSpan timeout, out T value)
  896. {
  897. bool isSafeToClose = false;
  898. try
  899. {
  900. if (!TimeoutHelper.WaitOne(waitEvent, timeout))
  901. {
  902. if (this.inputQueue.RemoveReader(this))
  903. {
  904. value = default(T);
  905. isSafeToClose = true;
  906. return false;
  907. }
  908. else
  909. {
  910. waitEvent.WaitOne();
  911. }
  912. }
  913. isSafeToClose = true;
  914. }
  915. finally
  916. {
  917. if (isSafeToClose)
  918. {
  919. waitEvent.Close();
  920. }
  921. }
  922. if (this.exception != null)
  923. {
  924. throw Fx.Exception.AsError(this.exception);
  925. }
  926. value = item;
  927. return true;
  928. }
  929. }
  930. [Fx.Tag.SynchronizationPrimitive(Fx.Tag.BlocksUsing.ManualResetEvent, ReleaseMethod = "Set")]
  931. class WaitQueueWaiter : IQueueWaiter
  932. {
  933. bool itemAvailable;
  934. [Fx.Tag.SynchronizationObject]
  935. ManualResetEvent waitEvent;
  936. public WaitQueueWaiter()
  937. {
  938. waitEvent = new ManualResetEvent(false);
  939. }
  940. public void Set(bool itemAvailable)
  941. {
  942. lock (this)
  943. {
  944. this.itemAvailable = itemAvailable;
  945. waitEvent.Set();
  946. }
  947. }
  948. [Fx.Tag.Blocking(CancelMethod = "Set")]
  949. public bool Wait(TimeSpan timeout)
  950. {
  951. if (!TimeoutHelper.WaitOne(waitEvent, timeout))
  952. {
  953. return false;
  954. }
  955. return this.itemAvailable;
  956. }
  957. }
  958. }
  959. }