Sage Modeling and Simulation Library

IResourceRequest Members

The IResourceRequest type exposes the following members.

Methods


  Name Description
Public method Acquire
Acquires a resource from the specified resource manager, or the provided default manager, if none is provided in this call. If the request has already successfully reserved a resource, then the reservation is revoked and the acquisition is honored in one atomic operation.
Public method Equals(System.Object)
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public method GetScore
Gets the score that describes the suitability of the resource to fulfill this resource request.
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method Release
Releases the resource previously obtained by this ResourceRequest.
Public method Reserve
Reserves a resource from the specified resource manager, or the provided default manager, if none is provided in this call.
Public method ToString
Returns a string that represents the current object.
(Inherited from Object.)
Public method Unreserve
Releases the resource previously obtained by this ResourceRequest.

Properties


  Name Description
Public property AbortHandler
This method is called if the resource request is pending, and gets aborted, for example due to resource deadlocking. It can be null, in which case no deadlock detection is provided for the implementing type of ResourceRequest.
Public property AsyncGrantConfirmationCallback
This callback is called when a request, made with a do-not-block specification, that was initially refused, is finally deemed grantable, and provides the callee (presumably the original requester) with an opportunity to say, "No, I don't want that any more", or perhaps to get ready for receipt of the resource in question.
Public property AsyncGrantNotificationCallback
Called after a resource request is granted asynchronously.
Public property DefaultResourceManager
This is the resource manager from which a resource is obtained if none is provided in the reserve or acquire API calls.
Public property Key
This is a key that will be used to see if the resource manager is allowed to grant a given resource to the requester. It is used in conjunction with resource earmarking. (See IAccessRegulator)
Public property Priority
An indication of the priority of this request. A larger number indicates a higher priority.
Public property QuantityDesired
This property represents the quantity this request is to remove from the resource's 'Available' capacity.
Public property QuantityObtained
This property represents the quantity this request actually removed from the resource's 'Available' capacity. It is filled in by the granting authority.
Public property Replicate
Creates a fresh replica of this resource request, without any of the in-progress data. This replica can be used to generate another, similar resource request that can acquire its own resource.
Public property Requester
This is a reference to the object requesting the resource.
Public property RequiredResource
If non-null, this infers a specific, needed resource.
Public property ResourceObtained
This is a reference to the actual resource that was obtained.
Public property ResourceObtainedFrom
This is a reference to the resource manager that granted access to the resource.
Public property ResourceSelectionStrategy
This is the resource selection strategy that is to be used by the resource manager to select the resource to be granted from the pool of available resources.
Public property Status
Gets the status of this resource request.
Public property UserData
Data maintained by this resource request on behalf of the requester.

Events


  Name Description
Public event PriorityChangeEvent
An event that is fired if the priority of this request is changed.
Public event ResourceRequestAborting
Typically fires as a result of the RequestAbortHandler being called. In that method, it picks up the IResourceRequest identity, and is passed on through this event, which includes the IResourceRequest.