License Queuing API

License queuing is the ability of our License Managers to take a license request for a feature and place it in reserve until a license is available. Once the license is available, the License Manager will then notify the requesting application that the license is now ready for use.

Given below is the list of the API functions. A License Queuing Example is also provided:

Function	Description
VLSqueuePreference Struct	Specifies the client's preference for how it wishes to be placed in the queue.
VLSserverInfo Struct	Stores information about the License Manager.
VLSgetQueuedClientInfo Struct	Returns client information.
VLSqueuedRequest	Request an authorized license code from the License Manager. Use this API to: >Request a license, with an option to queue (requestFlag = VLS_REQ_GET \| VLS_REQ_QUEUE). >Request to be placed in the queue, even if the License Manager has available licenses (requestFlag = VLS_REQ_QUEUE). >Request a license without queuing (requestFlag = VLS_REQ_GET). This option has the same effect as calling a non-queuing license request API (LSRequest, VLSrequestExt, etc.).
VLSqueuedRequestExt	Request an authorized license code from the License Manager. Use this API to: >Request a license, with an option to queue (requestFlag = VLS_REQ_GET \| VLS_REQ_QUEUE). >Request to be placed in the queue, even if the License Manager has available licenses (requestFlag = VLS_REQ_QUEUE). >Request a license without queuing (requestFlag = VLS_REQ_GET). This option has the same effect as calling a non-queuing license request API (LSRequest, VLSrequestExt, etc.).
VLSgetQueuedClientInfo	Retrieves the current information of a queued client, such as the number of requested licenses, feature_name, version, and index.
VLSgetQueuedClientInfoExt	Enhanced version of the existing API VLSgetQueuedClientInfo for supporting EPOC time beyond year 2038.
VLSremoveQueuedClient	Removes a queued client from the queue.
VLSremoveQueue	Deletes the entire queue.
VLSgetHandleStatus	Reports the current status of the handle.
VLSupdateQueuedClient	Once the client has been put in the queue, it must call this API periodically to inquire its current status with the License Manager. Moreover, calling this function has the effect of informing the License Manager that the client is alive and is still seeking the license.
VLSupdateQueuedClientNew	Enhanced version of the existing API VLSupdateQueuedClient for supporting EPOC time beyond year 2038.
VLSgetQueuedLicense	Once queued client gets aware about the requested token(s) availability on the License Manager end (using the VLSupdateQueuedClient API), only then VLSgetQueuedLicense API should be called. It obtains the requested token(s) from the License Manager and client is no longer considered queued.
VLSinitQueuePreference	Initializes provided queue preference structure to default values.