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 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985
|
// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved. See License.txt in the project root for license information.
using System.Collections.Generic;
using System.Reactive.Concurrency;
namespace System.Reactive.Linq
{
public static partial class Observable
{
#region + Buffer +
#region TimeSpan only
/// <summary>
/// Projects each element of an observable sequence into consecutive non-overlapping buffers which are produced based on timing information.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence, and in the lists in the result sequence.</typeparam>
/// <param name="source">Source sequence to produce buffers over.</param>
/// <param name="timeSpan">Length of each buffer.</param>
/// <returns>An observable sequence of buffers.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="timeSpan"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// Specifying a TimeSpan.Zero value for <paramref name="timeSpan"/> is not recommended but supported, causing the scheduler to create buffers as fast as it can.
/// Because all source sequence elements end up in one of the buffers, some buffers won't have a zero time span. This is a side-effect of the asynchrony introduced
/// by the scheduler, where the action to close the current buffer and to create a new buffer may not execute immediately, despite the TimeSpan.Zero due time.
/// </remarks>
public static IObservable<IList<TSource>> Buffer<TSource>(this IObservable<TSource> source, TimeSpan timeSpan)
{
if (source == null)
throw new ArgumentNullException("source");
if (timeSpan < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("timeSpan");
return s_impl.Buffer<TSource>(source, timeSpan);
}
/// <summary>
/// Projects each element of an observable sequence into consecutive non-overlapping buffers which are produced based on timing information, using the specified scheduler to run timers.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence, and in the lists in the result sequence.</typeparam>
/// <param name="source">Source sequence to produce buffers over.</param>
/// <param name="timeSpan">Length of each buffer.</param>
/// <param name="scheduler">Scheduler to run buffering timers on.</param>
/// <returns>An observable sequence of buffers.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="timeSpan"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// Specifying a TimeSpan.Zero value for <paramref name="timeSpan"/> is not recommended but supported, causing the scheduler to create buffers as fast as it can.
/// Because all source sequence elements end up in one of the buffers, some buffers won't have a zero time span. This is a side-effect of the asynchrony introduced
/// by the scheduler, where the action to close the current buffer and to create a new buffer may not execute immediately, despite the TimeSpan.Zero due time.
/// </remarks>
public static IObservable<IList<TSource>> Buffer<TSource>(this IObservable<TSource> source, TimeSpan timeSpan, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (timeSpan < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("timeSpan");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Buffer<TSource>(source, timeSpan, scheduler);
}
/// <summary>
/// Projects each element of an observable sequence into zero or more buffers which are produced based on timing information.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence, and in the lists in the result sequence.</typeparam>
/// <param name="source">Source sequence to produce buffers over.</param>
/// <param name="timeSpan">Length of each buffer.</param>
/// <param name="timeShift">Interval between creation of consecutive buffers.</param>
/// <returns>An observable sequence of buffers.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="timeSpan"/> or <paramref name="timeSpan"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// <para>
/// Specifying a TimeSpan.Zero value for <paramref name="timeSpan"/> is not recommended but supported, causing the scheduler to create buffers with minimum duration
/// length. However, some buffers won't have a zero time span. This is a side-effect of the asynchrony introduced by the scheduler, where the action to close the
/// current buffer may not execute immediately, despite the TimeSpan.Zero due time.
/// </para>
/// <para>
/// Specifying a TimeSpan.Zero value for <paramref name="timeShift"/> is not recommended but supported, causing the scheduler to create buffers as fast as it can.
/// However, this doesn't mean all buffers will start at the beginning of the source sequence. This is a side-effect of the asynchrony introduced by the scheduler,
/// where the action to create a new buffer may not execute immediately, despite the TimeSpan.Zero due time.
/// </para>
/// </remarks>
public static IObservable<IList<TSource>> Buffer<TSource>(this IObservable<TSource> source, TimeSpan timeSpan, TimeSpan timeShift)
{
if (source == null)
throw new ArgumentNullException("source");
if (timeSpan < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("timeSpan");
if (timeShift < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("timeShift");
return s_impl.Buffer<TSource>(source, timeSpan, timeShift);
}
/// <summary>
/// Projects each element of an observable sequence into zero or more buffers which are produced based on timing information, using the specified scheduler to run timers.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence, and in the lists in the result sequence.</typeparam>
/// <param name="source">Source sequence to produce buffers over.</param>
/// <param name="timeSpan">Length of each buffer.</param>
/// <param name="timeShift">Interval between creation of consecutive buffers.</param>
/// <param name="scheduler">Scheduler to run buffering timers on.</param>
/// <returns>An observable sequence of buffers.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="timeSpan"/> or <paramref name="timeSpan"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// <para>
/// Specifying a TimeSpan.Zero value for <paramref name="timeSpan"/> is not recommended but supported, causing the scheduler to create buffers with minimum duration
/// length. However, some buffers won't have a zero time span. This is a side-effect of the asynchrony introduced by the scheduler, where the action to close the
/// current buffer may not execute immediately, despite the TimeSpan.Zero due time.
/// </para>
/// <para>
/// Specifying a TimeSpan.Zero value for <paramref name="timeShift"/> is not recommended but supported, causing the scheduler to create buffers as fast as it can.
/// However, this doesn't mean all buffers will start at the beginning of the source sequence. This is a side-effect of the asynchrony introduced by the scheduler,
/// where the action to create a new buffer may not execute immediately, despite the TimeSpan.Zero due time.
/// </para>
/// </remarks>
public static IObservable<IList<TSource>> Buffer<TSource>(this IObservable<TSource> source, TimeSpan timeSpan, TimeSpan timeShift, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (timeSpan < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("timeSpan");
if (timeShift < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("timeShift");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Buffer<TSource>(source, timeSpan, timeShift, scheduler);
}
#endregion
#region TimeSpan + int
/// <summary>
/// Projects each element of an observable sequence into a buffer that's sent out when either it's full or a given amount of time has elapsed.
/// A useful real-world analogy of this overload is the behavior of a ferry leaving the dock when all seats are taken, or at the scheduled time of departure, whichever event occurs first.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence, and in the lists in the result sequence.</typeparam>
/// <param name="source">Source sequence to produce buffers over.</param>
/// <param name="timeSpan">Maximum time length of a window.</param>
/// <param name="count">Maximum element count of a window.</param>
/// <returns>An observable sequence of buffers.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="timeSpan"/> is less than TimeSpan.Zero. -or- <paramref name="count"/> is less than or equal to zero.</exception>
/// <remarks>
/// Specifying a TimeSpan.Zero value for <paramref name="timeSpan"/> is not recommended but supported, causing the scheduler to create buffers as fast as it can.
/// Because all source sequence elements end up in one of the buffers, some buffers won't have a zero time span. This is a side-effect of the asynchrony introduced
/// by the scheduler, where the action to close the current buffer and to create a new buffer may not execute immediately, despite the TimeSpan.Zero due time.
/// </remarks>
public static IObservable<IList<TSource>> Buffer<TSource>(this IObservable<TSource> source, TimeSpan timeSpan, int count)
{
if (source == null)
throw new ArgumentNullException("source");
if (timeSpan < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("timeSpan");
if (count <= 0)
throw new ArgumentOutOfRangeException("count");
return s_impl.Buffer<TSource>(source, timeSpan, count);
}
/// <summary>
/// Projects each element of an observable sequence into a buffer that's sent out when either it's full or a given amount of time has elapsed, using the specified scheduler to run timers.
/// A useful real-world analogy of this overload is the behavior of a ferry leaving the dock when all seats are taken, or at the scheduled time of departure, whichever event occurs first.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence, and in the lists in the result sequence.</typeparam>
/// <param name="source">Source sequence to produce buffers over.</param>
/// <param name="timeSpan">Maximum time length of a buffer.</param>
/// <param name="count">Maximum element count of a buffer.</param>
/// <param name="scheduler">Scheduler to run buffering timers on.</param>
/// <returns>An observable sequence of buffers.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="timeSpan"/> is less than TimeSpan.Zero. -or- <paramref name="count"/> is less than or equal to zero.</exception>
/// <remarks>
/// Specifying a TimeSpan.Zero value for <paramref name="timeSpan"/> is not recommended but supported, causing the scheduler to create buffers as fast as it can.
/// Because all source sequence elements end up in one of the buffers, some buffers won't have a zero time span. This is a side-effect of the asynchrony introduced
/// by the scheduler, where the action to close the current buffer and to create a new buffer may not execute immediately, despite the TimeSpan.Zero due time.
/// </remarks>
public static IObservable<IList<TSource>> Buffer<TSource>(this IObservable<TSource> source, TimeSpan timeSpan, int count, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (timeSpan < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("timeSpan");
if (count <= 0)
throw new ArgumentOutOfRangeException("count");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Buffer<TSource>(source, timeSpan, count, scheduler);
}
#endregion
#endregion
#region + Delay +
#region TimeSpan
/// <summary>
/// Time shifts the observable sequence by the specified relative time duration.
/// The relative time intervals between the values are preserved.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to delay values for.</param>
/// <param name="dueTime">Relative time by which to shift the observable sequence. If this value is equal to TimeSpan.Zero, the scheduler will dispatch observer callbacks as soon as possible.</param>
/// <returns>Time-shifted sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="dueTime"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// <para>
/// This operator is less efficient than <see cref="Observable.DelaySubscription{T}(IObservable{T}, TimeSpan)">DelaySubscription</see> because it records all notifications and time-delays those. This allows for immediate propagation of errors.
/// </para>
/// <para>
/// Observer callbacks for the resulting sequence will be run on the default scheduler. This effect is similar to using ObserveOn.
/// </para>
/// <para>
/// Exceptions signaled by the source sequence through an OnError callback are forwarded immediately to the result sequence. Any OnNext notifications that were in the queue at the point of the OnError callback will be dropped.
/// In order to delay error propagation, consider using the <see cref="Observable.Materialize">Observable.Materialize</see> and <see cref="Observable.Dematerialize">Observable.Dematerialize</see> operators, or use <see cref="Observable.DelaySubscription{T}(IObservable{T}, TimeSpan)">DelaySubscription</see>.
/// </para>
/// </remarks>
public static IObservable<TSource> Delay<TSource>(this IObservable<TSource> source, TimeSpan dueTime)
{
if (source == null)
throw new ArgumentNullException("source");
if (dueTime < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("dueTime");
return s_impl.Delay<TSource>(source, dueTime);
}
/// <summary>
/// Time shifts the observable sequence by the specified relative time duration, using the specified scheduler to run timers.
/// The relative time intervals between the values are preserved.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to delay values for.</param>
/// <param name="dueTime">Relative time by which to shift the observable sequence. If this value is equal to TimeSpan.Zero, the scheduler will dispatch observer callbacks as soon as possible.</param>
/// <param name="scheduler">Scheduler to run the delay timers on.</param>
/// <returns>Time-shifted sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="dueTime"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// <para>
/// This operator is less efficient than <see cref="Observable.DelaySubscription{T}(IObservable{T}, TimeSpan, IScheduler)">DelaySubscription</see> because it records all notifications and time-delays those. This allows for immediate propagation of errors.
/// </para>
/// <para>
/// Observer callbacks for the resulting sequence will be run on the specified scheduler. This effect is similar to using ObserveOn.
/// </para>
/// <para>
/// Exceptions signaled by the source sequence through an OnError callback are forwarded immediately to the result sequence. Any OnNext notifications that were in the queue at the point of the OnError callback will be dropped.
/// </para>
/// <para>
/// Exceptions signaled by the source sequence through an OnError callback are forwarded immediately to the result sequence. Any OnNext notifications that were in the queue at the point of the OnError callback will be dropped.
/// In order to delay error propagation, consider using the <see cref="Observable.Materialize">Observable.Materialize</see> and <see cref="Observable.Dematerialize">Observable.Dematerialize</see> operators, or use <see cref="Observable.DelaySubscription{T}(IObservable{T}, TimeSpan, IScheduler)">DelaySubscription</see>.
/// </para>
/// </remarks>
public static IObservable<TSource> Delay<TSource>(this IObservable<TSource> source, TimeSpan dueTime, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (dueTime < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("dueTime");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Delay<TSource>(source, dueTime, scheduler);
}
#endregion
#region DateTimeOffset
/// <summary>
/// Time shifts the observable sequence to start propagating notifications at the specified absolute time.
/// The relative time intervals between the values are preserved.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to delay values for.</param>
/// <param name="dueTime">Absolute time used to shift the observable sequence; the relative time shift gets computed upon subscription. If this value is less than or equal to DateTimeOffset.UtcNow, the scheduler will dispatch observer callbacks as soon as possible.</param>
/// <returns>Time-shifted sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <remarks>
/// <para>
/// This operator is less efficient than <see cref="Observable.DelaySubscription{T}(IObservable{T}, DateTimeOffset)">DelaySubscription</see> because it records all notifications and time-delays those. This allows for immediate propagation of errors.
/// </para>
/// <para>
/// Observer callbacks for the resulting sequence will be run on the default scheduler. This effect is similar to using ObserveOn.
/// </para>
/// <para>
/// Exceptions signaled by the source sequence through an OnError callback are forwarded immediately to the result sequence. Any OnNext notifications that were in the queue at the point of the OnError callback will be dropped.
/// In order to delay error propagation, consider using the <see cref="Observable.Materialize">Observable.Materialize</see> and <see cref="Observable.Dematerialize">Observable.Dematerialize</see> operators, or use <see cref="Observable.DelaySubscription{T}(IObservable{T}, DateTimeOffset)">DelaySubscription</see>.
/// </para>
/// </remarks>
public static IObservable<TSource> Delay<TSource>(this IObservable<TSource> source, DateTimeOffset dueTime)
{
if (source == null)
throw new ArgumentNullException("source");
return s_impl.Delay<TSource>(source, dueTime);
}
/// <summary>
/// Time shifts the observable sequence to start propagating notifications at the specified absolute time, using the specified scheduler to run timers.
/// The relative time intervals between the values are preserved.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to delay values for.</param>
/// <param name="dueTime">Absolute time used to shift the observable sequence; the relative time shift gets computed upon subscription. If this value is less than or equal to DateTimeOffset.UtcNow, the scheduler will dispatch observer callbacks as soon as possible.</param>
/// <param name="scheduler">Scheduler to run the delay timers on.</param>
/// <returns>Time-shifted sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <remarks>
/// <para>
/// This operator is less efficient than <see cref="Observable.DelaySubscription{T}(IObservable{T}, DateTimeOffset, IScheduler)">DelaySubscription</see> because it records all notifications and time-delays those. This allows for immediate propagation of errors.
/// </para>
/// <para>
/// Observer callbacks for the resulting sequence will be run on the specified scheduler. This effect is similar to using ObserveOn.
/// </para>
/// <para>
/// Exceptions signaled by the source sequence through an OnError callback are forwarded immediately to the result sequence. Any OnNext notifications that were in the queue at the point of the OnError callback will be dropped.
/// In order to delay error propagation, consider using the <see cref="Observable.Materialize">Observable.Materialize</see> and <see cref="Observable.Dematerialize">Observable.Dematerialize</see> operators, or use <see cref="Observable.DelaySubscription{T}(IObservable{T}, DateTimeOffset, IScheduler)">DelaySubscription</see>.
/// </para>
/// </remarks>
public static IObservable<TSource> Delay<TSource>(this IObservable<TSource> source, DateTimeOffset dueTime, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Delay<TSource>(source, dueTime, scheduler);
}
#endregion
#region Duration selector
/// <summary>
/// Time shifts the observable sequence based on a delay selector function for each element.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <typeparam name="TDelay">The type of the elements in the delay sequences used to denote the delay duration of each element in the source sequence.</typeparam>
/// <param name="source">Source sequence to delay values for.</param>
/// <param name="delayDurationSelector">Selector function to retrieve a sequence indicating the delay for each given element.</param>
/// <returns>Time-shifted sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="delayDurationSelector"/> is null.</exception>
public static IObservable<TSource> Delay<TSource, TDelay>(this IObservable<TSource> source, Func<TSource, IObservable<TDelay>> delayDurationSelector)
{
if (source == null)
throw new ArgumentNullException("source");
if (delayDurationSelector == null)
throw new ArgumentNullException("delayDurationSelector");
return s_impl.Delay<TSource, TDelay>(source, delayDurationSelector);
}
/// <summary>
/// Time shifts the observable sequence based on a subscription delay and a delay selector function for each element.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <typeparam name="TDelay">The type of the elements in the delay sequences used to denote the delay duration of each element in the source sequence.</typeparam>
/// <param name="source">Source sequence to delay values for.</param>
/// <param name="subscriptionDelay">Sequence indicating the delay for the subscription to the source.</param>
/// <param name="delayDurationSelector">Selector function to retrieve a sequence indicating the delay for each given element.</param>
/// <returns>Time-shifted sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="subscriptionDelay"/> or <paramref name="delayDurationSelector"/> is null.</exception>
public static IObservable<TSource> Delay<TSource, TDelay>(this IObservable<TSource> source, IObservable<TDelay> subscriptionDelay, Func<TSource, IObservable<TDelay>> delayDurationSelector)
{
if (source == null)
throw new ArgumentNullException("source");
if (subscriptionDelay == null)
throw new ArgumentNullException("subscriptionDelay");
if (delayDurationSelector == null)
throw new ArgumentNullException("delayDurationSelector");
return s_impl.Delay<TSource, TDelay>(source, subscriptionDelay, delayDurationSelector);
}
#endregion
#endregion
#region + DelaySubscription +
/// <summary>
/// Time shifts the observable sequence by delaying the subscription with the specified relative time duration.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to delay subscription for.</param>
/// <param name="dueTime">Relative time shift of the subscription.</param>
/// <returns>Time-shifted sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="dueTime"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// <para>
/// This operator is more efficient than <see cref="Observable.Delay{T}(IObservable{T}, TimeSpan)">Delay</see> but postpones all side-effects of subscription and affects error propagation timing.
/// </para>
/// <para>
/// The side-effects of subscribing to the source sequence will be run on the default scheduler. Observer callbacks will not be affected.
/// </para>
/// </remarks>
public static IObservable<TSource> DelaySubscription<TSource>(this IObservable<TSource> source, TimeSpan dueTime)
{
if (source == null)
throw new ArgumentNullException("source");
if (dueTime < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("dueTime");
return s_impl.DelaySubscription<TSource>(source, dueTime);
}
/// <summary>
/// Time shifts the observable sequence by delaying the subscription with the specified relative time duration, using the specified scheduler to run timers.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to delay subscription for.</param>
/// <param name="dueTime">Relative time shift of the subscription.</param>
/// <param name="scheduler">Scheduler to run the subscription delay timer on.</param>
/// <returns>Time-shifted sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="dueTime"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// <para>
/// This operator is more efficient than <see cref="Observable.Delay{T}(IObservable{T}, TimeSpan, IScheduler)">Delay</see> but postpones all side-effects of subscription and affects error propagation timing.
/// </para>
/// <para>
/// The side-effects of subscribing to the source sequence will be run on the specified scheduler. Observer callbacks will not be affected.
/// </para>
/// </remarks>
public static IObservable<TSource> DelaySubscription<TSource>(this IObservable<TSource> source, TimeSpan dueTime, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (dueTime < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("dueTime");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.DelaySubscription<TSource>(source, dueTime, scheduler);
}
/// <summary>
/// Time shifts the observable sequence by delaying the subscription to the specified absolute time.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to delay subscription for.</param>
/// <param name="dueTime">Absolute time to perform the subscription at.</param>
/// <returns>Time-shifted sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <remarks>
/// <para>
/// This operator is more efficient than <see cref="Observable.Delay{T}(IObservable{T}, DateTimeOffset)">Delay</see> but postpones all side-effects of subscription and affects error propagation timing.
/// </para>
/// <para>
/// The side-effects of subscribing to the source sequence will be run on the default scheduler. Observer callbacks will not be affected.
/// </para>
/// </remarks>
public static IObservable<TSource> DelaySubscription<TSource>(this IObservable<TSource> source, DateTimeOffset dueTime)
{
if (source == null)
throw new ArgumentNullException("source");
return s_impl.DelaySubscription<TSource>(source, dueTime);
}
/// <summary>
/// Time shifts the observable sequence by delaying the subscription to the specified absolute time, using the specified scheduler to run timers.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to delay subscription for.</param>
/// <param name="dueTime">Absolute time to perform the subscription at.</param>
/// <param name="scheduler">Scheduler to run the subscription delay timer on.</param>
/// <returns>Time-shifted sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <remarks>
/// <para>
/// This operator is more efficient than <see cref="Observable.Delay{T}(IObservable{T}, DateTimeOffset, IScheduler)">Delay</see> but postpones all side-effects of subscription and affects error propagation timing.
/// </para>
/// <para>
/// The side-effects of subscribing to the source sequence will be run on the specified scheduler. Observer callbacks will not be affected.
/// </para>
/// </remarks>
public static IObservable<TSource> DelaySubscription<TSource>(this IObservable<TSource> source, DateTimeOffset dueTime, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.DelaySubscription<TSource>(source, dueTime, scheduler);
}
#endregion
#region + Generate +
/// <summary>
/// Generates an observable sequence by running a state-driven and temporal loop producing the sequence's elements.
/// </summary>
/// <typeparam name="TState">The type of the state used in the generator loop.</typeparam>
/// <typeparam name="TResult">The type of the elements in the produced sequence.</typeparam>
/// <param name="initialState">Initial state.</param>
/// <param name="condition">Condition to terminate generation (upon returning false).</param>
/// <param name="iterate">Iteration step function.</param>
/// <param name="resultSelector">Selector function for results produced in the sequence.</param>
/// <param name="timeSelector">Time selector function to control the speed of values being produced each iteration.</param>
/// <returns>The generated sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="condition"/> or <paramref name="iterate"/> or <paramref name="resultSelector"/> or <paramref name="timeSelector"/> is null.</exception>
public static IObservable<TResult> Generate<TState, TResult>(TState initialState, Func<TState, bool> condition, Func<TState, TState> iterate, Func<TState, TResult> resultSelector, Func<TState, TimeSpan> timeSelector)
{
if (condition == null)
throw new ArgumentNullException("condition");
if (iterate == null)
throw new ArgumentNullException("iterate");
if (resultSelector == null)
throw new ArgumentNullException("resultSelector");
if (timeSelector == null)
throw new ArgumentNullException("timeSelector");
return s_impl.Generate<TState, TResult>(initialState, condition, iterate, resultSelector, timeSelector);
}
/// <summary>
/// Generates an observable sequence by running a state-driven and temporal loop producing the sequence's elements, using the specified scheduler to run timers and to send out observer messages.
/// </summary>
/// <typeparam name="TState">The type of the state used in the generator loop.</typeparam>
/// <typeparam name="TResult">The type of the elements in the produced sequence.</typeparam>
/// <param name="initialState">Initial state.</param>
/// <param name="condition">Condition to terminate generation (upon returning false).</param>
/// <param name="iterate">Iteration step function.</param>
/// <param name="resultSelector">Selector function for results produced in the sequence.</param>
/// <param name="timeSelector">Time selector function to control the speed of values being produced each iteration.</param>
/// <param name="scheduler">Scheduler on which to run the generator loop.</param>
/// <returns>The generated sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="condition"/> or <paramref name="iterate"/> or <paramref name="resultSelector"/> or <paramref name="timeSelector"/> or <paramref name="scheduler"/> is null.</exception>
public static IObservable<TResult> Generate<TState, TResult>(TState initialState, Func<TState, bool> condition, Func<TState, TState> iterate, Func<TState, TResult> resultSelector, Func<TState, TimeSpan> timeSelector, IScheduler scheduler)
{
if (condition == null)
throw new ArgumentNullException("condition");
if (iterate == null)
throw new ArgumentNullException("iterate");
if (resultSelector == null)
throw new ArgumentNullException("resultSelector");
if (timeSelector == null)
throw new ArgumentNullException("timeSelector");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Generate<TState, TResult>(initialState, condition, iterate, resultSelector, timeSelector, scheduler);
}
/// <summary>
/// Generates an observable sequence by running a state-driven and temporal loop producing the sequence's elements.
/// </summary>
/// <typeparam name="TState">The type of the state used in the generator loop.</typeparam>
/// <typeparam name="TResult">The type of the elements in the produced sequence.</typeparam>
/// <param name="initialState">Initial state.</param>
/// <param name="condition">Condition to terminate generation (upon returning false).</param>
/// <param name="iterate">Iteration step function.</param>
/// <param name="resultSelector">Selector function for results produced in the sequence.</param>
/// <param name="timeSelector">Time selector function to control the speed of values being produced each iteration.</param>
/// <returns>The generated sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="condition"/> or <paramref name="iterate"/> or <paramref name="resultSelector"/> or <paramref name="timeSelector"/> is null.</exception>
public static IObservable<TResult> Generate<TState, TResult>(TState initialState, Func<TState, bool> condition, Func<TState, TState> iterate, Func<TState, TResult> resultSelector, Func<TState, DateTimeOffset> timeSelector)
{
if (condition == null)
throw new ArgumentNullException("condition");
if (iterate == null)
throw new ArgumentNullException("iterate");
if (resultSelector == null)
throw new ArgumentNullException("resultSelector");
if (timeSelector == null)
throw new ArgumentNullException("timeSelector");
return s_impl.Generate<TState, TResult>(initialState, condition, iterate, resultSelector, timeSelector);
}
/// <summary>
/// Generates an observable sequence by running a state-driven and temporal loop producing the sequence's elements, using the specified scheduler to run timers and to send out observer messages.
/// </summary>
/// <typeparam name="TState">The type of the state used in the generator loop.</typeparam>
/// <typeparam name="TResult">The type of the elements in the produced sequence.</typeparam>
/// <param name="initialState">Initial state.</param>
/// <param name="condition">Condition to terminate generation (upon returning false).</param>
/// <param name="iterate">Iteration step function.</param>
/// <param name="resultSelector">Selector function for results produced in the sequence.</param>
/// <param name="timeSelector">Time selector function to control the speed of values being produced each iteration.</param>
/// <param name="scheduler">Scheduler on which to run the generator loop.</param>
/// <returns>The generated sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="condition"/> or <paramref name="iterate"/> or <paramref name="resultSelector"/> or <paramref name="timeSelector"/> or <paramref name="scheduler"/> is null.</exception>
public static IObservable<TResult> Generate<TState, TResult>(TState initialState, Func<TState, bool> condition, Func<TState, TState> iterate, Func<TState, TResult> resultSelector, Func<TState, DateTimeOffset> timeSelector, IScheduler scheduler)
{
if (condition == null)
throw new ArgumentNullException("condition");
if (iterate == null)
throw new ArgumentNullException("iterate");
if (resultSelector == null)
throw new ArgumentNullException("resultSelector");
if (timeSelector == null)
throw new ArgumentNullException("timeSelector");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Generate<TState, TResult>(initialState, condition, iterate, resultSelector, timeSelector, scheduler);
}
#endregion
#region + Interval +
/// <summary>
/// Returns an observable sequence that produces a value after each period.
/// </summary>
/// <param name="period">Period for producing the values in the resulting sequence. If this value is equal to TimeSpan.Zero, the timer will recur as fast as possible.</param>
/// <returns>An observable sequence that produces a value after each period.</returns>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="period"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// Intervals are measured between the start of subsequent notifications, not between the end of the previous and the start of the next notification.
/// If the observer takes longer than the interval period to handle the message, the subsequent notification will be delivered immediately after the
/// current one has been handled. In case you need to control the time between the end and the start of consecutive notifications, consider using the
/// <see cref="Observable.Generate{TState, TResult}(TState, Func{TState, bool}, Func{TState, TState}, Func{TState, TResult}, Func{TState, TimeSpan})"/>
/// operator instead.
/// </remarks>
public static IObservable<long> Interval(TimeSpan period)
{
if (period < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("period");
return s_impl.Interval(period);
}
/// <summary>
/// Returns an observable sequence that produces a value after each period, using the specified scheduler to run timers and to send out observer messages.
/// </summary>
/// <param name="period">Period for producing the values in the resulting sequence. If this value is equal to TimeSpan.Zero, the timer will recur as fast as possible.</param>
/// <param name="scheduler">Scheduler to run the timer on.</param>
/// <returns>An observable sequence that produces a value after each period.</returns>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="period"/> is less than TimeSpan.Zero.</exception>
/// <exception cref="ArgumentNullException"><paramref name="scheduler"/> is null.</exception>
/// <remarks>
/// Intervals are measured between the start of subsequent notifications, not between the end of the previous and the start of the next notification.
/// If the observer takes longer than the interval period to handle the message, the subsequent notification will be delivered immediately after the
/// current one has been handled. In case you need to control the time between the end and the start of consecutive notifications, consider using the
/// <see cref="Observable.Generate{TState, TResult}(TState, Func{TState, bool}, Func{TState, TState}, Func{TState, TResult}, Func{TState, TimeSpan}, IScheduler)"/>
/// operator instead.
/// </remarks>
public static IObservable<long> Interval(TimeSpan period, IScheduler scheduler)
{
if (period < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("period");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Interval(period, scheduler);
}
#endregion
#region + Sample +
/// <summary>
/// Samples the observable sequence at each interval.
/// Upon each sampling tick, the latest element (if any) in the source sequence during the last sampling interval is sent to the resulting sequence.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to sample.</param>
/// <param name="interval">Interval at which to sample. If this value is equal to TimeSpan.Zero, the scheduler will continuously sample the stream.</param>
/// <returns>Sampled observable sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="interval"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// Specifying a TimeSpan.Zero value for <paramref name="interval"/> doesn't guarantee all source sequence elements will be preserved. This is a side-effect
/// of the asynchrony introduced by the scheduler, where the sampling action may not execute immediately, despite the TimeSpan.Zero due time.
/// </remarks>
public static IObservable<TSource> Sample<TSource>(this IObservable<TSource> source, TimeSpan interval)
{
if (source == null)
throw new ArgumentNullException("source");
if (interval < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("interval");
return s_impl.Sample<TSource>(source, interval);
}
/// <summary>
/// Samples the observable sequence at each interval, using the specified scheduler to run sampling timers.
/// Upon each sampling tick, the latest element (if any) in the source sequence during the last sampling interval is sent to the resulting sequence.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to sample.</param>
/// <param name="interval">Interval at which to sample. If this value is equal to TimeSpan.Zero, the scheduler will continuously sample the stream.</param>
/// <param name="scheduler">Scheduler to run the sampling timer on.</param>
/// <returns>Sampled observable sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="interval"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// Specifying a TimeSpan.Zero value for <paramref name="interval"/> doesn't guarantee all source sequence elements will be preserved. This is a side-effect
/// of the asynchrony introduced by the scheduler, where the sampling action may not execute immediately, despite the TimeSpan.Zero due time.
/// </remarks>
public static IObservable<TSource> Sample<TSource>(this IObservable<TSource> source, TimeSpan interval, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (interval < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("interval");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Sample<TSource>(source, interval, scheduler);
}
/// <summary>
/// Samples the source observable sequence using a samper observable sequence producing sampling ticks.
/// Upon each sampling tick, the latest element (if any) in the source sequence during the last sampling interval is sent to the resulting sequence.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <typeparam name="TSample">The type of the elements in the sampling sequence.</typeparam>
/// <param name="source">Source sequence to sample.</param>
/// <param name="sampler">Sampling tick sequence.</param>
/// <returns>Sampled observable sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="sampler"/> is null.</exception>
public static IObservable<TSource> Sample<TSource, TSample>(this IObservable<TSource> source, IObservable<TSample> sampler)
{
if (source == null)
throw new ArgumentNullException("source");
if (sampler == null)
throw new ArgumentNullException("sampler");
return s_impl.Sample<TSource, TSample>(source, sampler);
}
#endregion
#region + Skip +
/// <summary>
/// Skips elements for the specified duration from the start of the observable source sequence.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to skip elements for.</param>
/// <param name="duration">Duration for skipping elements from the start of the sequence.</param>
/// <returns>An observable sequence with the elements skipped during the specified duration from the start of the source sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="duration"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// <para>
/// Specifying a TimeSpan.Zero value for <paramref name="duration"/> doesn't guarantee no elements will be dropped from the start of the source sequence.
/// This is a side-effect of the asynchrony introduced by the scheduler, where the action that causes callbacks from the source sequence to be forwarded
/// may not execute immediately, despite the TimeSpan.Zero due time.
/// </para>
/// <para>
/// Errors produced by the source sequence are always forwarded to the result sequence, even if the error occurs before the <paramref name="duration"/>.
/// </para>
/// </remarks>
public static IObservable<TSource> Skip<TSource>(this IObservable<TSource> source, TimeSpan duration)
{
if (source == null)
throw new ArgumentNullException("source");
if (duration < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("duration");
return s_impl.Skip<TSource>(source, duration);
}
/// <summary>
/// Skips elements for the specified duration from the start of the observable source sequence, using the specified scheduler to run timers.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to skip elements for.</param>
/// <param name="duration">Duration for skipping elements from the start of the sequence.</param>
/// <param name="scheduler">Scheduler to run the timer on.</param>
/// <returns>An observable sequence with the elements skipped during the specified duration from the start of the source sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="duration"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// <para>
/// Specifying a TimeSpan.Zero value for <paramref name="duration"/> doesn't guarantee no elements will be dropped from the start of the source sequence.
/// This is a side-effect of the asynchrony introduced by the scheduler, where the action that causes callbacks from the source sequence to be forwarded
/// may not execute immediately, despite the TimeSpan.Zero due time.
/// </para>
/// <para>
/// Errors produced by the source sequence are always forwarded to the result sequence, even if the error occurs before the <paramref name="duration"/>.
/// </para>
/// </remarks>
public static IObservable<TSource> Skip<TSource>(this IObservable<TSource> source, TimeSpan duration, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (duration < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("duration");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Skip<TSource>(source, duration, scheduler);
}
#endregion
#region + SkipLast +
/// <summary>
/// Skips elements for the specified duration from the end of the observable source sequence.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to skip elements for.</param>
/// <param name="duration">Duration for skipping elements from the end of the sequence.</param>
/// <returns>An observable sequence with the elements skipped during the specified duration from the end of the source sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="duration"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// This operator accumulates a queue with a length enough to store elements received during the initial <paramref name="duration"/> window.
/// As more elements are received, elements older than the specified <paramref name="duration"/> are taken from the queue and produced on the
/// result sequence. This causes elements to be delayed with <paramref name="duration"/>.
/// </remarks>
public static IObservable<TSource> SkipLast<TSource>(this IObservable<TSource> source, TimeSpan duration)
{
if (source == null)
throw new ArgumentNullException("source");
if (duration < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("duration");
return s_impl.SkipLast<TSource>(source, duration);
}
/// <summary>
/// Skips elements for the specified duration from the end of the observable source sequence, using the specified scheduler to run timers.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to skip elements for.</param>
/// <param name="duration">Duration for skipping elements from the end of the sequence.</param>
/// <param name="scheduler">Scheduler to run the timer on.</param>
/// <returns>An observable sequence with the elements skipped during the specified duration from the end of the source sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="duration"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// This operator accumulates a queue with a length enough to store elements received during the initial <paramref name="duration"/> window.
/// As more elements are received, elements older than the specified <paramref name="duration"/> are taken from the queue and produced on the
/// result sequence. This causes elements to be delayed with <paramref name="duration"/>.
/// </remarks>
public static IObservable<TSource> SkipLast<TSource>(this IObservable<TSource> source, TimeSpan duration, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (duration < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("duration");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.SkipLast<TSource>(source, duration, scheduler);
}
#endregion
#region + SkipUntil +
/// <summary>
/// Skips elements from the observable source sequence until the specified start time.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to skip elements for.</param>
/// <param name="startTime">Time to start taking elements from the source sequence. If this value is less than or equal to DateTimeOffset.UtcNow, no elements will be skipped.</param>
/// <returns>An observable sequence with the elements skipped until the specified start time.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <remarks>
/// Errors produced by the source sequence are always forwarded to the result sequence, even if the error occurs before the <paramref name="startTime"/>.
/// </remarks>
public static IObservable<TSource> SkipUntil<TSource>(this IObservable<TSource> source, DateTimeOffset startTime)
{
if (source == null)
throw new ArgumentNullException("source");
return s_impl.SkipUntil<TSource>(source, startTime);
}
/// <summary>
/// Skips elements from the observable source sequence until the specified start time, using the specified scheduler to run timers.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to skip elements for.</param>
/// <param name="startTime">Time to start taking elements from the source sequence. If this value is less than or equal to DateTimeOffset.UtcNow, no elements will be skipped.</param>
/// <param name="scheduler">Scheduler to run the timer on.</param>
/// <returns>An observable sequence with the elements skipped until the specified start time.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <remarks>
/// Errors produced by the source sequence are always forwarded to the result sequence, even if the error occurs before the <paramref name="startTime"/>.
/// </remarks>
public static IObservable<TSource> SkipUntil<TSource>(this IObservable<TSource> source, DateTimeOffset startTime, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.SkipUntil<TSource>(source, startTime, scheduler);
}
#endregion
#region + Take +
/// <summary>
/// Takes elements for the specified duration from the start of the observable source sequence.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to take elements from.</param>
/// <param name="duration">Duration for taking elements from the start of the sequence.</param>
/// <returns>An observable sequence with the elements taken during the specified duration from the start of the source sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="duration"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// Specifying a TimeSpan.Zero value for <paramref name="duration"/> doesn't guarantee an empty sequence will be returned. This is a side-effect
/// of the asynchrony introduced by the scheduler, where the action that stops forwarding callbacks from the source sequence may not execute
/// immediately, despite the TimeSpan.Zero due time.
/// </remarks>
public static IObservable<TSource> Take<TSource>(this IObservable<TSource> source, TimeSpan duration)
{
if (source == null)
throw new ArgumentNullException("source");
if (duration < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("duration");
return s_impl.Take<TSource>(source, duration);
}
/// <summary>
/// Takes elements for the specified duration from the start of the observable source sequence, using the specified scheduler to run timers.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to take elements from.</param>
/// <param name="duration">Duration for taking elements from the start of the sequence.</param>
/// <param name="scheduler">Scheduler to run the timer on.</param>
/// <returns>An observable sequence with the elements taken during the specified duration from the start of the source sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="duration"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// Specifying a TimeSpan.Zero value for <paramref name="duration"/> doesn't guarantee an empty sequence will be returned. This is a side-effect
/// of the asynchrony introduced by the scheduler, where the action that stops forwarding callbacks from the source sequence may not execute
/// immediately, despite the TimeSpan.Zero due time.
/// </remarks>
public static IObservable<TSource> Take<TSource>(this IObservable<TSource> source, TimeSpan duration, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (duration < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("duration");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Take<TSource>(source, duration, scheduler);
}
#endregion
#region + TakeLast +
/// <summary>
/// Returns elements within the specified duration from the end of the observable source sequence.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to take elements from.</param>
/// <param name="duration">Duration for taking elements from the end of the sequence.</param>
/// <returns>An observable sequence with the elements taken during the specified duration from the end of the source sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="duration"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// This operator accumulates a buffer with a length enough to store elements for any <paramref name="duration"/> window during the lifetime of
/// the source sequence. Upon completion of the source sequence, this buffer is drained on the result sequence. This causes the result elements
/// to be delayed with <paramref name="duration"/>.
/// </remarks>
public static IObservable<TSource> TakeLast<TSource>(this IObservable<TSource> source, TimeSpan duration)
{
if (source == null)
throw new ArgumentNullException("source");
if (duration < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("duration");
return s_impl.TakeLast<TSource>(source, duration);
}
/// <summary>
/// Returns elements within the specified duration from the end of the observable source sequence, using the specified scheduler to run timers.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to take elements from.</param>
/// <param name="duration">Duration for taking elements from the end of the sequence.</param>
/// <param name="scheduler">Scheduler to run the timer on.</param>
/// <returns>An observable sequence with the elements taken during the specified duration from the end of the source sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="duration"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// This operator accumulates a buffer with a length enough to store elements for any <paramref name="duration"/> window during the lifetime of
/// the source sequence. Upon completion of the source sequence, this buffer is drained on the result sequence. This causes the result elements
/// to be delayed with <paramref name="duration"/>.
/// </remarks>
public static IObservable<TSource> TakeLast<TSource>(this IObservable<TSource> source, TimeSpan duration, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (duration < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("duration");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.TakeLast<TSource>(source, duration, scheduler);
}
/// <summary>
/// Returns elements within the specified duration from the end of the observable source sequence, using the specified schedulers to run timers and to drain the collected elements.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to take elements from.</param>
/// <param name="duration">Duration for taking elements from the end of the sequence.</param>
/// <param name="timerScheduler">Scheduler to run the timer on.</param>
/// <param name="loopScheduler">Scheduler to drain the collected elements.</param>
/// <returns>An observable sequence with the elements taken during the specified duration from the end of the source sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="timerScheduler"/> or <paramref name="loopScheduler"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="duration"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// This operator accumulates a buffer with a length enough to store elements for any <paramref name="duration"/> window during the lifetime of
/// the source sequence. Upon completion of the source sequence, this buffer is drained on the result sequence. This causes the result elements
/// to be delayed with <paramref name="duration"/>.
/// </remarks>
public static IObservable<TSource> TakeLast<TSource>(this IObservable<TSource> source, TimeSpan duration, IScheduler timerScheduler, IScheduler loopScheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (duration < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("duration");
if (timerScheduler == null)
throw new ArgumentNullException("timerScheduler");
if (loopScheduler == null)
throw new ArgumentNullException("loopScheduler");
return s_impl.TakeLast<TSource>(source, duration, timerScheduler, loopScheduler);
}
#endregion
#region + TakeLastBuffer +
/// <summary>
/// Returns a list with the elements within the specified duration from the end of the observable source sequence.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to take elements from.</param>
/// <param name="duration">Duration for taking elements from the end of the sequence.</param>
/// <returns>An observable sequence containing a single list with the elements taken during the specified duration from the end of the source sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="duration"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// This operator accumulates a buffer with a length enough to store elements for any <paramref name="duration"/> window during the lifetime of
/// the source sequence. Upon completion of the source sequence, this buffer is produced on the result sequence.
/// </remarks>
public static IObservable<IList<TSource>> TakeLastBuffer<TSource>(this IObservable<TSource> source, TimeSpan duration)
{
if (source == null)
throw new ArgumentNullException("source");
if (duration < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("duration");
return s_impl.TakeLastBuffer<TSource>(source, duration);
}
/// <summary>
/// Returns a list with the elements within the specified duration from the end of the observable source sequence, using the specified scheduler to run timers.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to take elements from.</param>
/// <param name="duration">Duration for taking elements from the end of the sequence.</param>
/// <param name="scheduler">Scheduler to run the timer on.</param>
/// <returns>An observable sequence containing a single list with the elements taken during the specified duration from the end of the source sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="duration"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// This operator accumulates a buffer with a length enough to store elements for any <paramref name="duration"/> window during the lifetime of
/// the source sequence. Upon completion of the source sequence, this buffer is produced on the result sequence.
/// </remarks>
public static IObservable<IList<TSource>> TakeLastBuffer<TSource>(this IObservable<TSource> source, TimeSpan duration, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (duration < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("duration");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.TakeLastBuffer<TSource>(source, duration, scheduler);
}
#endregion
#region + TakeUntil +
/// <summary>
/// Takes elements for the specified duration until the specified end time.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to take elements from.</param>
/// <param name="endTime">Time to stop taking elements from the source sequence. If this value is less than or equal to DateTimeOffset.UtcNow, the result stream will complete immediately.</param>
/// <returns>An observable sequence with the elements taken until the specified end time.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
public static IObservable<TSource> TakeUntil<TSource>(this IObservable<TSource> source, DateTimeOffset endTime)
{
if (source == null)
throw new ArgumentNullException("source");
return s_impl.TakeUntil<TSource>(source, endTime);
}
/// <summary>
/// Takes elements for the specified duration until the specified end time, using the specified scheduler to run timers.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to take elements from.</param>
/// <param name="endTime">Time to stop taking elements from the source sequence. If this value is less than or equal to DateTimeOffset.UtcNow, the result stream will complete immediately.</param>
/// <param name="scheduler">Scheduler to run the timer on.</param>
/// <returns>An observable sequence with the elements taken until the specified end time.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
public static IObservable<TSource> TakeUntil<TSource>(this IObservable<TSource> source, DateTimeOffset endTime, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.TakeUntil<TSource>(source, endTime, scheduler);
}
#endregion
#region + Throttle +
/// <summary>
/// Ignores elements from an observable sequence which are followed by another element within a specified relative time duration.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to throttle.</param>
/// <param name="dueTime">Throttling duration for each element.</param>
/// <returns>The throttled sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="dueTime"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// <para>
/// This operator throttles the source sequence by holding on to each element for the duration specified in <paramref name="dueTime"/>. If another
/// element is produced within this time window, the element is dropped and a new timer is started for the current element, repeating this whole
/// process. For streams that never have gaps larger than or equal to <paramref name="dueTime"/> between elements, the resulting stream won't
/// produce any elements. In order to reduce the volume of a stream whilst guaranteeing the periodic production of elements, consider using the
/// Observable.Sample set of operators.
/// </para>
/// <para>
/// Specifying a TimeSpan.Zero value for <paramref name="dueTime"/> is not recommended but supported, causing throttling timers to be scheduled
/// that are due immediately. However, this doesn't guarantee all elements will be retained in the result sequence. This is a side-effect of the
/// asynchrony introduced by the scheduler, where the action to forward the current element may not execute immediately, despite the TimeSpan.Zero
/// due time. In such cases, the next element may arrive before the scheduler gets a chance to run the throttling action.
/// </para>
/// </remarks>
public static IObservable<TSource> Throttle<TSource>(this IObservable<TSource> source, TimeSpan dueTime)
{
if (source == null)
throw new ArgumentNullException("source");
if (dueTime < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("dueTime");
return s_impl.Throttle<TSource>(source, dueTime);
}
/// <summary>
/// Ignores elements from an observable sequence which are followed by another element within a specified relative time duration, using the specified scheduler to run throttling timers.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to throttle.</param>
/// <param name="dueTime">Throttling duration for each element.</param>
/// <param name="scheduler">Scheduler to run the throttle timers on.</param>
/// <returns>The throttled sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="dueTime"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// <para>
/// This operator throttles the source sequence by holding on to each element for the duration specified in <paramref name="dueTime"/>. If another
/// element is produced within this time window, the element is dropped and a new timer is started for the current element, repeating this whole
/// process. For streams that never have gaps larger than or equal to <paramref name="dueTime"/> between elements, the resulting stream won't
/// produce any elements. In order to reduce the volume of a stream whilst guaranteeing the periodic production of elements, consider using the
/// Observable.Sample set of operators.
/// </para>
/// <para>
/// Specifying a TimeSpan.Zero value for <paramref name="dueTime"/> is not recommended but supported, causing throttling timers to be scheduled
/// that are due immediately. However, this doesn't guarantee all elements will be retained in the result sequence. This is a side-effect of the
/// asynchrony introduced by the scheduler, where the action to forward the current element may not execute immediately, despite the TimeSpan.Zero
/// due time. In such cases, the next element may arrive before the scheduler gets a chance to run the throttling action.
/// </para>
/// </remarks>
public static IObservable<TSource> Throttle<TSource>(this IObservable<TSource> source, TimeSpan dueTime, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (dueTime < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("dueTime");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Throttle<TSource>(source, dueTime, scheduler);
}
/// <summary>
/// Ignores elements from an observable sequence which are followed by another value within a computed throttle duration.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <typeparam name="TThrottle">The type of the elements in the throttle sequences selected for each element in the source sequence.</typeparam>
/// <param name="source">Source sequence to throttle.</param>
/// <param name="throttleDurationSelector">Selector function to retrieve a sequence indicating the throttle duration for each given element.</param>
/// <returns>The throttled sequence.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="throttleDurationSelector"/> is null.</exception>
/// <remarks>
/// This operator throttles the source sequence by holding on to each element for the duration denoted by <paramref name="throttleDurationSelector"/>.
/// If another element is produced within this time window, the element is dropped and a new timer is started for the current element, repeating this
/// whole process. For streams where the duration computed by applying the <paramref name="throttleDurationSelector"/> to each element overlaps with
/// the occurrence of the successor element, the resulting stream won't produce any elements. In order to reduce the volume of a stream whilst
/// guaranteeing the periodic production of elements, consider using the Observable.Sample set of operators.
/// </remarks>
public static IObservable<TSource> Throttle<TSource, TThrottle>(this IObservable<TSource> source, Func<TSource, IObservable<TThrottle>> throttleDurationSelector)
{
if (source == null)
throw new ArgumentNullException("source");
if (throttleDurationSelector == null)
throw new ArgumentNullException("throttleDurationSelector");
return s_impl.Throttle<TSource, TThrottle>(source, throttleDurationSelector);
}
#endregion
#region + TimeInterval +
/// <summary>
/// Records the time interval between consecutive elements in an observable sequence.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to record time intervals for.</param>
/// <returns>An observable sequence with time interval information on elements.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
public static IObservable<System.Reactive.TimeInterval<TSource>> TimeInterval<TSource>(this IObservable<TSource> source)
{
if (source == null)
throw new ArgumentNullException("source");
return s_impl.TimeInterval<TSource>(source);
}
/// <summary>
/// Records the time interval between consecutive elements in an observable sequence, using the specified scheduler to compute time intervals.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to record time intervals for.</param>
/// <param name="scheduler">Scheduler used to compute time intervals.</param>
/// <returns>An observable sequence with time interval information on elements.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
public static IObservable<System.Reactive.TimeInterval<TSource>> TimeInterval<TSource>(this IObservable<TSource> source, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.TimeInterval<TSource>(source, scheduler);
}
#endregion
#region + Timeout +
#region TimeSpan
/// <summary>
/// Applies a timeout policy for each element in the observable sequence.
/// If the next element isn't received within the specified timeout duration starting from its predecessor, a TimeoutException is propagated to the observer.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to perform a timeout for.</param>
/// <param name="dueTime">Maximum duration between values before a timeout occurs.</param>
/// <returns>The source sequence with a TimeoutException in case of a timeout.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="dueTime"/> is less than TimeSpan.Zero.</exception>
/// <exception cref="TimeoutException">(Asynchronous) If no element is produced within <paramref name="dueTime"/> from the previous element.</exception>
/// <remarks>
/// <para>
/// In case you only want to timeout on the first element, consider using the <see cref="Observable.Amb{TSource}(IObservable{TSource}, IObservable{TSource})"/>
/// operator applied to the source sequence and a delayed <see cref="Observable.Throw{TResult}(Exception)"/> sequence. Alternatively, the general-purpose overload
/// of Timeout, <see cref="Timeout{TSource, TTimeout}(IObservable{TSource}, IObservable{TTimeout}, Func{TSource, IObservable{TTimeout}})"/> can be used.
/// </para>
/// <para>
/// Specifying a TimeSpan.Zero value for <paramref name="dueTime"/> is not recommended but supported, causing timeout timers to be scheduled that are due
/// immediately. However, this doesn't guarantee a timeout will occur, even for the first element. This is a side-effect of the asynchrony introduced by the
/// scheduler, where the action to propagate a timeout may not execute immediately, despite the TimeSpan.Zero due time. In such cases, the next element may
/// arrive before the scheduler gets a chance to run the timeout action.
/// </para>
/// </remarks>
public static IObservable<TSource> Timeout<TSource>(this IObservable<TSource> source, TimeSpan dueTime)
{
if (source == null)
throw new ArgumentNullException("source");
if (dueTime < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("dueTime");
return s_impl.Timeout<TSource>(source, dueTime);
}
/// <summary>
/// Applies a timeout policy for each element in the observable sequence, using the specified scheduler to run timeout timers.
/// If the next element isn't received within the specified timeout duration starting from its predecessor, a TimeoutException is propagated to the observer.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to perform a timeout for.</param>
/// <param name="dueTime">Maximum duration between values before a timeout occurs.</param>
/// <param name="scheduler">Scheduler to run the timeout timers on.</param>
/// <returns>The source sequence with a TimeoutException in case of a timeout.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="dueTime"/> is less than TimeSpan.Zero.</exception>
/// <exception cref="TimeoutException">(Asynchronous) If no element is produced within <paramref name="dueTime"/> from the previous element.</exception>
/// <remarks>
/// <para>
/// In case you only want to timeout on the first element, consider using the <see cref="Observable.Amb{TSource}(IObservable{TSource}, IObservable{TSource})"/>
/// operator applied to the source sequence and a delayed <see cref="Observable.Throw{TResult}(Exception)"/> sequence. Alternatively, the general-purpose overload
/// of Timeout, <see cref="Timeout{TSource, TTimeout}(IObservable{TSource}, IObservable{TTimeout}, Func{TSource, IObservable{TTimeout}})"/> can be used.
/// </para>
/// <para>
/// Specifying a TimeSpan.Zero value for <paramref name="dueTime"/> is not recommended but supported, causing timeout timers to be scheduled that are due
/// immediately. However, this doesn't guarantee a timeout will occur, even for the first element. This is a side-effect of the asynchrony introduced by the
/// scheduler, where the action to propagate a timeout may not execute immediately, despite the TimeSpan.Zero due time. In such cases, the next element may
/// arrive before the scheduler gets a chance to run the timeout action.
/// </para>
/// </remarks>
public static IObservable<TSource> Timeout<TSource>(this IObservable<TSource> source, TimeSpan dueTime, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (dueTime < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("dueTime");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Timeout<TSource>(source, dueTime, scheduler);
}
/// <summary>
/// Applies a timeout policy for each element in the observable sequence.
/// If the next element isn't received within the specified timeout duration starting from its predecessor, the other observable sequence is used to produce future messages from that point on.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence and the other sequence used upon a timeout.</typeparam>
/// <param name="source">Source sequence to perform a timeout for.</param>
/// <param name="dueTime">Maximum duration between values before a timeout occurs.</param>
/// <param name="other">Sequence to return in case of a timeout.</param>
/// <returns>The source sequence switching to the other sequence in case of a timeout.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="other"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="dueTime"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// <para>
/// In case you only want to timeout on the first element, consider using the <see cref="Observable.Amb{TSource}(IObservable{TSource}, IObservable{TSource})"/>
/// operator applied to the source sequence and a delayed <see cref="Observable.Throw{TResult}(Exception)"/> sequence. Alternatively, the general-purpose overload
/// of Timeout, <see cref="Timeout{TSource, TTimeout}(IObservable{TSource}, IObservable{TTimeout}, Func{TSource, IObservable{TTimeout}})"/> can be used.
/// </para>
/// <para>
/// Specifying a TimeSpan.Zero value for <paramref name="dueTime"/> is not recommended but supported, causing timeout timers to be scheduled that are due
/// immediately. However, this doesn't guarantee a timeout will occur, even for the first element. This is a side-effect of the asynchrony introduced by the
/// scheduler, where the action to propagate a timeout may not execute immediately, despite the TimeSpan.Zero due time. In such cases, the next element may
/// arrive before the scheduler gets a chance to run the timeout action.
/// </para>
/// </remarks>
public static IObservable<TSource> Timeout<TSource>(this IObservable<TSource> source, TimeSpan dueTime, IObservable<TSource> other)
{
if (source == null)
throw new ArgumentNullException("source");
if (dueTime < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("dueTime");
if (other == null)
throw new ArgumentNullException("other");
return s_impl.Timeout<TSource>(source, dueTime, other);
}
/// <summary>
/// Applies a timeout policy for each element in the observable sequence, using the specified scheduler to run timeout timers.
/// If the next element isn't received within the specified timeout duration starting from its predecessor, the other observable sequence is used to produce future messages from that point on.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence and the other sequence used upon a timeout.</typeparam>
/// <param name="source">Source sequence to perform a timeout for.</param>
/// <param name="dueTime">Maximum duration between values before a timeout occurs.</param>
/// <param name="other">Sequence to return in case of a timeout.</param>
/// <param name="scheduler">Scheduler to run the timeout timers on.</param>
/// <returns>The source sequence switching to the other sequence in case of a timeout.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="other"/> or <paramref name="scheduler"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="dueTime"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// <para>
/// In case you only want to timeout on the first element, consider using the <see cref="Observable.Amb{TSource}(IObservable{TSource}, IObservable{TSource})"/>
/// operator applied to the source sequence and a delayed <see cref="Observable.Throw{TResult}(Exception)"/> sequence. Alternatively, the general-purpose overload
/// of Timeout, <see cref="Timeout{TSource, TTimeout}(IObservable{TSource}, IObservable{TTimeout}, Func{TSource, IObservable{TTimeout}})"/> can be used.
/// </para>
/// <para>
/// Specifying a TimeSpan.Zero value for <paramref name="dueTime"/> is not recommended but supported, causing timeout timers to be scheduled that are due
/// immediately. However, this doesn't guarantee a timeout will occur, even for the first element. This is a side-effect of the asynchrony introduced by the
/// scheduler, where the action to propagate a timeout may not execute immediately, despite the TimeSpan.Zero due time. In such cases, the next element may
/// arrive before the scheduler gets a chance to run the timeout action.
/// </para>
/// </remarks>
public static IObservable<TSource> Timeout<TSource>(this IObservable<TSource> source, TimeSpan dueTime, IObservable<TSource> other, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (dueTime < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("dueTime");
if (other == null)
throw new ArgumentNullException("other");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Timeout<TSource>(source, dueTime, other, scheduler);
}
#endregion
#region DateTimeOffset
/// <summary>
/// Applies a timeout policy to the observable sequence based on an absolute time.
/// If the sequence doesn't terminate before the specified absolute due time, a TimeoutException is propagated to the observer.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to perform a timeout for.</param>
/// <param name="dueTime">Time when a timeout occurs. If this value is less than or equal to DateTimeOffset.UtcNow, the timeout occurs immediately.</param>
/// <returns>The source sequence with a TimeoutException in case of a timeout.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="TimeoutException">(Asynchronous) If the sequence hasn't terminated before <paramref name="dueTime"/>.</exception>
/// <remarks>
/// In case you only want to timeout on the first element, consider using the <see cref="Observable.Amb{TSource}(IObservable{TSource}, IObservable{TSource})"/>
/// operator applied to the source sequence and a delayed <see cref="Observable.Throw{TResult}(Exception)"/> sequence. Alternatively, the general-purpose overload
/// of Timeout, <see cref="Timeout{TSource, TTimeout}(IObservable{TSource}, IObservable{TTimeout}, Func{TSource, IObservable{TTimeout}})"/> can be used.
/// </remarks>
public static IObservable<TSource> Timeout<TSource>(this IObservable<TSource> source, DateTimeOffset dueTime)
{
if (source == null)
throw new ArgumentNullException("source");
return s_impl.Timeout<TSource>(source, dueTime);
}
/// <summary>
/// Applies a timeout policy to the observable sequence based on an absolute time, using the specified scheduler to run timeout timers.
/// If the sequence doesn't terminate before the specified absolute due time, a TimeoutException is propagated to the observer.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to perform a timeout for.</param>
/// <param name="dueTime">Time when a timeout occurs. If this value is less than or equal to DateTimeOffset.UtcNow, the timeout occurs immediately.</param>
/// <param name="scheduler">Scheduler to run the timeout timers on.</param>
/// <returns>The source sequence with a TimeoutException in case of a timeout.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <exception cref="TimeoutException">(Asynchronous) If the sequence hasn't terminated before <paramref name="dueTime"/>.</exception>
/// <remarks>
/// In case you only want to timeout on the first element, consider using the <see cref="Observable.Amb{TSource}(IObservable{TSource}, IObservable{TSource})"/>
/// operator applied to the source sequence and a delayed <see cref="Observable.Throw{TResult}(Exception)"/> sequence. Alternatively, the general-purpose overload
/// of Timeout, <see cref="Timeout{TSource, TTimeout}(IObservable{TSource}, IObservable{TTimeout}, Func{TSource, IObservable{TTimeout}})"/> can be used.
/// </remarks>
public static IObservable<TSource> Timeout<TSource>(this IObservable<TSource> source, DateTimeOffset dueTime, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Timeout<TSource>(source, dueTime, scheduler);
}
/// <summary>
/// Applies a timeout policy to the observable sequence based on an absolute time.
/// If the sequence doesn't terminate before the specified absolute due time, the other observable sequence is used to produce future messages from that point on.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence and the other sequence used upon a timeout.</typeparam>
/// <param name="source">Source sequence to perform a timeout for.</param>
/// <param name="dueTime">Time when a timeout occurs. If this value is less than or equal to DateTimeOffset.UtcNow, the timeout occurs immediately.</param>
/// <param name="other">Sequence to return in case of a timeout.</param>
/// <returns>The source sequence switching to the other sequence in case of a timeout.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="other"/> is null.</exception>
/// <remarks>
/// In case you only want to timeout on the first element, consider using the <see cref="Observable.Amb{TSource}(IObservable{TSource}, IObservable{TSource})"/>
/// operator applied to the source sequence and a delayed <see cref="Observable.Throw{TResult}(Exception)"/> sequence. Alternatively, the general-purpose overload
/// of Timeout, <see cref="Timeout{TSource, TTimeout}(IObservable{TSource}, IObservable{TTimeout}, Func{TSource, IObservable{TTimeout}})"/> can be used.
/// </remarks>
public static IObservable<TSource> Timeout<TSource>(this IObservable<TSource> source, DateTimeOffset dueTime, IObservable<TSource> other)
{
if (source == null)
throw new ArgumentNullException("source");
if (other == null)
throw new ArgumentNullException("other");
return s_impl.Timeout<TSource>(source, dueTime, other);
}
/// <summary>
/// Applies a timeout policy to the observable sequence based on an absolute time, using the specified scheduler to run timeout timers.
/// If the sequence doesn't terminate before the specified absolute due time, the other observable sequence is used to produce future messages from that point on.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence and the other sequence used upon a timeout.</typeparam>
/// <param name="source">Source sequence to perform a timeout for.</param>
/// <param name="dueTime">Time when a timeout occurs. If this value is less than or equal to DateTimeOffset.UtcNow, the timeout occurs immediately.</param>
/// <param name="other">Sequence to return in case of a timeout.</param>
/// <param name="scheduler">Scheduler to run the timeout timers on.</param>
/// <returns>The source sequence switching to the other sequence in case of a timeout.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="other"/> or <paramref name="scheduler"/> is null.</exception>
/// <remarks>
/// In case you only want to timeout on the first element, consider using the <see cref="Observable.Amb{TSource}(IObservable{TSource}, IObservable{TSource})"/>
/// operator applied to the source sequence and a delayed <see cref="Observable.Throw{TResult}(Exception)"/> sequence. Alternatively, the general-purpose overload
/// of Timeout, <see cref="Timeout{TSource, TTimeout}(IObservable{TSource}, IObservable{TTimeout}, Func{TSource, IObservable{TTimeout}})"/> can be used.
/// </remarks>
public static IObservable<TSource> Timeout<TSource>(this IObservable<TSource> source, DateTimeOffset dueTime, IObservable<TSource> other, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
if (other == null)
throw new ArgumentNullException("other");
return s_impl.Timeout<TSource>(source, dueTime, other, scheduler);
}
#endregion
#region Duration selector
/// <summary>
/// Applies a timeout policy to the observable sequence based on a timeout duration computed for each element.
/// If the next element isn't received within the computed duration starting from its predecessor, a TimeoutException is propagated to the observer.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <typeparam name="TTimeout">The type of the elements in the timeout sequences used to indicate the timeout duration for each element in the source sequence.</typeparam>
/// <param name="source">Source sequence to perform a timeout for.</param>
/// <param name="timeoutDurationSelector">Selector to retrieve an observable sequence that represents the timeout between the current element and the next element.</param>
/// <returns>The source sequence with a TimeoutException in case of a timeout.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="timeoutDurationSelector"/> is null.</exception>
public static IObservable<TSource> Timeout<TSource, TTimeout>(this IObservable<TSource> source, Func<TSource, IObservable<TTimeout>> timeoutDurationSelector)
{
if (source == null)
throw new ArgumentNullException("source");
if (timeoutDurationSelector == null)
throw new ArgumentNullException("timeoutDurationSelector");
return s_impl.Timeout<TSource, TTimeout>(source, timeoutDurationSelector);
}
/// <summary>
/// Applies a timeout policy to the observable sequence based on a timeout duration computed for each element.
/// If the next element isn't received within the computed duration starting from its predecessor, the other observable sequence is used to produce future messages from that point on.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence and the other sequence used upon a timeout.</typeparam>
/// <typeparam name="TTimeout">The type of the elements in the timeout sequences used to indicate the timeout duration for each element in the source sequence.</typeparam>
/// <param name="source">Source sequence to perform a timeout for.</param>
/// <param name="timeoutDurationSelector">Selector to retrieve an observable sequence that represents the timeout between the current element and the next element.</param>
/// <param name="other">Sequence to return in case of a timeout.</param>
/// <returns>The source sequence switching to the other sequence in case of a timeout.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="timeoutDurationSelector"/> or <paramref name="other"/> is null.</exception>
public static IObservable<TSource> Timeout<TSource, TTimeout>(this IObservable<TSource> source, Func<TSource, IObservable<TTimeout>> timeoutDurationSelector, IObservable<TSource> other)
{
if (source == null)
throw new ArgumentNullException("source");
if (timeoutDurationSelector == null)
throw new ArgumentNullException("timeoutDurationSelector");
if (other == null)
throw new ArgumentNullException("other");
return s_impl.Timeout<TSource, TTimeout>(source, timeoutDurationSelector, other);
}
/// <summary>
/// Applies a timeout policy to the observable sequence based on an initial timeout duration for the first element, and a timeout duration computed for each subsequent element.
/// If the next element isn't received within the computed duration starting from its predecessor, a TimeoutException is propagated to the observer.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <typeparam name="TTimeout">The type of the elements in the timeout sequences used to indicate the timeout duration for each element in the source sequence.</typeparam>
/// <param name="source">Source sequence to perform a timeout for.</param>
/// <param name="firstTimeout">Observable sequence that represents the timeout for the first element.</param>
/// <param name="timeoutDurationSelector">Selector to retrieve an observable sequence that represents the timeout between the current element and the next element.</param>
/// <returns>The source sequence with a TimeoutException in case of a timeout.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="firstTimeout"/> or <paramref name="timeoutDurationSelector"/> is null.</exception>
public static IObservable<TSource> Timeout<TSource, TTimeout>(this IObservable<TSource> source, IObservable<TTimeout> firstTimeout, Func<TSource, IObservable<TTimeout>> timeoutDurationSelector)
{
if (source == null)
throw new ArgumentNullException("source");
if (firstTimeout == null)
throw new ArgumentNullException("firstTimeout");
if (timeoutDurationSelector == null)
throw new ArgumentNullException("timeoutDurationSelector");
return s_impl.Timeout<TSource, TTimeout>(source, firstTimeout, timeoutDurationSelector);
}
/// <summary>
/// Applies a timeout policy to the observable sequence based on an initial timeout duration for the first element, and a timeout duration computed for each subsequent element.
/// If the next element isn't received within the computed duration starting from its predecessor, the other observable sequence is used to produce future messages from that point on.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence and the other sequence used upon a timeout.</typeparam>
/// <typeparam name="TTimeout">The type of the elements in the timeout sequences used to indicate the timeout duration for each element in the source sequence.</typeparam>
/// <param name="source">Source sequence to perform a timeout for.</param>
/// <param name="firstTimeout">Observable sequence that represents the timeout for the first element.</param>
/// <param name="timeoutDurationSelector">Selector to retrieve an observable sequence that represents the timeout between the current element and the next element.</param>
/// <param name="other">Sequence to return in case of a timeout.</param>
/// <returns>The source sequence switching to the other sequence in case of a timeout.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="firstTimeout"/> or <paramref name="timeoutDurationSelector"/> or <paramref name="other"/> is null.</exception>
public static IObservable<TSource> Timeout<TSource, TTimeout>(this IObservable<TSource> source, IObservable<TTimeout> firstTimeout, Func<TSource, IObservable<TTimeout>> timeoutDurationSelector, IObservable<TSource> other)
{
if (source == null)
throw new ArgumentNullException("source");
if (firstTimeout == null)
throw new ArgumentNullException("firstTimeout");
if (timeoutDurationSelector == null)
throw new ArgumentNullException("timeoutDurationSelector");
if (other == null)
throw new ArgumentNullException("other");
return s_impl.Timeout<TSource, TTimeout>(source, firstTimeout, timeoutDurationSelector, other);
}
#endregion
#endregion
#region + Timer +
/// <summary>
/// Returns an observable sequence that produces a single value after the specified relative due time has elapsed.
/// </summary>
/// <param name="dueTime">Relative time at which to produce the value. If this value is less than or equal to TimeSpan.Zero, the timer will fire as soon as possible.</param>
/// <returns>An observable sequence that produces a value after the due time has elapsed.</returns>
public static IObservable<long> Timer(TimeSpan dueTime)
{
return s_impl.Timer(dueTime);
}
/// <summary>
/// Returns an observable sequence that produces a single value at the specified absolute due time.
/// </summary>
/// <param name="dueTime">Absolute time at which to produce the value. If this value is less than or equal to DateTimeOffset.UtcNow, the timer will fire as soon as possible.</param>
/// <returns>An observable sequence that produces a value at due time.</returns>
public static IObservable<long> Timer(DateTimeOffset dueTime)
{
return s_impl.Timer(dueTime);
}
/// <summary>
/// Returns an observable sequence that periodically produces a value after the specified initial relative due time has elapsed.
/// </summary>
/// <param name="dueTime">Relative time at which to produce the first value. If this value is less than or equal to TimeSpan.Zero, the timer will fire as soon as possible.</param>
/// <param name="period">Period to produce subsequent values. If this value is equal to TimeSpan.Zero, the timer will recur as fast as possible.</param>
/// <returns>An observable sequence that produces a value after due time has elapsed and then after each period.</returns>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="period"/> is less than TimeSpan.Zero.</exception>
public static IObservable<long> Timer(TimeSpan dueTime, TimeSpan period)
{
if (period < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("period");
return s_impl.Timer(dueTime, period);
}
/// <summary>
/// Returns an observable sequence that periodically produces a value starting at the specified initial absolute due time.
/// </summary>
/// <param name="dueTime">Absolute time at which to produce the first value. If this value is less than or equal to DateTimeOffset.UtcNow, the timer will fire as soon as possible.</param>
/// <param name="period">Period to produce subsequent values. If this value is equal to TimeSpan.Zero, the timer will recur as fast as possible.</param>
/// <returns>An observable sequence that produces a value at due time and then after each period.</returns>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="period"/> is less than TimeSpan.Zero.</exception>
public static IObservable<long> Timer(DateTimeOffset dueTime, TimeSpan period)
{
if (period < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("period");
return s_impl.Timer(dueTime, period);
}
/// <summary>
/// Returns an observable sequence that produces a single value after the specified relative due time has elapsed, using the specified scheduler to run the timer.
/// </summary>
/// <param name="dueTime">Relative time at which to produce the value. If this value is less than or equal to TimeSpan.Zero, the timer will fire as soon as possible.</param>
/// <param name="scheduler">Scheduler to run the timer on.</param>
/// <returns>An observable sequence that produces a value after the due time has elapsed.</returns>
/// <exception cref="ArgumentNullException"><paramref name="scheduler"/> is null.</exception>
public static IObservable<long> Timer(TimeSpan dueTime, IScheduler scheduler)
{
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Timer(dueTime, scheduler);
}
/// <summary>
/// Returns an observable sequence that produces a single value at the specified absolute due time, using the specified scheduler to run the timer.
/// </summary>
/// <param name="dueTime">Absolute time at which to produce the value. If this value is less than or equal to DateTimeOffset.UtcNow, the timer will fire as soon as possible.</param>
/// <param name="scheduler">Scheduler to run the timer on.</param>
/// <returns>An observable sequence that produces a value at due time.</returns>
/// <exception cref="ArgumentNullException"><paramref name="scheduler"/> is null.</exception>
public static IObservable<long> Timer(DateTimeOffset dueTime, IScheduler scheduler)
{
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Timer(dueTime, scheduler);
}
/// <summary>
/// Returns an observable sequence that periodically produces a value after the specified initial relative due time has elapsed, using the specified scheduler to run timers.
/// </summary>
/// <param name="dueTime">Relative time at which to produce the first value. If this value is less than or equal to TimeSpan.Zero, the timer will fire as soon as possible.</param>
/// <param name="period">Period to produce subsequent values. If this value is equal to TimeSpan.Zero, the timer will recur as fast as possible.</param>
/// <param name="scheduler">Scheduler to run timers on.</param>
/// <returns>An observable sequence that produces a value after due time has elapsed and then each period.</returns>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="period"/> is less than TimeSpan.Zero.</exception>
/// <exception cref="ArgumentNullException"><paramref name="scheduler"/> is null.</exception>
public static IObservable<long> Timer(TimeSpan dueTime, TimeSpan period, IScheduler scheduler)
{
if (period < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("period");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Timer(dueTime, period, scheduler);
}
/// <summary>
/// Returns an observable sequence that periodically produces a value starting at the specified initial absolute due time, using the specified scheduler to run timers.
/// </summary>
/// <param name="dueTime">Absolute time at which to produce the first value. If this value is less than or equal to DateTimeOffset.UtcNow, the timer will fire as soon as possible.</param>
/// <param name="period">Period to produce subsequent values. If this value is equal to TimeSpan.Zero, the timer will recur as fast as possible.</param>
/// <param name="scheduler">Scheduler to run timers on.</param>
/// <returns>An observable sequence that produces a value at due time and then after each period.</returns>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="period"/> is less than TimeSpan.Zero.</exception>
/// <exception cref="ArgumentNullException"><paramref name="scheduler"/> is null.</exception>
public static IObservable<long> Timer(DateTimeOffset dueTime, TimeSpan period, IScheduler scheduler)
{
if (period < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("period");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Timer(dueTime, period, scheduler);
}
#endregion
#region + Timestamp +
/// <summary>
/// Timestamps each element in an observable sequence using the local system clock.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to timestamp elements for.</param>
/// <returns>An observable sequence with timestamp information on elements.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
public static IObservable<Timestamped<TSource>> Timestamp<TSource>(this IObservable<TSource> source)
{
if (source == null)
throw new ArgumentNullException("source");
return s_impl.Timestamp<TSource>(source);
}
/// <summary>
/// Timestamp each element in an observable sequence using the clock of the specified scheduler.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence.</typeparam>
/// <param name="source">Source sequence to timestamp elements for.</param>
/// <param name="scheduler">Scheduler used to compute timestamps.</param>
/// <returns>An observable sequence with timestamp information on elements.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
public static IObservable<Timestamped<TSource>> Timestamp<TSource>(this IObservable<TSource> source, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Timestamp<TSource>(source, scheduler);
}
#endregion
#region + Window +
#region TimeSpan only
/// <summary>
/// Projects each element of an observable sequence into consecutive non-overlapping windows which are produced based on timing information.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence, and in the windows in the result sequence.</typeparam>
/// <param name="source">Source sequence to produce windows over.</param>
/// <param name="timeSpan">Length of each window.</param>
/// <returns>The sequence of windows.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="timeSpan"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// Specifying a TimeSpan.Zero value for <paramref name="timeSpan"/> is not recommended but supported, causing the scheduler to create windows as fast as it can.
/// Because all source sequence elements end up in one of the windows, some windows won't have a zero time span. This is a side-effect of the asynchrony introduced
/// by the scheduler, where the action to close the current window and to create a new window may not execute immediately, despite the TimeSpan.Zero due time.
/// </remarks>
public static IObservable<IObservable<TSource>> Window<TSource>(this IObservable<TSource> source, TimeSpan timeSpan)
{
if (source == null)
throw new ArgumentNullException("source");
if (timeSpan < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("timeSpan");
return s_impl.Window<TSource>(source, timeSpan);
}
/// <summary>
/// Projects each element of an observable sequence into consecutive non-overlapping windows which are produced based on timing information, using the specified scheduler to run timers.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence, and in the windows in the result sequence.</typeparam>
/// <param name="source">Source sequence to produce windows over.</param>
/// <param name="timeSpan">Length of each window.</param>
/// <param name="scheduler">Scheduler to run windowing timers on.</param>
/// <returns>An observable sequence of windows.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="timeSpan"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// Specifying a TimeSpan.Zero value for <paramref name="timeSpan"/> is not recommended but supported, causing the scheduler to create windows as fast as it can.
/// Because all source sequence elements end up in one of the windows, some windows won't have a zero time span. This is a side-effect of the asynchrony introduced
/// by the scheduler, where the action to close the current window and to create a new window may not execute immediately, despite the TimeSpan.Zero due time.
/// </remarks>
public static IObservable<IObservable<TSource>> Window<TSource>(this IObservable<TSource> source, TimeSpan timeSpan, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (timeSpan < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("timeSpan");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Window<TSource>(source, timeSpan, scheduler);
}
/// <summary>
/// Projects each element of an observable sequence into zero or more windows which are produced based on timing information.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence, and in the windows in the result sequence.</typeparam>
/// <param name="source">Source sequence to produce windows over.</param>
/// <param name="timeSpan">Length of each window.</param>
/// <param name="timeShift">Interval between creation of consecutive windows.</param>
/// <returns>An observable sequence of windows.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="timeSpan"/> or <paramref name="timeSpan"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// <para>
/// Specifying a TimeSpan.Zero value for <paramref name="timeSpan"/> is not recommended but supported, causing the scheduler to create windows with minimum duration
/// length. However, some windows won't have a zero time span. This is a side-effect of the asynchrony introduced by the scheduler, where the action to close the
/// current window may not execute immediately, despite the TimeSpan.Zero due time.
/// </para>
/// <para>
/// Specifying a TimeSpan.Zero value for <paramref name="timeShift"/> is not recommended but supported, causing the scheduler to create windows as fast as it can.
/// However, this doesn't mean all windows will start at the beginning of the source sequence. This is a side-effect of the asynchrony introduced by the scheduler,
/// where the action to create a new window may not execute immediately, despite the TimeSpan.Zero due time.
/// </para>
/// </remarks>
public static IObservable<IObservable<TSource>> Window<TSource>(this IObservable<TSource> source, TimeSpan timeSpan, TimeSpan timeShift)
{
if (source == null)
throw new ArgumentNullException("source");
if (timeSpan < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("timeSpan");
if (timeShift < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("timeShift");
return s_impl.Window<TSource>(source, timeSpan, timeShift);
}
/// <summary>
/// Projects each element of an observable sequence into zero or more windows which are produced based on timing information, using the specified scheduler to run timers.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence, and in the windows in the result sequence.</typeparam>
/// <param name="source">Source sequence to produce windows over.</param>
/// <param name="timeSpan">Length of each window.</param>
/// <param name="timeShift">Interval between creation of consecutive windows.</param>
/// <param name="scheduler">Scheduler to run windowing timers on.</param>
/// <returns>An observable sequence of windows.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="timeSpan"/> or <paramref name="timeSpan"/> is less than TimeSpan.Zero.</exception>
/// <remarks>
/// <para>
/// Specifying a TimeSpan.Zero value for <paramref name="timeSpan"/> is not recommended but supported, causing the scheduler to create windows with minimum duration
/// length. However, some windows won't have a zero time span. This is a side-effect of the asynchrony introduced by the scheduler, where the action to close the
/// current window may not execute immediately, despite the TimeSpan.Zero due time.
/// </para>
/// <para>
/// Specifying a TimeSpan.Zero value for <paramref name="timeShift"/> is not recommended but supported, causing the scheduler to create windows as fast as it can.
/// However, this doesn't mean all windows will start at the beginning of the source sequence. This is a side-effect of the asynchrony introduced by the scheduler,
/// where the action to create a new window may not execute immediately, despite the TimeSpan.Zero due time.
/// </para>
/// </remarks>
public static IObservable<IObservable<TSource>> Window<TSource>(this IObservable<TSource> source, TimeSpan timeSpan, TimeSpan timeShift, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (timeSpan < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("timeSpan");
if (timeShift < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("timeShift");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Window<TSource>(source, timeSpan, timeShift, scheduler);
}
#endregion
#region TimeSpan + int
/// <summary>
/// Projects each element of an observable sequence into a window that is completed when either it's full or a given amount of time has elapsed.
/// A useful real-world analogy of this overload is the behavior of a ferry leaving the dock when all seats are taken, or at the scheduled time of departure, whichever event occurs first.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence, and in the windows in the result sequence.</typeparam>
/// <param name="source">Source sequence to produce windows over.</param>
/// <param name="timeSpan">Maximum time length of a window.</param>
/// <param name="count">Maximum element count of a window.</param>
/// <returns>An observable sequence of windows.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="timeSpan"/> is less than TimeSpan.Zero. -or- <paramref name="count"/> is less than or equal to zero.</exception>
/// <remarks>
/// Specifying a TimeSpan.Zero value for <paramref name="timeSpan"/> is not recommended but supported, causing the scheduler to create windows as fast as it can.
/// Because all source sequence elements end up in one of the windows, some windows won't have a zero time span. This is a side-effect of the asynchrony introduced
/// by the scheduler, where the action to close the current window and to create a new window may not execute immediately, despite the TimeSpan.Zero due time.
/// </remarks>
public static IObservable<IObservable<TSource>> Window<TSource>(this IObservable<TSource> source, TimeSpan timeSpan, int count)
{
if (source == null)
throw new ArgumentNullException("source");
if (timeSpan < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("timeSpan");
if (count <= 0)
throw new ArgumentOutOfRangeException("count");
return s_impl.Window<TSource>(source, timeSpan, count);
}
/// <summary>
/// Projects each element of an observable sequence into a window that is completed when either it's full or a given amount of time has elapsed, using the specified scheduler to run timers.
/// A useful real-world analogy of this overload is the behavior of a ferry leaving the dock when all seats are taken, or at the scheduled time of departure, whichever event occurs first.
/// </summary>
/// <typeparam name="TSource">The type of the elements in the source sequence, and in the windows in the result sequence.</typeparam>
/// <param name="source">Source sequence to produce windows over.</param>
/// <param name="timeSpan">Maximum time length of a window.</param>
/// <param name="count">Maximum element count of a window.</param>
/// <param name="scheduler">Scheduler to run windowing timers on.</param>
/// <returns>An observable sequence of windows.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> or <paramref name="scheduler"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="timeSpan"/> is less than TimeSpan.Zero. -or- <paramref name="count"/> is less than or equal to zero.</exception>
/// <remarks>
/// Specifying a TimeSpan.Zero value for <paramref name="timeSpan"/> is not recommended but supported, causing the scheduler to create windows as fast as it can.
/// Because all source sequence elements end up in one of the windows, some windows won't have a zero time span. This is a side-effect of the asynchrony introduced
/// by the scheduler, where the action to close the current window and to create a new window may not execute immediately, despite the TimeSpan.Zero due time.
/// </remarks>
public static IObservable<IObservable<TSource>> Window<TSource>(this IObservable<TSource> source, TimeSpan timeSpan, int count, IScheduler scheduler)
{
if (source == null)
throw new ArgumentNullException("source");
if (timeSpan < TimeSpan.Zero)
throw new ArgumentOutOfRangeException("timeSpan");
if (count <= 0)
throw new ArgumentOutOfRangeException("count");
if (scheduler == null)
throw new ArgumentNullException("scheduler");
return s_impl.Window<TSource>(source, timeSpan, count, scheduler);
}
#endregion
#endregion
}
}
|