nrac_resource_load_get()
Abstract
Obtain the load placed on a resource by all consumers; optionally restrict to be relative to a specific event.
Syntax
nrac_resource_load_get (resource_handle, event_handle)
| Argument | Type | Description |
|---|---|---|
resource_handle |
Nrac_Resource_Handle |
handle for the resource of interest |
event_handle |
Nrac_Event_Handle |
handle for an event that is used to restrict the applicable consumers; use NRAC_ANY_EVENT to calculate load irrespective of events. |
Return Type
double
load carried by the resource
Header
nrac.h
Details
Each consumer carries a load attribute expressed in the resource units of the network (typically, a unit of bandwidth like Mbps or STS-1). This function returns the load placed by all consumers on the resource of interest. The result can be based solely on the consumers with respect to a specific event or, if NRAC_ANY_EVENT is passed in, then all consumers are taken into account, irrespective of the events upon which they depend.