aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Framework/CnmMemoryCache.cs
blob: 6ca71ecbd8e5f428c98e2f3eedcca79b91224524 (plain)
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
// --------------------------------------------------------------------------------------------------------------------
// <copyright company="" file="CnmMemoryCache.cs">
//   
// </copyright>
// <summary>
//   
// </summary>
// --------------------------------------------------------------------------------------------------------------------

using System;
using System.Collections;
using System.Collections.Generic;
using System.Diagnostics;

namespace OpenSim.Framework
{
    /// <summary>
    /// Cenome memory based cache to store key/value pairs (elements) limited time and/or limited size.
    /// </summary>
    /// <typeparam name="TKey">
    /// The type of keys in the cache. 
    /// </typeparam>
    /// <typeparam name="TValue">
    /// The type of values in the dictionary. 
    /// </typeparam>
    /// <remarks>
    /// <para>
    /// Cenome memory cache stores elements to hash table generations. When new element is being added to cache, and new size would exceed 
    /// maximal allowed size or maximal amount of allowed element count, then elements in oldest generation are deleted. Last access time
    /// is also tracked in generation level - thus it is possible that some elements are staying in cache far beyond their expiration time.
    /// If elements in older generations are accessed through <see cref="TryGetValue"/> method, they are moved to newest generation.
    /// </para>
    /// </remarks>
    public class CnmMemoryCache<TKey, TValue> : ICnmCache<TKey, TValue>
    {
        /// <summary>
        /// Default maximal count.
        /// </summary>
        /// <seealso cref="MaxCount"/>
        public const int DefaultMaxCount = 4096;

        /// <summary>
        /// Default maximal size.
        /// </summary>
        /// <remarks>
        /// <para>
        /// 128MB = 128 * 1024^2 = 134 217 728 bytes.
        /// </para>
        /// </remarks>
        /// <seealso cref="MaxSize"/>
        public const long DefaultMaxSize = 134217728;

        /// <summary>
        /// How many operations between time checks.
        /// </summary>        
        private const int DefaultOperationsBetweenTimeChecks = 40;

        /// <summary>
        /// Default expiration time.
        /// </summary>
        /// <remarks>
        /// <para>
        /// 30 minutes.
        /// </para>
        /// </remarks>
        public static readonly TimeSpan DefaultExpirationTime = TimeSpan.FromMinutes( 30.0 );

        /// <summary>
        /// Minimal allowed expiration time.
        /// </summary>
        /// <remarks>
        /// <para>
        /// 5 minutes.
        /// </para>
        /// </remarks>
        public static readonly TimeSpan MinExpirationTime = TimeSpan.FromSeconds( 10.0 );

        /// <summary>
        /// Comparer used to compare element keys.
        /// </summary>
        /// <remarks>
        /// Comparer is initialized by constructor.
        /// </remarks>
        /// <seealso cref="CnmMemoryCache{TKey,TValue}"/>
        public readonly IEqualityComparer<TKey> Comparer;

        /// <summary>
        /// Expiration time.
        /// </summary>
        private TimeSpan m_expirationTime = DefaultExpirationTime;

        /// <summary>
        /// Generation bucket count.
        /// </summary>
        private int m_generationBucketCount;

        /// <summary>
        /// Generation entry count.
        /// </summary>
        private int m_generationElementCount;

        /// <summary>
        /// Generation max size.
        /// </summary>
        private long m_generationMaxSize;

        /// <summary>
        /// Maximal allowed count of elements.
        /// </summary>
        private int m_maxCount;

        /// <summary>
        /// Maximal allowed total size of elements.
        /// </summary>
        private long m_maxElementSize;

        /// <summary>
        /// Maximal size.
        /// </summary>
        private long m_maxSize;

        /// <summary>
        /// New generation.
        /// </summary>
        private IGeneration m_newGeneration;

        /// <summary>
        /// Old generation.
        /// </summary>
        private IGeneration m_oldGeneration;

        /// <summary>
        /// Operations between time check.
        /// </summary>
        private int m_operationsBetweenTimeChecks = DefaultOperationsBetweenTimeChecks;

        /// <summary>
        /// Synchronization root object, should always be private and exists always
        /// </summary>
        private readonly object m_syncRoot = new object();

        /// <summary>
        /// Version of cache.
        /// </summary>
        /// <remarks>
        /// <para>
        /// Updated every time when cache has been changed (element removed, expired, added, replaced).
        /// </para>
        /// </remarks>
        private int m_version;

        /// <summary>
        /// Initializes a new instance of the <see cref="CnmMemoryCache{TKey,TValue}"/> class.         
        /// </summary>
        public CnmMemoryCache()
            : this( DefaultMaxSize )
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="CnmMemoryCache{TKey,TValue}"/> class. 
        /// </summary>
        /// <param name="maximalSize">
        /// Maximal cache size.
        /// </param>
        public CnmMemoryCache( long maximalSize )
            : this( maximalSize, DefaultMaxCount )
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="CnmMemoryCache{TKey,TValue}"/> class.
        /// </summary>
        /// <param name="maximalSize">
        /// Maximal cache size.
        /// </param>
        /// <param name="maximalCount">
        /// Maximal element count.
        /// </param>
        public CnmMemoryCache( long maximalSize, int maximalCount )
            : this( maximalSize, maximalCount, DefaultExpirationTime )
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="CnmMemoryCache{TKey,TValue}"/> class. 
        /// </summary>
        /// <param name="maximalSize">
        /// Maximal cache size.
        /// </param>
        /// <param name="maximalCount">
        /// Maximal element count.
        /// </param>
        /// <param name="expirationTime">
        /// Elements expiration time.
        /// </param>
        public CnmMemoryCache( long maximalSize, int maximalCount, TimeSpan expirationTime )
            : this( maximalSize, maximalCount, expirationTime, EqualityComparer<TKey>.Default )
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="CnmMemoryCache{TKey,TValue}"/> class. 
        /// </summary>
        /// <param name="maximalSize">
        /// Maximal cache size.
        /// </param>
        /// <param name="maximalCount">
        /// Maximal element count.
        /// </param>
        /// <param name="expirationTime">
        /// Elements expiration time.
        /// </param>
        /// <param name="comparer">
        /// Comparer used for comparing elements.
        /// </param>
        /// <exception cref="ArgumentNullException">
        /// <see cref="comparer"/>is <see langword="null"/> reference.
        /// </exception>
        public CnmMemoryCache( long maximalSize,
            int maximalCount,
            TimeSpan expirationTime,
            IEqualityComparer<TKey> comparer )
        {
            if( comparer == null )
                throw new ArgumentNullException( "comparer" );

            if( expirationTime < MinExpirationTime )
                expirationTime = MinExpirationTime;
            if( maximalCount < 8 )
                maximalCount = 8;
            if( maximalSize < 8 )
                maximalSize = 8;
            if( maximalCount > maximalSize )
                maximalCount = (int) maximalSize;

            Comparer = comparer;
            m_expirationTime = expirationTime;
            m_maxSize = maximalSize;
            m_maxCount = maximalCount;

            Initialize();
        }

        /// <summary>
        /// Add element to new generation.
        /// </summary>
        /// <param name="bucketIndex">
        /// The bucket index.
        /// </param>
        /// <param name="key">
        /// The element's key.
        /// </param>
        /// <param name="value">
        /// The element's value.
        /// </param>
        /// <param name="size">
        /// The element's size.
        /// </param>
        protected virtual void AddToNewGeneration( int bucketIndex, TKey key, TValue value, long size )
        {
            // Add to newest generation    
            if( !m_newGeneration.Set( bucketIndex, key, value, size ) )
            {
                // Failed to add new generation
                RecycleGenerations();
                m_newGeneration.Set( bucketIndex, key, value, size );
            }

            m_version++;
        }

        /// <summary>
        /// <para>
        /// Get keys bucket index.
        /// </para>
        /// </summary>
        /// <param name="key">
        /// <para>
        /// Key which bucket index is being retrieved.
        /// </para>
        /// </param>
        /// <returns>
        /// <para>
        /// Bucket index.
        /// </para>
        /// </returns>
        /// <remarks>
        /// <para>
        /// Method uses <see cref="Comparer"/> to calculate <see cref="key"/> hash code.
        /// </para>
        /// <para>
        /// Bucket index is remainder when element key's hash value is divided by bucket count.
        /// </para>
        /// <para>
        /// For example: key's hash is 72, bucket count is 5, element's bucket index is 72 % 5 = 2.        
        /// </para>
        /// </remarks>
        protected virtual int GetBucketIndex( TKey key )
        {
            return (Comparer.GetHashCode( key ) & 0x7FFFFFFF) % m_generationBucketCount;
        }

        /// <summary>
        /// Purge generation from the cache.
        /// </summary>
        /// <param name="generation">
        /// The generation that is purged.
        /// </param>
        protected virtual void PurgeGeneration( IGeneration generation )
        {
            generation.Clear();
            m_version++;
        }

        /// <summary>
        /// check expired.
        /// </summary>
        private void CheckExpired()
        {
            // Do this only one in every m_operationsBetweenTimeChecks 
            // Fetching time is using several millisecons - it is better not to do all time.
            m_operationsBetweenTimeChecks--;
            if( m_operationsBetweenTimeChecks <= 0 )
                PurgeExpired();
        }

        /// <summary>
        /// Initialize cache.
        /// </summary>
        private void Initialize()
        {
            m_version++;

            m_generationMaxSize = MaxSize / 2;
            MaxElementSize = MaxSize / 8;
            m_generationElementCount = MaxCount / 2;

            // Buckets need to be prime number to get better spread of hash values
            m_generationBucketCount = PrimeNumberHelper.GetPrime( m_generationElementCount );

            m_newGeneration = new HashGeneration( this );
            m_oldGeneration = new HashGeneration( this );
            m_oldGeneration.MakeOld();
        }

        /// <summary>
        /// Recycle generations.
        /// </summary>
        private void RecycleGenerations()
        {
            // Rotate old generation to new generation, new generation to old generation            
            IGeneration temp = m_newGeneration;
            m_newGeneration = m_oldGeneration;
            m_newGeneration.Clear();
            m_oldGeneration = temp;
            m_oldGeneration.MakeOld();
        }

        #region Nested type: Enumerator

        /// <summary>
        /// Key and value pair enumerator.
        /// </summary>
        private class Enumerator : IEnumerator<KeyValuePair<TKey, TValue>>
        {
            /// <summary>
            /// Current enumerator.
            /// </summary>
            private int m_currentEnumerator = -1;

            /// <summary>
            /// Enumerators to different generations.
            /// </summary>
            private readonly IEnumerator<KeyValuePair<TKey, TValue>>[] m_generationEnumerators =
                new IEnumerator<KeyValuePair<TKey, TValue>>[2];

            /// <summary>
            /// Initializes a new instance of the <see cref="Enumerator"/> class. 
            /// </summary>
            /// <param name="cache">
            /// The cache.
            /// </param>
            public Enumerator( CnmMemoryCache<TKey, TValue> cache )
            {
                m_generationEnumerators[ 0 ] = cache.m_newGeneration.GetEnumerator();
                m_generationEnumerators[ 1 ] = cache.m_oldGeneration.GetEnumerator();
            }

            #region IEnumerator<KeyValuePair<TKey,TValue>> Members

            /// <summary>
            /// Gets the element in the collection at the current position of the enumerator.
            /// </summary>
            /// <returns>
            /// The element in the collection at the current position of the enumerator.
            /// </returns>
            /// <exception cref="InvalidOperationException">
            /// The enumerator has reach end of collection or <see cref="MoveNext"/> is not called.
            /// </exception>
            public KeyValuePair<TKey, TValue> Current
            {
                get
                {
                    if( m_currentEnumerator == -1 || m_currentEnumerator >= m_generationEnumerators.Length )
                        throw new InvalidOperationException();

                    return m_generationEnumerators[ m_currentEnumerator ].Current;
                }
            }

            /// <summary>
            /// Gets the current element in the collection.
            /// </summary>
            /// <returns>
            /// The current element in the collection.
            /// </returns>
            /// <exception cref="T:System.InvalidOperationException">
            /// The enumerator is positioned before the first element of the collection or after the last element.
            /// </exception><filterpriority>2</filterpriority>
            object IEnumerator.Current
            {
                get { return Current; }
            }

            /// <summary>
            /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
            /// </summary>
            /// <filterpriority>2</filterpriority>
            public void Dispose()
            {
            }

            /// <summary>
            /// Advances the enumerator to the next element of the collection.
            /// </summary>
            /// <returns>
            /// <see langword="true"/>if the enumerator was successfully advanced to the next element; <see langword="false"/> if the enumerator has passed the end of the collection.
            /// </returns>
            /// <exception cref="T:System.InvalidOperationException">
            /// The collection was modified after the enumerator was created. 
            /// </exception>
            /// <filterpriority>2</filterpriority>
            public bool MoveNext()
            {
                if( m_currentEnumerator == -1 )
                    m_currentEnumerator = 0;

                while( m_currentEnumerator < m_generationEnumerators.Length )
                {
                    if( m_generationEnumerators[ m_currentEnumerator ].MoveNext() )
                        return true;

                    m_currentEnumerator++;
                }

                return false;
            }

            /// <summary>
            /// Sets the enumerator to its initial position, which is before the first element in the collection.
            /// </summary>
            /// <exception cref="T:System.InvalidOperationException">
            /// The collection was modified after the enumerator was created. 
            /// </exception>
            /// <filterpriority>2</filterpriority>
            public void Reset()
            {
                foreach( IEnumerator<KeyValuePair<TKey, TValue>> enumerator in m_generationEnumerators )
                {
                    enumerator.Reset();
                }

                m_currentEnumerator = -1;
            }

            #endregion
        }

        #endregion

        #region Nested type: HashGeneration

        /// <summary>
        /// Hash generation class
        /// </summary>
        /// <remarks>
        /// <para>
        /// Current implementation is based to separated chaining with move-to-front heuristics. Hash generations have fixed
        /// amount of buckets and it is never rehashed.
        /// </para>
        /// <para>
        /// Read more about hash tables from <a href="http://en.wikipedia.org/wiki/Hash_table">Wiki article</a>.
        /// </para>
        /// </remarks>
        /// <seealso href="http://en.wikipedia.org/wiki/Hash_table"/>
        private class HashGeneration : IGeneration
        {
            /// <summary>
            /// Value indicating whether generation was accessed since last time check.
            /// </summary>
            private bool m_accessedSinceLastTimeCheck;

            /// <summary>
            /// Index of first element's in element chain.
            /// </summary>
            /// <value>                        
            /// -1 if there is no element in bucket; otherwise first element's index in the element chain.
            /// </value>
            /// <remarks>
            /// Bucket index is remainder when element key's hash value is divided by bucket count.
            /// For example: key's hash is 72, bucket count is 5, element's bucket index is 72 % 5 = 2.
            /// </remarks>
            private readonly int[] m_buckets;

            /// <summary>
            /// Cache object.
            /// </summary>
            private readonly CnmMemoryCache<TKey, TValue> m_cache;

            /// <summary>
            /// Generation's element array.
            /// </summary>
            /// <seealso cref="Element"/>
            private readonly Element[] m_elements;

            /// <summary>
            /// Generation's expiration time.
            /// </summary>
            private DateTime m_expirationTime1;

            /// <summary>
            /// Index to first free element. 
            /// </summary>
            private int m_firstFreeElement;

            /// <summary>
            /// Free element count.
            /// </summary>
            /// <remarks>
            /// When generation is cleared or constructed, this is NOT set to element count.
            /// This is only tracking elements that are removed and are currently free.
            /// </remarks>
            private int m_freeCount;

            /// <summary>
            /// Is this generation "new generation".
            /// </summary>
            private bool m_newGeneration;

            /// <summary>
            /// Next unused entry.
            /// </summary>
            private int m_nextUnusedElement;

            /// <summary>
            /// Size of data stored to generation.
            /// </summary>
            private long m_size;

            /// <summary>
            /// Initializes a new instance of the <see cref="HashGeneration"/> class.
            /// </summary>
            /// <param name="cache">
            /// The cache.
            /// </param>
            public HashGeneration( CnmMemoryCache<TKey, TValue> cache )
            {
                m_cache = cache;
                m_elements = new Element[m_cache.m_generationElementCount];
                m_buckets = new int[m_cache.m_generationBucketCount];
                Clear();
            }

            /// <summary>
            /// Find element's index
            /// </summary>
            /// <param name="bucketIndex">
            /// The element's bucket index.
            /// </param>
            /// <param name="key">
            /// The element's key.
            /// </param>
            /// <param name="moveToFront">
            /// Move element to front of elements.
            /// </param>
            /// <param name="previousIndex">
            /// The previous element's index.
            /// </param>
            /// <returns>
            /// Element's index, if found from the generation; -1 otherwise (if element is not found the generation).
            /// </returns>
            private int FindElementIndex( int bucketIndex, TKey key, bool moveToFront, out int previousIndex )
            {
                previousIndex = -1;
                int elementIndex = m_buckets[ bucketIndex ];
                while( elementIndex >= 0 )
                {
                    if( m_cache.Comparer.Equals( key, m_elements[ elementIndex ].Key ) )
                    {
                        // Found match
                        if( moveToFront && previousIndex >= 0 )
                        {
                            // Move entry to front
                            m_elements[ previousIndex ].Next = m_elements[ elementIndex ].Next;
                            m_elements[ elementIndex ].Next = m_buckets[ bucketIndex ];
                            m_buckets[ bucketIndex ] = elementIndex;
                            previousIndex = 0;
                        }

                        return elementIndex;
                    }

                    previousIndex = elementIndex;
                    elementIndex = m_elements[ elementIndex ].Next;
                }

                return -1;
            }

            /// <summary>
            /// Remove element front the generation.
            /// </summary>
            /// <param name="bucketIndex">
            /// The bucket index.
            /// </param>
            /// <param name="entryIndex">
            /// The element index.
            /// </param>
            /// <param name="previousIndex">
            /// The element's previous index.
            /// </param>
            private void RemoveElement( int bucketIndex, int entryIndex, int previousIndex )
            {
                if( previousIndex >= 0 )
                    m_elements[ previousIndex ].Next = m_elements[ entryIndex ].Next;
                else
                    m_buckets[ bucketIndex ] = m_elements[ entryIndex ].Next;

                Size -= m_elements[ entryIndex ].Size;
                m_elements[ entryIndex ].Value = default(TValue);
                m_elements[ entryIndex ].Key = default(TKey);

                // Add element to free elements list
                m_elements[ entryIndex ].Next = m_firstFreeElement;
                m_firstFreeElement = entryIndex;
                m_freeCount++;
            }

            #region Nested type: Element

            /// <summary>
            /// Element that stores key, next element in chain, size and value.
            /// </summary>
            private struct Element
            {
                /// <summary>
                /// Element's key.
                /// </summary>
                public TKey Key;

                /// <summary>
                /// Next element in chain.
                /// </summary>
                /// <remarks>
                /// When element have value (something is stored to it), this is index of 
                /// next element with same bucket index. When element is free, this 
                /// is index of next element in free element's list.
                /// </remarks>
                public int Next;

                /// <summary>
                /// Size of element.
                /// </summary>
                /// <value>
                /// 0 if element is free; otherwise larger than 0.
                /// </value>              
                public long Size;

                /// <summary>
                /// Element's value. 
                /// </summary>
                /// <remarks>
                /// It is possible that this value is <see langword="null"/> even when element
                /// have value - element's value is then <see langword="null"/> reference.
                /// </remarks>
                public TValue Value;

                /// <summary>
                /// Gets a value indicating whether element is free or have value.
                /// </summary>
                /// <value>
                /// <see langword="true"/> when element is free; otherwise <see langword="false"/>.
                /// </value>
                public bool IsFree
                {
                    get { return Size == 0; }
                }
            }

            #endregion

            #region Nested type: Enumerator

            /// <summary>
            /// Key value pair enumerator for <see cref="HashGeneration"/> object.
            /// </summary>
            private class Enumerator : IEnumerator<KeyValuePair<TKey, TValue>>
            {
                /// <summary>
                /// Current element.
                /// </summary>
                private KeyValuePair<TKey, TValue> m_current;

                /// <summary>
                /// Current index.
                /// </summary>
                private int m_currentIndex;

                /// <summary>
                /// Generation that is being enumerated.
                /// </summary>
                private readonly HashGeneration m_generation;

                /// <summary>
                /// Cache version.
                /// </summary>
                /// <remarks>
                /// When cache is change, version number is changed.
                /// </remarks>
                /// <seealso cref="CnmMemoryCache{TKey,TValue}.m_version"/>
                private readonly int m_version;

                /// <summary>
                /// Initializes a new instance of the <see cref="Enumerator"/> class.
                /// </summary>
                /// <param name="generation">
                /// The generation.
                /// </param>
                public Enumerator( HashGeneration generation )
                {
                    m_generation = generation;
                    m_version = m_generation.m_cache.m_version;
                }

                #region IEnumerator<KeyValuePair<TKey,TValue>> Members

                /// <summary>
                /// Gets the element in the collection at the current position of the enumerator.
                /// </summary>
                /// <returns>
                /// The element in the collection at the current position of the enumerator.
                /// </returns>
                /// <exception cref="InvalidOperationException">
                /// The enumerator has reach end of collection or <see cref="MoveNext"/> is not called.
                /// </exception>              
                public KeyValuePair<TKey, TValue> Current
                {
                    get
                    {
                        if( m_currentIndex == 0 || m_currentIndex >= m_generation.Count )
                            throw new InvalidOperationException();

                        return m_current;
                    }
                }

                /// <summary>
                /// Gets the current element in the collection.
                /// </summary>
                /// <returns>
                /// The current element in the collection.
                /// </returns>
                /// <exception cref="InvalidOperationException">
                /// The enumerator is positioned before the first element of the collection or after the last element.
                /// </exception><filterpriority>2</filterpriority>
                object IEnumerator.Current
                {
                    get { return Current; }
                }

                /// <summary>
                /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
                /// </summary>
                /// <filterpriority>2</filterpriority>
                public void Dispose()
                {
                }

                /// <summary>
                /// Advances the enumerator to the next element of the collection.
                /// </summary>
                /// <returns>
                /// true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.
                /// </returns>
                /// <exception cref="InvalidOperationException">
                /// The collection was modified after the enumerator was created. 
                /// </exception>
                public bool MoveNext()
                {
                    if( m_version != m_generation.m_cache.m_version )
                        throw new InvalidOperationException();

                    while( m_currentIndex < m_generation.Count )
                    {
                        if( m_generation.m_elements[ m_currentIndex ].IsFree )
                        {
                            m_currentIndex++;
                            continue;
                        }

                        m_current = new KeyValuePair<TKey, TValue>( m_generation.m_elements[ m_currentIndex ].Key,
                            m_generation.m_elements[ m_currentIndex ].Value );
                        m_currentIndex++;
                        return true;
                    }

                    m_current = new KeyValuePair<TKey, TValue>();
                    return false;
                }

                /// <summary>
                /// Sets the enumerator to its initial position, which is before the first element in the collection.
                /// </summary>
                /// <exception cref="InvalidOperationException">
                /// The collection was modified after the enumerator was created. 
                /// </exception>
                /// <filterpriority>2</filterpriority>
                public void Reset()
                {
                    if( m_version != m_generation.m_cache.m_version )
                        throw new InvalidOperationException();

                    m_currentIndex = 0;
                }

                #endregion
            }

            #endregion

            #region IGeneration Members

            /// <summary>
            /// Gets or sets a value indicating whether generation was accessed since last time check.
            /// </summary>
            public bool AccessedSinceLastTimeCheck
            {
                get { return m_accessedSinceLastTimeCheck; }

                set { m_accessedSinceLastTimeCheck = value; }
            }

            /// <summary>
            /// Gets element count in generation.
            /// </summary>
            public int Count
            {
                get { return m_nextUnusedElement - m_freeCount; }
            }

            /// <summary>
            /// Gets or sets generation's expiration time.
            /// </summary>
            public DateTime ExpirationTime
            {
                get { return m_expirationTime1; }

                set { m_expirationTime1 = value; }
            }

            /// <summary>
            /// Gets or sets size of data stored to generation.
            /// </summary>
            public long Size
            {
                get { return m_size; }

                private set { m_size = value; }
            }

            /// <summary>
            /// Clear all elements from the generation and make generation new again.
            /// </summary>
            /// <remarks>
            /// When generation is new, it is allowed to add new elements to it and
            /// <see cref="IGeneration.TryGetValue"/>doesn't remove elements from it.
            /// </remarks>
            /// <seealso cref="IGeneration.MakeOld"/>
            public void Clear()
            {
                for( int i = m_buckets.Length - 1 ; i >= 0 ; i-- )
                {
                    m_buckets[ i ] = -1;
                }

                Array.Clear( m_elements, 0, m_elements.Length );
                Size = 0;
                m_firstFreeElement = -1;
                m_freeCount = 0;
                m_nextUnusedElement = 0;
                m_newGeneration = true;
                ExpirationTime = DateTime.MaxValue;
            }

            /// <summary>
            /// Determines whether the <see cref="IGeneration"/> contains an element with the specific key.
            /// </summary>
            /// <param name="bucketIndex">
            /// The bucket index for the <see cref="key"/> to locate in <see cref="IGeneration"/>.
            /// </param>
            /// <param name="key">
            /// The key to locate in the <see cref="IGeneration"/>.
            /// </param>
            /// <returns>
            /// <see langword="true"/>if the <see cref="IGeneration"/> contains an element with the <see cref="key"/>; 
            /// otherwise <see langword="false"/>.
            /// </returns>
            public bool Contains( int bucketIndex, TKey key )
            {
                int previousIndex;
                if( FindElementIndex( bucketIndex, key, true, out previousIndex ) == -1 )
                    return false;

                AccessedSinceLastTimeCheck = true;
                return true;
            }

            /// <summary>
            /// Returns an enumerator that iterates through the elements stored <see cref="HashGeneration"/>.
            /// </summary>
            /// <returns>
            /// A <see cref="IEnumerator"/> that can be used to iterate through the <see cref="HashGeneration"/>.
            /// </returns>
            /// <filterpriority>1</filterpriority>
            public IEnumerator<KeyValuePair<TKey, TValue>> GetEnumerator()
            {
                return new Enumerator( this );
            }

            /// <summary>
            /// Make from generation old generation.
            /// </summary>
            /// <remarks>
            /// When generation is old, <see cref="IGeneration.TryGetValue"/> hit removes element from the generation.
            /// </remarks>
            /// <seealso cref="IGeneration.Clear"/>
            public void MakeOld()
            {
                m_newGeneration = false;
            }

            /// <summary>
            /// Remove element associated with the key from the generation.
            /// </summary>
            /// <param name="bucketIndex">
            /// The element's bucket index.
            /// </param>
            /// <param name="key">
            /// The element's key.
            /// </param>
            /// <returns>
            /// <see langword="true"/>, if remove was successful; otherwise <see langword="false"/>.
            /// </returns>
            public bool Remove( int bucketIndex, TKey key )
            {
                int previousIndex;
                int entryIndex = FindElementIndex( bucketIndex, key, false, out previousIndex );
                if( entryIndex != -1 )
                {
                    RemoveElement( bucketIndex, entryIndex, previousIndex );
                    AccessedSinceLastTimeCheck = true;
                    return true;
                }

                return false;
            }

            /// <summary>
            /// Set or add element to generation.
            /// </summary>
            /// <param name="bucketIndex">
            /// The element's bucket index.
            /// </param>
            /// <param name="key">
            /// The element's key.
            /// </param>
            /// <param name="value">
            /// The element's value.
            /// </param>
            /// <param name="size">
            /// The element's size.
            /// </param>
            /// <returns>
            /// <see langword="true"/>, if setting or adding was successful; otherwise <see langword="false"/>.
            /// </returns>
            /// <remarks>
            /// <para>
            /// If element was already existing in generation and new element size fits to collection limits, 
            /// then it's value is replaced with new one and size information is updated. If element didn't
            /// exists in generation before, then generation must have empty space for a new element and
            /// size must fit generation's limits, before element is added to generation.
            /// </para>
            /// </remarks>
            public bool Set( int bucketIndex, TKey key, TValue value, long size )
            {
                Debug.Assert( m_newGeneration, "It is possible to insert new elements only to newest generation." );
                Debug.Assert( size > 0, "New element size should be more than 0." );

                int previousIndex;
                int elementIndex = FindElementIndex( bucketIndex, key, true, out previousIndex );
                if( elementIndex == -1 )
                {
                    // New key
                    if( Size + size > m_cache.m_generationMaxSize ||
                        (m_nextUnusedElement == m_cache.m_generationElementCount && m_freeCount == 0) )
                    {
                        // Generation is full
                        return false;
                    }

                    // Increase size of generation
                    Size += size;

                    // Get first free entry and update free entry list
                    if( m_firstFreeElement != -1 )
                    {
                        // There was entry that was removed
                        elementIndex = m_firstFreeElement;
                        m_firstFreeElement = m_elements[ elementIndex ].Next;
                        m_freeCount--;
                    }
                    else
                    {
                        // No entries removed so far - just take a last one
                        elementIndex = m_nextUnusedElement;
                        m_nextUnusedElement++;
                    }

                    Debug.Assert( m_elements[ elementIndex ].IsFree, "Allocated element is not free." );

                    // Move new entry to front
                    m_elements[ elementIndex ].Next = m_buckets[ bucketIndex ];
                    m_buckets[ bucketIndex ] = elementIndex;

                    // Set key and update count
                    m_elements[ elementIndex ].Key = key;
                }
                else
                {
                    // Existing key
                    if( Size - m_elements[ elementIndex ].Size + size > m_cache.m_generationMaxSize )
                    {
                        // Generation is full
                        // Remove existing element, because generation is going to be recycled to 
                        // old generation and element is stored to new generation
                        RemoveElement( bucketIndex, elementIndex, previousIndex );
                        return false;
                    }

                    // Update generation's size
                    Size = Size - m_elements[ elementIndex ].Size + size;
                }

                // Finally set value and size
                m_elements[ elementIndex ].Value = value;
                m_elements[ elementIndex ].Size = size;

                // Success - key was inserterted to generation
                AccessedSinceLastTimeCheck = true;
                return true;
            }

            /// <summary>
            /// Try to get element associated with key.
            /// </summary>
            /// <param name="bucketIndex">
            /// The element's bucket index.
            /// </param>
            /// <param name="key">
            /// The element's key.
            /// </param>
            /// <param name="value">
            /// The element's value.
            /// </param>
            /// <param name="size">
            /// The element's size.
            /// </param>
            /// <returns>
            /// <see langword="true"/>, if element was successful retrieved; otherwise <see langword="false"/>.
            /// </returns>
            /// <remarks>
            /// <para>
            /// If element is not found from generation then <paramref name="value"/> and <paramref name="size"/>
            /// are set to default value (default(TValue) and 0). 
            /// </para>
            /// </remarks>
            public bool TryGetValue( int bucketIndex, TKey key, out TValue value, out long size )
            {
                // Find entry index, 
                int previousIndex;
                int elementIndex = FindElementIndex( bucketIndex, key, m_newGeneration, out previousIndex );
                if( elementIndex == -1 )
                {
                    value = default(TValue);
                    size = 0;
                    return false;
                }

                value = m_elements[ elementIndex ].Value;
                size = m_elements[ elementIndex ].Size;

                if( !m_newGeneration )
                {
                    // Old generation - remove element, because it is moved to new generation
                    RemoveElement( bucketIndex, elementIndex, previousIndex );
                }

                AccessedSinceLastTimeCheck = true;
                return true;
            }

            /// <summary>
            /// Returns an enumerator that iterates through a collection.
            /// </summary>
            /// <returns>
            /// An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
            /// </returns>
            /// <filterpriority>2</filterpriority>
            IEnumerator IEnumerable.GetEnumerator()
            {
                return GetEnumerator();
            }

            #endregion
        }

        #endregion

        #region Nested type: IGeneration

        /// <summary>
        /// Cache element generation interface
        /// </summary>
        /// <remarks>
        /// <para>
        /// Generation can hold limited count of elements and limited size of data.
        /// </para>
        /// <para>
        /// There are two kind generations: "new generation" and "old generation(s)". All new elements
        /// are added to "new generation". 
        /// </para>
        /// </remarks>
        protected interface IGeneration : IEnumerable<KeyValuePair<TKey, TValue>>
        {
            /// <summary>
            /// Gets or sets a value indicating whether generation was accessed since last time check.
            /// </summary>
            bool AccessedSinceLastTimeCheck { get; set; }

            /// <summary>
            /// Gets element count in generation.
            /// </summary>
            int Count { get; }

            /// <summary>
            /// Gets or sets generation's expiration time.
            /// </summary>
            DateTime ExpirationTime { get; set; }

            /// <summary>
            /// Gets size of data stored to generation.
            /// </summary>
            long Size { get; }

            /// <summary>
            /// Clear all elements from the generation and make generation new again.
            /// </summary>
            /// <remarks>
            /// When generation is new, it is allowed to add new elements to it and
            /// <see cref="TryGetValue"/>doesn't remove elements from it.
            /// </remarks>
            /// <seealso cref="MakeOld"/>
            void Clear();

            /// <summary>
            /// Determines whether the <see cref="IGeneration"/> contains an element with the specific key.
            /// </summary>
            /// <param name="bucketIndex">
            /// The bucket index for the <see cref="key"/> to locate in <see cref="IGeneration"/>.
            /// </param>
            /// <param name="key">
            /// The key to locate in the <see cref="IGeneration"/>.
            /// </param>
            /// <returns>
            /// <see langword="true"/>if the <see cref="IGeneration"/> contains an element with the <see cref="key"/>; 
            /// otherwise <see langword="false"/>.
            /// </returns>
            bool Contains( int bucketIndex, TKey key );

            /// <summary>
            /// Make from generation old generation.
            /// </summary>
            /// <remarks>
            /// When generation is old, <see cref="TryGetValue"/> hit removes element from the generation.
            /// </remarks>
            /// <seealso cref="Clear"/>
            void MakeOld();

            /// <summary>
            /// Remove element associated with the key from the generation.
            /// </summary>
            /// <param name="bucketIndex">
            /// The element's bucket index.
            /// </param>
            /// <param name="key">
            /// The element's key.
            /// </param>
            /// <returns>
            /// <see langword="true"/>, if remove was successful; otherwise <see langword="false"/>.
            /// </returns>
            bool Remove( int bucketIndex, TKey key );

            /// <summary>
            /// Set or add element to generation.
            /// </summary>
            /// <param name="bucketIndex">
            /// The element's bucket index.
            /// </param>
            /// <param name="key">
            /// The element's key.
            /// </param>
            /// <param name="value">
            /// The element's value.
            /// </param>
            /// <param name="size">
            /// The element's size.
            /// </param>
            /// <returns>
            /// <see langword="true"/>, if setting or adding was successful; otherwise <see langword="false"/>.
            /// </returns>
            /// <remarks>
            /// <para>
            /// If element was already existing in generation and new element size fits to collection limits, 
            /// then it's value is replaced with new one and size information is updated. If element didn't
            /// exists in generation before, then generation must have empty space for a new element and
            /// size must fit generation's limits, before element is added to generation.
            /// </para>
            /// </remarks>
            bool Set( int bucketIndex, TKey key, TValue value, long size );

            /// <summary>
            /// Try to get element associated with key.
            /// </summary>
            /// <param name="bucketIndex">
            /// The element's bucket index.
            /// </param>
            /// <param name="key">
            /// The element's key.
            /// </param>
            /// <param name="value">
            /// The element's value.
            /// </param>
            /// <param name="size">
            /// The element's size.
            /// </param>
            /// <returns>
            /// <see langword="true"/>, if element was successful retrieved; otherwise <see langword="false"/>.
            /// </returns>
            /// <remarks>
            /// <para>
            /// If element is not found from generation then <paramref name="value"/> and <paramref name="size"/>
            /// are set to default value (default(TValue) and 0). 
            /// </para>
            /// </remarks>
            bool TryGetValue( int bucketIndex, TKey key, out TValue value, out long size );
        }

        #endregion

        #region ICnmCache<TKey,TValue> Members

        /// <summary>
        /// Gets current count of elements stored to <see cref="ICnmCache{TKey,TValue}"/>.
        /// </summary>
        /// <remarks>
        /// <para>
        /// When adding an new element to <see cref="ICnmCache{TKey,TValue}"/> that is limiting element count, 
        /// <see cref="ICnmCache{TKey,TValue}"/> will remove less recently used elements until it can fit an new element. 
        /// </para>
        /// </remarks>
        /// <seealso cref="ICnmCache{TKey,TValue}.MaxCount"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.IsCountLimited"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.IsSizeLimited"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.IsTimeLimited"/>
        public int Count
        {
            get { return m_newGeneration.Count + m_oldGeneration.Count; }
        }

        /// <summary>
        /// Gets or sets elements expiration time.
        /// </summary>
        /// <value>
        /// Elements expiration time.
        /// </value>
        /// <remarks>
        /// <para>
        /// When element has been stored in <see cref="ICnmCache{TKey,TValue}"/> longer than <see cref="ICnmCache{TKey,TValue}.ExpirationTime"/> 
        /// and it is not accessed through <see cref="ICnmCache{TKey,TValue}.TryGetValue"/> method or element's value is 
        /// not replaced by <see cref="ICnmCache{TKey,TValue}.Set"/> method, then it is automatically removed from the 
        /// <see cref="ICnmCache{TKey,TValue}"/>.
        /// </para>
        /// <para>
        /// It is possible that <see cref="ICnmCache{TKey,TValue}"/> implementation removes element before it's expiration time, 
        /// because total size or count of elements stored to cache is larger than <see cref="ICnmCache{TKey,TValue}.MaxSize"/> or <see cref="ICnmCache{TKey,TValue}.MaxCount"/>.
        /// </para>
        /// <para>
        /// It is also possible that element stays in cache longer than <see cref="ICnmCache{TKey,TValue}.ExpirationTime"/>.
        /// </para>
        /// <para>
        /// Calling <see cref="ICnmCache{TKey,TValue}.PurgeExpired"/> try to remove all elements that are expired.
        /// </para>
        /// <para>
        /// To disable time limit in cache, set <see cref="ICnmCache{TKey,TValue}.ExpirationTime"/> to <see cref="DateTime.MaxValue"/>.
        /// </para>
        /// </remarks>
        /// <seealso cref="ICnmCache{TKey,TValue}.IsTimeLimited"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.IsCountLimited"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.IsSizeLimited"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.PurgeExpired"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.Count"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.MaxCount"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.MaxSize"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.Size"/>
        public TimeSpan ExpirationTime
        {
            get { return m_expirationTime; }

            set
            {
                if( value < MinExpirationTime )
                    value = MinExpirationTime;

                if( m_expirationTime == value )
                    return;

                m_newGeneration.ExpirationTime = (m_newGeneration.ExpirationTime - m_expirationTime) + value;
                m_oldGeneration.ExpirationTime = (m_oldGeneration.ExpirationTime - m_expirationTime) + value;
                m_expirationTime = value;

                PurgeExpired();
            }
        }

        /// <summary>
        /// Gets a value indicating whether <see cref="ICnmCache{TKey,TValue}"/> is limiting count of elements.
        /// </summary>
        /// <value>
        /// <see langword="true"/> if the <see cref="ICnmCache{TKey,TValue}"/> count of elements is limited; 
        /// otherwise, <see langword="false"/>. 
        /// </value>
        /// <remarks>
        /// <para>
        /// When adding an new element to <see cref="ICnmCache{TKey,TValue}"/> that is limiting element count, 
        /// <see cref="ICnmCache{TKey,TValue}"/> will remove less recently used elements until it can fit an new element. 
        /// </para>
        /// </remarks>
        /// <seealso cref="ICnmCache{TKey,TValue}.Count"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.MaxCount"/> 
        /// <seealso cref="ICnmCache{TKey,TValue}.IsSizeLimited"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.IsTimeLimited"/>
        public bool IsCountLimited
        {
            get { return true; }
        }

        /// <summary>
        /// Gets a value indicating whether <see cref="ICnmCache{TKey,TValue}"/> is limiting size of elements.
        /// </summary>
        /// <value>
        /// <see langword="true"/> if the <see cref="ICnmCache{TKey,TValue}"/> total size of elements is limited; 
        /// otherwise, <see langword="false"/>. 
        /// </value>
        /// <remarks>
        /// <para>
        /// When adding an new element to <see cref="ICnmCache{TKey,TValue}"/> that is limiting total size of elements, 
        /// <see cref="ICnmCache{TKey,TValue}"/> will remove less recently used elements until it can fit an new element. 
        /// </para>
        /// </remarks>        
        /// <seealso cref="ICnmCache{TKey,TValue}.MaxElementSize"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.Size"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.MaxSize"/>        
        /// <seealso cref="ICnmCache{TKey,TValue}.IsCountLimited"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.IsTimeLimited"/>
        public bool IsSizeLimited
        {
            get { return true; }
        }

        /// <summary>
        /// Gets a value indicating whether or not access to the <see cref="ICnmCache{TKey,TValue}"/> is synchronized (thread safe).
        /// </summary>
        /// <value>
        /// <see langword="true"/> if access to the <see cref="ICnmCache{TKey,TValue}"/> is synchronized (thread safe); 
        /// otherwise, <see langword="false"/>. 
        /// </value>
        /// <remarks>
        /// <para>
        /// To get synchronized (thread safe) access to <see cref="ICnmCache{TKey,TValue}"/> object, use 
        /// <see cref="CnmSynchronizedCache{TKey,TValue}.Synchronized"/> in <see cref="CnmSynchronizedCache{TKey,TValue}"/> class
        /// to retrieve synchronized wrapper for <see cref="ICnmCache{TKey,TValue}"/> object.
        /// </para>
        /// </remarks>
        /// <seealso cref="ICnmCache{TKey,TValue}.SyncRoot"/>
        /// <seealso cref="CnmSynchronizedCache{TKey,TValue}"/>
        public bool IsSynchronized
        {
            get { return false; }
        }

        /// <summary>
        /// Gets a value indicating whether elements stored to <see cref="ICnmCache{TKey,TValue}"/> have limited inactivity time.        
        /// </summary>
        /// <value>
        /// <see langword="true"/> if the <see cref="ICnmCache{TKey,TValue}"/> has a fixed total size of elements; 
        /// otherwise, <see langword="false"/>. 
        /// </value>
        /// <remarks>
        /// If <see cref="ICnmCache{TKey,TValue}"/> have limited inactivity time and element is not accessed through <see cref="ICnmCache{TKey,TValue}.Set"/>
        /// or <see cref="ICnmCache{TKey,TValue}.TryGetValue"/> methods in <see cref="ICnmCache{TKey,TValue}.ExpirationTime"/> , then element is automatically removed from 
        /// the cache. Depending on implementation of the <see cref="ICnmCache{TKey,TValue}"/>, some of the elements may 
        /// stay longer in cache.
        /// </remarks>        
        /// <seealso cref="ICnmCache{TKey,TValue}.ExpirationTime"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.PurgeExpired"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.IsCountLimited"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.IsSizeLimited"/>
        public bool IsTimeLimited
        {
            get { return ExpirationTime != TimeSpan.MaxValue; }
        }

        /// <summary>
        /// Gets or sets maximal allowed count of elements that can be stored to <see cref="ICnmCache{TKey,TValue}"/>.
        /// </summary>
        /// <value>
        /// <see cref="int.MaxValue"/>, if <see cref="ICnmCache{TKey,TValue}"/> is not limited by count of elements; 
        /// otherwise maximal allowed count of elements.
        /// </value>
        /// <remarks>
        /// <para>
        /// When adding an new element to <see cref="ICnmCache{TKey,TValue}"/> that is limiting element count, 
        /// <see cref="ICnmCache{TKey,TValue}"/> will remove less recently used elements until it can fit an new element. 
        /// </para>
        /// </remarks>
        public int MaxCount
        {
            get { return m_maxCount; }

            set
            {
                if( value < 8 )
                    value = 8;
                if( m_maxCount == value )
                    return;

                m_maxCount = value;
                Initialize();
            }
        }

        /// <summary>
        /// <para>Gets maximal allowed element size.</para>
        /// </summary>
        /// <value>
        /// Maximal allowed element size.
        /// </value>
        /// <remarks>
        /// <para>
        /// If element's size is larger than <see cref="ICnmCache{TKey,TValue}.MaxElementSize"/>, then element is 
        /// not added to the <see cref="ICnmCache{TKey,TValue}"/>.
        /// </para>
        /// </remarks>
        /// <seealso cref="ICnmCache{TKey,TValue}.Set"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.IsSizeLimited"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.Size"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.MaxSize"/>        
        public long MaxElementSize
        {
            get { return m_maxElementSize; }

            private set { m_maxElementSize = value; }
        }

        /// <summary>
        /// Gets or sets maximal allowed total size for elements stored to <see cref="ICnmCache{TKey,TValue}"/>.
        /// </summary>
        /// <value>
        /// Maximal allowed total size for elements stored to <see cref="ICnmCache{TKey,TValue}"/>.
        /// </value>
        /// <remarks>        
        /// <para>
        /// Normally size is total bytes used by elements in the cache. But it can be any other suitable unit of measure.
        /// </para>
        /// <para>
        /// When adding an new element to <see cref="ICnmCache{TKey,TValue}"/> that is limiting total size of elements, 
        /// <see cref="ICnmCache{TKey,TValue}"/> will remove less recently used elements until it can fit an new element. 
        /// </para>
        /// </remarks>
        /// <seealso cref="ICnmCache{TKey,TValue}.MaxElementSize"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.IsSizeLimited"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.Size"/>
        public long MaxSize
        {
            get { return m_maxSize; }

            set
            {
                if( value < 8 )
                    value = 8;
                if( m_maxSize == value )
                    return;

                m_maxSize = value;
                Initialize();
            }
        }

        /// <summary>
        /// Gets total size of elements stored to <see cref="ICnmCache{TKey,TValue}"/>.
        /// </summary>
        /// <value>
        /// Total size of elements stored to <see cref="ICnmCache{TKey,TValue}"/>.
        /// </value>
        /// <remarks>
        /// <para>
        /// Normally bytes, but can be any suitable unit of measure.
        /// </para>
        /// <para>
        /// Element's size is given when element is added or replaced by <see cref="ICnmCache{TKey,TValue}.Set"/> method. 
        /// </para>
        /// <para>
        /// When adding an new element to <see cref="ICnmCache{TKey,TValue}"/> that is limiting total size of elements, 
        /// <see cref="ICnmCache{TKey,TValue}"/> will remove less recently used elements until it can fit an new element. 
        /// </para>
        /// </remarks>        
        /// <seealso cref="ICnmCache{TKey,TValue}.MaxElementSize"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.IsSizeLimited"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.MaxSize"/>        
        /// <seealso cref="ICnmCache{TKey,TValue}.IsCountLimited"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.ExpirationTime"/>
        public long Size
        {
            get { return m_newGeneration.Size + m_oldGeneration.Size; }
        }

        /// <summary>
        /// Gets an object that can be used to synchronize access to the <see cref="ICnmCache{TKey,TValue}"/>.
        /// </summary>
        /// <value>        
        /// An object that can be used to synchronize access to the <see cref="ICnmCache{TKey,TValue}"/>.
        /// </value>        
        /// <remarks>
        /// <para>
        /// To get synchronized (thread safe) access to <see cref="ICnmCache{TKey,TValue}"/>, use <see cref="CnmSynchronizedCache{TKey,TValue}"/> 
        /// method <see cref="CnmSynchronizedCache{TKey,TValue}.Synchronized"/> to retrieve synchronized wrapper interface to 
        /// <see cref="ICnmCache{TKey,TValue}"/>.
        /// </para>
        /// </remarks>
        /// <seealso cref="ICnmCache{TKey,TValue}.IsSynchronized"/>
        /// <seealso cref="CnmSynchronizedCache{TKey,TValue}"/>
        public object SyncRoot
        {
            get { return m_syncRoot; }
        }

        /// <summary>
        /// Removes all elements from the <see cref="ICnmCache{TKey,TValue}"/>.
        /// </summary>
        /// <seealso cref="ICnmCache{TKey,TValue}.Set"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.Remove"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.RemoveRange"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.TryGetValue"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.PurgeExpired"/>
        public void Clear()
        {
            m_newGeneration.Clear();
            m_oldGeneration.Clear();
            m_oldGeneration.MakeOld();
            m_version++;
        }

        /// <summary>
        /// Returns an enumerator that iterates through the elements stored to <see cref="CnmMemoryCache{TKey,TValue}"/>.
        /// </summary>
        /// <returns>
        /// A <see cref="IEnumerator{T}"/> that can be used to iterate through the collection.
        /// </returns>
        /// <filterpriority>1</filterpriority>
        public IEnumerator<KeyValuePair<TKey, TValue>> GetEnumerator()
        {
            return new Enumerator( this );
        }

        /// <summary>
        /// Purge expired elements from the <see cref="ICnmCache{TKey,TValue}"/>.
        /// </summary>
        /// <remarks>
        /// <para>
        /// Element becomes expired when last access time to it has been longer time than <see cref="ICnmCache{TKey,TValue}.ExpirationTime"/>.
        /// </para>
        /// <para>
        /// Depending on <see cref="ICnmCache{TKey,TValue}"/> implementation, some of expired elements
        /// may stay longer than <see cref="ICnmCache{TKey,TValue}.ExpirationTime"/> in the cache.        
        /// </para>
        /// </remarks>
        /// <seealso cref="ICnmCache{TKey,TValue}.IsTimeLimited"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.ExpirationTime"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.Set"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.Remove"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.RemoveRange"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.TryGetValue"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.Clear"/>
        public void PurgeExpired()
        {
            m_operationsBetweenTimeChecks = DefaultOperationsBetweenTimeChecks;

            if( !IsTimeLimited )
                return;

            DateTime now = DateTime.Now;
            if( m_newGeneration.AccessedSinceLastTimeCheck )
            {
                // New generation has been accessed since last check
                // Update it's expiration time.
                m_newGeneration.ExpirationTime = now + ExpirationTime;
                m_newGeneration.AccessedSinceLastTimeCheck = false;
            }
            else if( m_newGeneration.ExpirationTime < now )
            {
                // New generation has been expired.
                // --> also old generation must be expired.
                PurgeGeneration( m_newGeneration );
                PurgeGeneration( m_oldGeneration );
                return;
            }

            if( m_oldGeneration.ExpirationTime < now )
                PurgeGeneration( m_oldGeneration );
        }

        /// <summary>
        /// Removes element associated with <paramref name="key"/> from the <see cref="ICnmCache{TKey,TValue}"/>.
        /// </summary>
        /// <param name="key">
        /// The key that is associated with element to remove from the <see cref="ICnmCache{TKey,TValue}"/>.
        /// </param>
        /// <exception cref="ArgumentNullException">
        /// <paramref name="key"/>is <see langword="null"/>.
        /// </exception>
        /// <seealso cref="ICnmCache{TKey,TValue}.Set"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.RemoveRange"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.TryGetValue"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.Clear"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.PurgeExpired"/>
        public void Remove( TKey key )
        {
            if( key == null )
                throw new ArgumentNullException( "key" );

            int bucketIndex = GetBucketIndex( key );
            if( !m_newGeneration.Remove( bucketIndex, key ) )
            {
                if( !m_oldGeneration.Remove( bucketIndex, key ) )
                {
                    CheckExpired();
                    return;
                }
            }

            CheckExpired();
            m_version++;
        }

        /// <summary>
        /// Removes elements that are associated with one of <paramref name="keys"/> from the <see cref="ICnmCache{TKey,TValue}"/>.
        /// </summary>
        /// <param name="keys">
        /// The keys that are associated with elements to remove from the <see cref="ICnmCache{TKey,TValue}"/>.
        /// </param>
        /// <exception cref="ArgumentNullException">
        /// <paramref name="keys"/>is <see langword="null"/>.
        /// </exception>
        /// <seealso cref="ICnmCache{TKey,TValue}.Set"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.Remove"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.TryGetValue"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.Clear"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.PurgeExpired"/>
        public void RemoveRange( IEnumerable<TKey> keys )
        {
            if( keys == null )
                throw new ArgumentNullException( "keys" );

            foreach( TKey key in keys )
            {
                if( key == null )
                    continue;

                int bucketIndex = GetBucketIndex( key );
                if( !m_newGeneration.Remove( bucketIndex, key ) )
                    m_oldGeneration.Remove( bucketIndex, key );
            }

            CheckExpired();
            m_version++;
        }

        /// <summary>
        /// Add or replace an element with the provided <paramref name="key"/>, <paramref name="value"/> and <paramref name="size"/> to 
        /// <see cref="ICnmCache{TKey,TValue}"/>.
        /// </summary>
        /// <param name="key">
        /// The object used as the key of the element. Can't be <see langword="null"/> reference.
        /// </param>
        /// <param name="value">
        /// The object used as the value of the element to add or replace. <see langword="null"/> is allowed.
        /// </param>
        /// <param name="size">
        /// The element's size. Normally bytes, but can be any suitable unit of measure.
        /// </param>
        /// <returns>
        /// <see langword="true"/>if element has been added successfully to the <see cref="ICnmCache{TKey,TValue}"/>; 
        /// otherwise <see langword="false"/>.
        /// </returns>
        /// <exception cref="ArgumentNullException">
        /// <paramref name="key"/>is <see langword="null"/>.
        /// </exception>
        /// <exception cref="ArgumentOutOfRangeException">
        /// The element's <paramref name="size"/> is less than 0.
        /// </exception>
        /// <remarks>
        /// <para>
        /// If element's <paramref name="size"/> is larger than <see cref="ICnmCache{TKey,TValue}.MaxElementSize"/>, then element is 
        /// not added to the <see cref="ICnmCache{TKey,TValue}"/>, however - possible older element is 
        /// removed from the <see cref="ICnmCache{TKey,TValue}"/>. 
        /// </para>
        /// <para>
        /// When adding an new element to <see cref="ICnmCache{TKey,TValue}"/> that is limiting total size of elements, 
        /// <see cref="ICnmCache{TKey,TValue}"/>will remove less recently used elements until it can fit an new element. 
        /// </para>
        /// <para>
        /// When adding an new element to <see cref="ICnmCache{TKey,TValue}"/> that is limiting element count, 
        /// <see cref="ICnmCache{TKey,TValue}"/>will remove less recently used elements until it can fit an new element. 
        /// </para>
        /// </remarks>
        /// <seealso cref="ICnmCache{TKey,TValue}.IsSizeLimited"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.IsCountLimited"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.Remove"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.RemoveRange"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.TryGetValue"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.Clear"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.PurgeExpired"/>
        public bool Set( TKey key, TValue value, long size )
        {
            if( key == null )
                throw new ArgumentNullException( "key" );

            if( size < 0 )
                throw new ArgumentOutOfRangeException( "size", size, "Value's size can't be less than 0." );

            if( size > MaxElementSize )
            {
                // Entry size is too big to fit cache - ignore it
                Remove( key );
                return false;
            }

            if( size == 0 )
                size = 1;

            int bucketIndex = GetBucketIndex( key );
            m_oldGeneration.Remove( bucketIndex, key );
            AddToNewGeneration( bucketIndex, key, value, size );
            CheckExpired();

            return true;
        }

        /// <summary>
        /// Gets the <paramref name="value"/> associated with the specified <paramref name="key"/>.
        /// </summary>
        /// <returns>
        /// <see langword="true"/>if the <see cref="ICnmCache{TKey,TValue}"/> contains an element with 
        /// the specified key; otherwise, <see langword="false"/>.        
        /// </returns>
        /// <param name="key">
        /// The key whose <paramref name="value"/> to get.
        /// </param>
        /// <param name="value">
        /// When this method returns, the value associated with the specified <paramref name="key"/>, 
        /// if the <paramref name="key"/> is found; otherwise, the 
        /// default value for the type of the <paramref name="value"/> parameter. This parameter is passed uninitialized.
        /// </param>
        /// <exception cref="ArgumentNullException">
        /// <paramref name="key"/>is <see langword="null"/>.
        /// </exception>
        /// <seealso cref="ICnmCache{TKey,TValue}.Set"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.Remove"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.RemoveRange"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.Clear"/>
        /// <seealso cref="ICnmCache{TKey,TValue}.PurgeExpired"/>
        public bool TryGetValue( TKey key, out TValue value )
        {
            if( key == null )
                throw new ArgumentNullException( "key" );

            int bucketIndex = GetBucketIndex( key );
            long size;
            if( m_newGeneration.TryGetValue( bucketIndex, key, out value, out size ) )
            {
                CheckExpired();
                return true;
            }

            if( m_oldGeneration.TryGetValue( bucketIndex, key, out value, out size ) )
            {
                // Move element to new generation
                AddToNewGeneration( bucketIndex, key, value, size );
                CheckExpired();
                return true;
            }

            CheckExpired();
            return false;
        }

        /// <summary>
        /// Returns an enumerator that iterates through a collection.
        /// </summary>
        /// <returns>
        /// An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
        /// </returns>
        /// <filterpriority>2</filterpriority>
        IEnumerator IEnumerable.GetEnumerator()
        {
            return GetEnumerator();
        }

        #endregion
    }
}