VkNLS(3x)
VkNLS - Network Licensing support
As shipped in IRIX 6.5.15. Unchanged since IRIX 6.5.
NAME VkNLS - Network Licensing support WARNING THIS CLASS IS OBSOLETE. IT IS RETAINED IN VIEWKIT ONLY FOR COMPATIBILITY PURPOSES. PLEASE SWITCH TO USING THE FlexLM LICENSING MANAGER. HEADER FILE #include <Vk/VkNLS.h> PUBLIC PROTOCOL SUMMARY Constructor/Destructor VkNLS(char* vendorID, long key, int productID, char* version, NLSCallback loseLicenseCallback = NULL, void *clientData=NULL); void ~VkNLS(void); X RESOURCES ASSOCIATED WITH THIS CLASS disableLicenseWarnings disableThirtyDayLicenseWarnings thirtyDayMessage sixtyDayMessage ninetyDayMessage notEnoughLicensesMessage noLicenseMessage licenseExpiredMessage warnLoseLicenseMessage regainLicenseMessage CLASS DESCRIPTION VkNLS provides a high-level interface to the NetLS network licensing manager. The VkNLS class implements a policy based on the NetLS license mechanism that simplifies the process of license protecting applications. Applications merely instantiate an VkNLS object in their application, providing some basic information about the application and its licensing. The VkNLS object handles all license verification, informing the user if there is a problem, and shutting the application down if a license cannot be found. VkNLS will look for either a node-locked or concurrent (networked) license. There is no difference to the application for these different types of licenses. Once the VKNLS object is instantiated, the object immediately checks for a valid license. If no license is found, the object posts a fatal error dialog, which the user must dismiss, exiting the application. If a license is obtained, the license is rechecked every ten minutes. If the application's license is lost, a warning dialog is posted warning that the license is no longer valid. This dialog is posted in blocking mode, so the user must dismiss it, however,the application will not exit. Instead, the object begins checking every minute for a license. If the license is restored, a dialog is posted notifying the user, and the program returns to normal operation. If the license is not found, another blocking dialog is posted every minute. The VkNLS class also supports warnings for users whose licenses are about to expire. By default, VkNLS will post a warning when a license has less than 90 days before expiration. RESOURCES VkNLS recognizes several X resources that control the messages posted by the various dialogs. These are: disableLicenseWarnings If TRUE, don't show the warnings that appear when a license has only 90 days before expiration. The default is FALSE. This resource does not disable messages when the license has less than 30 days before expiration. disableThirtyDayLicenseWarnings If TRUE, don't show the warnings that appear when a license has only 30 days before expiration. The default is FALSE. thirtyDayMessage Determines the message to appear when only 30 days or less are left before a license expires. The message is expected to embed a "%d" printf-style integer spec in the message. VkNLS will plug the correct number of days into this slot. For example: *thirtyDayMessage: Your license will expire in %d days sixtyDayMessage Determines the message to appear when between 60 and 30 days are left before a license expires. The message is expected to embed a "%d" printf-style integer spec in the message. VkNLS will plug the correct number of days into this slot. ninetyDayMessage Determines the message to appear when between 90 and 60 days are left before a license expires. The message is expected to embed a "%d" printf-style integer spec in the message. VkNLS will plug the correct number of days into this slot. notEnoughLicensesMessage Determines the message to appear when an application is licensed, but there are not enough licenses currently available to support the number of people using them. noLicenseMessage Determines the message to appear when no valid license can be found. licenseExpiredMessage Determines the message to appear when an application has had a valid license, but the license has now expired. warnLoseLicenseMessage Determines the message to appear when an application has lost its license while the application is running. regainLicenseMessage Determines the message to appear when an application that has lots its license has regained the license. FUNCTION DESCRIPTIONS VkNLS() VkNLS(char* vendorID, long key, int productID, char* version, NLSCallback loseLicenseCallback = NULL, void *clientData=NULL); vendorID is an encrypted string that uniquely identifies a vendor. key is an integral key. productID is an integer value that uniquely identifies a vendor's products. You must obtain these values from your NetLS administrator. version specifies the version of the product. It can be any string that is meaningful to you. loseLicenseCallback is an optional function pointer. The VkNLS object calls this function if it is unable to obtain a license. If you provide a loseLicenseCallback function, VkNLS does not post the fatal error dialog and exit the application. It is up to the application to do any needed error recovery, and to then exit if appropriate. Note: loseLicenseCallback must be either a global function or as static member function; it cannot be a regular member function. ~VkNLS() void ~VkNLS(void); Free all storage associated with a VkNLS object and return any license currently in use. DATA MEMBER DESCRIPTIONS SEE ALSO NetLS Manual , ViewKit Programmer's Guide