GigaSpaces XAP.NET Documentation
IProcessingUnit Interface
Class LibraryGigaSpaces.Core.Admin.ServiceGrid.ProcessingUnitIProcessingUnit
A processing unit holds one or more IProcessingUnitInstances.
Declaration Syntax
C#Visual BasicVisual C++J#
Public Interface IProcessingUnit _
	Implements IAdminAware, IEnumerable(Of IProcessingUnitInstance),  _
	IEnumerable, IStatisticsMonitor
public interface class IProcessingUnit : IAdminAware, 
	IEnumerable<IProcessingUnitInstance^>, IEnumerable, IStatisticsMonitor
Members
All MembersMethodsPropertiesEvents



IconMemberDescription
Admin
Gets the IServiceGridAdmin associated with this element.
(Inherited from IAdminAware.)
BackupGridServiceManagerChanged
Occurs when a backup IGridServiceManager for a IProcessingUnit was either removed or added.

BackupGridServiceManagers
Gets the backup GSMs for the processing unit.

CanDecrementInstance
Gets whether this processing unit instances can be decremented once deployed.

CanIncrementInstance
Gets whether this processing unit instances can be incremented once deployed.

DecrementInstance()()()
Will randomly decrement an instance from the processing units. For more fine grained control see Decrement()()()

GetBackupGridServiceManager(String)
Gets the backup GSM matching the provided UID.

GetEnumerator()()()
Returns an enumerator that iterates through the collection.
(Inherited from IEnumerable<(Of <(IProcessingUnitInstance>)>).)
GetEnumerator()()()
Returns an enumerator that iterates through a collection.
(Inherited from IEnumerable.)
GetPartition(Int32)
Gets a processing unit partition based on the specified partition id.

IncrementInstance()()()
Increment a processing unit instance.

Instances
Gets the currently discovered processing unit instances.

Managed
Gets whether there is a managing GSM for this processing unit.

ManagingGridServiceManager
Gets the managing (primary) GSM for the processing unit.

ManagingGridServiceManagerChanged
Occurs when a managing IGridServiceManager for a IProcessingUnit was changed.

MaxInstancesPerMachine
Returns the number of instnaces of this processing unit that can run within a Machine. In case of a partitioned with backup topology, it applies on a per partition level (meaning that a primary and backup will not run on the same Machine). In case of a non backup based topology, it applies on the number of instances of the whole processing unit that can run on the same Machine).

MaxInstancesPerVM
Gets the number of instances of this processing unit that can run within a VM. In case of a partitioned with backup topology, it applies on a per partition level (meaning that a primary and backup will not run on the same VM). In case of a non backup based topology, it applies on the number of instances of the whole processing unit that can run on the same VM).

MaxInstancesPerZone
Gets a map containing the zone name and the maximum number of instances for that zone.

Monitoring
Gets whether statistics are currently being monitored.
(Inherited from IStatisticsMonitor.)
Name
Gets the name of the processing unit.

NumberOfBackups
Gets the number of backups (if the topology is a backup one) per instance.

NumberOfInstances
Gets the number of instances of the processing unit.

Partitions
Gets the processing unit partitions of this processing unit.

ProcessingUnitInstanceAdded
Occurs when a IProcessingUnitInstance is added.

ProcessingUnitInstanceRemoved
Occurs when a IProcessingUnitInstance is removed.

ProcessingUnitInstanceStatisticsChanged
Occurs when a IProcessingUnitInstance statistics have changed. Note, in order to receive events, the IProcessingUnits need to be in a "statistics" monitored state StartStatisticsMonitor()()()

ProcessingUnits
Gets the handle to all the different processing units.

ProcessingUnitStatusChanged
Occurs when a deployment status of a IProcessingUnit was changed.

RequiredZones
Gets the list of zones this processing units are required to run on. If there is more than one zone, the processing unit can run on either of the zones.

SetStatisticsHistorySize(Int32)
Sets the number of history statistics record to store.
(Inherited from IStatisticsMonitor.)
SetStatisticsInterval(TimeSpan)
Sets the statistics interval, automatically updating the monitoring scheduled tasks if monitoring is enabled.
(Inherited from IStatisticsMonitor.)
Space
Gets the (first) embedded ISpace within a processing unit. Returns null if no embedded space is defined within the processing unit or if no processing unit instance has been added to the processing unit.

SpaceCorrelated
Occurs when that an embedded ISpace was correlated with a IProcessingUnit.

Spaces
Gets all the embedded ISpaces within a processing unit. Returns an empty array if there are no embedded spaces defined within the processing unit, or none has been associated with the processing unit yet.

StartStatisticsMonitor()()()
Starts the statistics monitor, starting a scheduled monitor that polls for statistics. Monitoring is required only when wanting to receive statistics change events.
(Inherited from IStatisticsMonitor.)
Status
Gets the deployment status of the processing unit.

StopStatisticsMonitor()()()
Stops the statistics monitor.
(Inherited from IStatisticsMonitor.)
TotalNumberOfInstances
Gets the total number of instances. If there are no backups, will return NumberOfInstances. If there are backups, will return NumberOfInstances * NumberOfBackups + 1)

Undeploy()()()
Undeploys the processing unit.

WaitFor(Int32)
Waits for SetDefaultTimeout(TimeSpan) till at least the provided number of Processing Unit Instances are up.

WaitFor(Int32, TimeSpan)
Waits for the sepcified timeout till at least the provided number of Processing Unit Instances are up.

WaitForManaged()()()
Waits for SetDefaultTimeout(TimeSpan) till there is a managing IGridServiceManager for the processing unit.

WaitForManaged(TimeSpan)
Waits for the specified timeout till there is a managing IGridServiceManager for the processing unit.

WaitForSpace()()()
Waits for SetDefaultTimeout(TimeSpan) till an embedded Space is correlated with the processing unit.

WaitForSpace(TimeSpan)
Waits for the specified timeout till an embedded Space is correlated with the processing unit.

Assembly: GigaSpaces.Core (Module: GigaSpaces.Core) Version: 9.0.2.6900 (9.0.2.6900)