One of the hidden gems in DotNetNuke 5.0 is the new caching support in the CBO (Custom Business Objects) class. During the refactoring of DotNetNuke for the Cambrian release, caching was one of the things that was closely looked at, since caching was starting to cause major issues in the DNN 4.x branch.
Lets take a look at how caching was done in DNN 4:
Public Shared Function GetSecureHostSettings() As HashtableDim h As Hashtable
h = CType(DataCache.GetCache("GetSecureHostSettings"), Hashtable)
If h Is Nothing Then
h = New HashtableDim SettingName As StringDim dr As IDataReader =
DataProvider.Instance().GetHostSettingsWhile dr.Read()
If Not Convert.ToBoolean(dr(2)) Then
SettingName = dr.GetString(0)
If SettingName.ToLower.IndexOf("password") = -1 ThenIf Not dr.IsDBNull(1) Then
h.Add(SettingName, dr.GetString(1))
Else
h.Add(SettingName, "")
End IfEnd IfEnd IfEnd While
dr.Close()
DataCache.SetCache("GetSecureHostSettings", h)
End IfReturn hEnd Function
This is code from the class DotNetNuke.Entities.Host.HostSettings in DNN 4.9.3. In fact this is a pattern that is used throughout the application in DNN 3.x – 4.x. The problem with this pattern is that it is not completely thread safe, especially if it is used in larger routines, and specifically on large and busy sites. There might be a chance that the object you get from the cache is removed from cache when you want to use it.
In DotNetNuke 5.x, the CBO class was beefed up with a new caching function:
Public Shared Function GetCachedObject(Of TObject)(ByVal cacheItemArgs As CacheItemArgs, ByVal cacheItemExpired As CacheItemExpiredCallback) As TObjectReturn DataCache.GetCachedData(Of TObject)(cacheItemArgs, cacheItemExpired)
End Function
which in turn calls a new method of DataCache, GetCachedData. This method looks like this:
Public Shared Function GetCachedData(Of TObject)(ByVal cacheItemArgs As CacheItemArgs, ByVal cacheItemExpired As CacheItemExpiredCallback) As TObject'Declare Local Variable and try and retieve it from the cacheDim objObject As Object = GetCache(cacheItemArgs.CacheKey)
Dim timeOut As Integer = cacheItemArgs.CacheTimeOut * Convert.ToInt32(Host.PerformanceSetting)
'If Item is not cachedIf objObject Is Nothing Then'Prevent other threads from entering this block while we regenerate the cacheSyncLock objLock'Try to retrieve object from Cache again (in case another thread loaded the object since we first checked)
objObject = GetCache(cacheItemArgs.CacheKey)
If objObject Is Nothing Then'Get Object from data Source using Delegate
objObject = cacheItemExpired(cacheItemArgs)
If objObject IsNot Nothing AndAlso timeOut > 0 Then
DataCache.SetCache(cacheItemArgs.CacheKey, objObject, cacheItemArgs.CacheDependency, Cache.NoAbsoluteExpiration, _
TimeSpan.FromMinutes(timeOut), cacheItemArgs.CachePriority, cacheItemArgs.CacheCallback)
'Check if Item was actually saved in the cacheIf DataCache.GetCache(cacheItemArgs.CacheKey) Is Nothing ThenDim objEventLogInfo As New LogInfo
objEventLogInfo.LogTypeKey = EventLogController.EventLogType.CACHE_ERROR.ToString()
objEventLogInfo.LogProperties.Add(New LogDetailInfo(cacheItemArgs.CacheKey, "Not Created"))
Dim objEventLog As New EventLogController()
objEventLog.AddLog(objEventLogInfo)
End IfElseIf objObject Is Nothing ThenReturn NothingEnd IfEnd IfEnd SyncLockEnd IfReturn DirectCast(objObject, TObject)
End Function
As you can see, this is basically still the same pattern as the “old” pattern in DNN 3.x/4.x, however, with a few enhancements:
- Thread safety. Using Synlock, other threads are prevented to intrude when we are handling the object
- automatic callback is used, that will get called when the object is not found in cache
- check to ensure object was saved to cache correctly
As an example of the usage of the new pattern, let’s see how Host.GetSecureHostSettings was modified in DNN 5:
Public Shared Function GetSecureHostSettingsDictionary() As Dictionary(Of String, String)
Return CBO.GetCachedObject(Of Dictionary(Of String, String))(New CacheItemArgs(DataCache.SecureHostSettingsCacheKey, _
DataCache.HostSettingsCacheTimeOut, _
DataCache.HostSettingsCachePriority), _AddressOf GetSecureHostSettingsDictionaryCallBack)
End Function
And the corresponding callback function:
Private Shared Function GetSecureHostSettingsDictionaryCallBack(ByVal cacheItemArgs As CacheItemArgs) As ObjectDim dicSettings As New Dictionary(Of String, String)
Dim dr As IDataReader = DataProvider.Instance().GetHostSettingsTryWhile dr.Read()
If Not Convert.ToBoolean(dr(2)) ThenDim settingName As String =
dr.GetString(0)
If settingName.ToLower.IndexOf("password") = -1 ThenIf Not dr.IsDBNull(1) Then
dicSettings.Add(settingName, dr.GetString(1))
Else
dicSettings.Add(settingName, "")
End IfEnd IfEnd IfEnd WhileFinallyIf Not dr Is Nothing Then
dr.Close()
End IfEnd TryReturn dicSettingsEnd Function
As you can see, the callback function GetSecureHostSettingsDictionaryCallBack is essentially the same as the old method, minus the caching logic. It has become far more easier to use caching in your own module using this pattern. A few lines of code will do the trick.
Reasons why you must trust ASPHostPortal.com
Every provider will tell you how they treat their support, uptime, expertise, guarantees, etc., are. Take a close look. What they’re really offering you is nothing close to what ASPHostPortal does. You will be treated with respect and provided the courtesy and service you would expect from a world-class web hosting business.
You’ll have highly trained, skilled professional technical support people ready, willing, and wanting to help you 24 hours a day. Your web hosting account servers are monitored from three monitoring points, with two alert points, every minute, 24 hours a day, 7 days a week, 365 days a year. The followings are the list of other added- benefits you can find when hosting with us:
- DELL Hardware
Dell hardware is engineered to keep critical enterprise applications running around the clock with clustered solutions fully tested and certified by Dell and other leading operating system and application providers.
- Recovery Systems
Recovery becomes easy and seamless with our fully managed backup services. We monitor your server to ensure your data is properly backed up and recoverable so when the time comes, you can easily repair or recover your data.
- Control Panel
We provide one of the most comprehensive customer control panels available. Providing maximum control and ease of use, our Control Panel serves as the central management point for your ASPHostPortal account. You’ll use a flexible, powerful hosting control panel that will give you direct control over your web hosting account. Our control panel and systems configuration is fully automated and this means your settings are configured automatically and instantly.
- Excellent Expertise in Technology
The reason we can provide you with a great amount of power, flexibility, and simplicity at such a discounted price is due to incredible efficiencies within our business. We have not just been providing hosting for many clients for years, we have also been researching, developing, and innovating every aspect of our operations, systems, procedures, strategy, management, and teams. Our operations are based on a continual improvement program where we review thousands of systems, operational and management metrics in real-time, to fine-tune every aspect of our operation and activities. We continually train and retrain all people in our teams. We provide all people in our teams with the time, space, and inspiration to research, understand, and explore the Internet in search of greater knowledge. We do this while providing you with the best hosting services for the lowest possible price.
- Data Center
ASPHostPortal modular Tier-3 data center was specifically designed to be a world-class web hosting facility totally dedicated to uncompromised performance and security
- Monitoring Services
From the moment your server is connected to our network it is monitored for connectivity, disk, memory and CPU utilization – as well as hardware failures. Our engineers are alerted to potential issues before they become critical.
- Network
ASPHostPortal has architected its network like no other hosting company. Every facet of our network infrastructure scales to gigabit speeds with no single point of failure.
- Security
Network security and the security of your server are ASPHostPortal’s top priorities. Our security team is constantly monitoring the entire network for unusual or suspicious behavior so that when it is detected we can address the issue before our network or your server is affected.
- Support Services
Engineers staff our data center 24 hours a day, 7 days a week, 365 days a year to manage the network infrastructure and oversee top-of-the-line servers that host our clients’ critical sites and services.