GigaSpaces XAP.NET Documentation
IServiceGridAdmin Interface
Class Library ► GigaSpaces.Core.Admin.ServiceGrid ► IServiceGridAdmin
The main interface for accessing Service Grid Admin API. Created using the ServiceGridAdminBuilder class. Provides access to the main elements in the Service Grid Admin API and in GigaSpaces such as the IGridServiceAgents, ILookupServices, IGridServiceManagers, IGridServiceContainers, IProcessingUnits, and ISpaces. Also allows to change monitoring (not statistics) interval (works in a polling fashion) of state changing elements such as the processing unit, the Grid Service Agent, and the Space. Implements the IStatisticsMonitor interface, allowing in one single call (StartStatisticsMonitor()()()()) to start statistics monitors on all the elements it manages (such as the {ISpaces}, and IVirtualMachines.
Declaration Syntax
C#Visual BasicVisual C++J#
public interface IServiceGridAdmin : IStatisticsMonitor, 
	IDumpProvider, IDisposable
Public Interface IServiceGridAdmin _
	Inherits IStatisticsMonitor, IDumpProvider, IDisposable
public interface class IServiceGridAdmin : IStatisticsMonitor, 
	IDumpProvider, IDisposable
public interface IServiceGridAdmin extends IStatisticsMonitor, 
	IDumpProvider, IDisposable
Members
All MembersMethodsProperties



IconMemberDescription
Dispose()()()()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Gateways
Gets the discovered gateways.

GenerateDump(String)
Generates dump for all the provided dump processors. Note, this will include a heap dump which can consume time and potentially be of very large size
(Inherited from IDumpProvider.)
GenerateDump(String, array<String>[]()[][])
Generates dump for the provided processors. The current list of processors include:
  • summary: General summary information of the process.
  • network: Information on the network layer of the process and the OS network stats.
  • thread: Thread dump of the process.
  • heap: Heap dump of the process. Note, this is a heavy operation and can produce very large dump files
  • log: Adds all the log files of the process to the dump file.
  • processingUnits: Dump of all the processing units (applicable only for GSCs) information.
(Inherited from IDumpProvider.)
GridServiceAgents
Gets the discovered grid service agents.

GridServiceContainers
Gets the discovered containers.

GridServiceManagers
Gets the discovered service managers.

Groups
Gets the lookup groups this admin uses.

Locators
Gets the lookup locators this admin uses.

LookupServices
Gets the discovered lookup services

Machines
Gets the discovered machines.

Monitoring
Gets whether statistics are currently being monitored.
(Inherited from IStatisticsMonitor.)
OperatingSystems
Gets the discovered operating systems.

ProcessingUnits
Gets the discovered processing units.

SetAgentProcessessMonitorInterval(TimeSpan)
Sets the Grid Service Agent processes monitor (not statistics) interval. The monitor basically updates the list of processes the agent manages (ProcessesDetails). Defaults to 5 seconds.

SetDefaultTimeout(TimeSpan)
The default timeout to be used for operations that have a wait for mechanism, i.e. operations with overloaded methods containing (..., TimeSpan timeout). If not set, the default is wait for ever.

SetProcessingUnitMonitorInterval(TimeSpan)
Sets the processing unit monitor (not statistics) interval. The monitor basically checks the status of each processing unit (Status} among other things. Defaults to 1 second.

SetSchedulerCorePoolSize(Int32)
The Admin uses a shared scheduler thread pool to perform *all* scheduled operations (monitoring, statistics monitoring). The number of threads used can be set here. Defaults to 10 threads.

SetSpaceMonitorInterval(TimeSpan)
Sets the Space monitor (not statistics) interval. The monitor checks each space instance and updates its different status (such as the replication status). Defaults to 1 second.

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.)
Spaces
Gets the discovered spaces.

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.)
StopStatisticsMonitor()()()()
Stops the statistics monitor.
(Inherited from IStatisticsMonitor.)
Transports
Gets the discovered transports.

VirtualMachines
Gets the discovered virtual machines.

Zones
Gets the discovered zones.

Assembly: GigaSpaces.Core (Module: GigaSpaces.Core) Version: 16.2.0.0 (16.2.1)