Sage Modeling and Simulation Library

GuidSelectiveResourceRequest Members

The GuidSelectiveResourceRequest type exposes the following members.

Constructors


  Name Description
Public method GuidSelectiveResourceRequest
Initializes a new instance of the GuidSelectiveResourceRequest class.

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.
(Inherited from ResourceRequest.)
Public method Choose
Chooses a resource from the specified candidates.
(Inherited from ResourceRequest.)
Public method CompareTo
Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
(Inherited from ResourceRequest.)
Protected method DefaultGrantConfirmationRequest_Refuse (Inherited from ResourceRequest.)
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.)
Protected method GetDefaultReplicator
Gets the default replicator.
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.
(Inherited from ResourceRequest.)
Public method Reserve
Reserves the specified resource manager.
(Inherited from ResourceRequest.)
Public method ToString
Returns a String that represents this instance.
Public method Unreserve
Releases the resource previously obtained by this ResourceRequest.
(Inherited from 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.
(Inherited from 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.
(Inherited from ResourceRequest.)
Public property AsyncGrantNotificationCallback
Called after a resource request is granted asynchronously.
(Inherited from ResourceRequest.)
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.
(Inherited from ResourceRequest.)
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)
(Inherited from ResourceRequest.)
Public property Priority
An indication of the priority of this request. A larger number indicates a higher priority.
(Inherited from ResourceRequest.)
Public property QuantityDesired
This property represents the quantity this request is to remove from the resource's 'Available' capacity.
(Inherited from ResourceRequest.)
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.
(Inherited from ResourceRequest.)
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.
(Inherited from ResourceRequest.)
Public property Requester
This is a reference to the object requesting the resource.
(Inherited from ResourceRequest.)
Public property RequiredResource
If non-null, this infers a specific, needed resource.
(Inherited from ResourceRequest.)
Public property RequiredRscGuid
Gets or sets the required resource unique identifier.
Public property ResourceObtained
This is a reference to the actual resource that was obtained.
(Inherited from ResourceRequest.)
Public property ResourceObtainedFrom
This is a reference to the resource manager that granted access to the resource.
(Inherited from ResourceRequest.)
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.
(Inherited from ResourceRequest.)
Public property Status
Gets the status of this resource request.
(Inherited from ResourceRequest.)
Public property UserData
Data maintained by this resource request on behalf of the requester.
(Inherited from ResourceRequest.)
Public property WhichResource
Gets a Guid which indicates which resource is desired.

Events


  Name Description
Public event PriorityChangeEvent
An event that is fired if the priority of this request is changed.
(Inherited from ResourceRequest.)
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.
(Inherited from ResourceRequest.)