GigaSpaces XAP.NET Documentation
IGridServiceAgents Interface
Class LibraryGigaSpaces.Core.Admin.ServiceGrid.AgentIGridServiceAgents
Grid Service Agents hold all the different IGridServiceAgent that are currently discovered. Provides simple means to get all the current agents, as well as as registering for agent lifecycle (added and removed) events.
Declaration Syntax
C#Visual BasicVisual C++J#
public interface IGridServiceAgents : IAdminAware, 
	IDumpProvider, IEnumerable<IGridServiceAgent>, IEnumerable
Public Interface IGridServiceAgents _
	Implements IAdminAware, IDumpProvider, IEnumerable(Of IGridServiceAgent),  _
	IEnumerable
public interface class IGridServiceAgents : IAdminAware, 
	IDumpProvider, IEnumerable<IGridServiceAgent^>, IEnumerable
public interface IGridServiceAgents extends IAdminAware, 
	IDumpProvider, IEnumerable<IGridServiceAgent>, IEnumerable
Members
All MembersMethodsPropertiesEvents



IconMemberDescription
Admin
Gets the IServiceGridAdmin associated with this element.
(Inherited from IAdminAware.)
Agents
Gets all the currently discovered agents.

Count
Gets the number of agents current discovered.

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.)
GetAgentByUID(String)
Returns an agent based on its uid.

GetEnumerator()()()
Returns an enumerator that iterates through the collection.
(Inherited from IEnumerable<(Of <(IGridServiceAgent>)>).)
GetEnumerator()()()
Returns an enumerator that iterates through a collection.
(Inherited from IEnumerable.)
GridServiceAgentAdded
Occurs when a IGridServiceAgent is added.

GridServiceAgentRemoved
Occurs when a IGridServiceAgent is removed.

HostAddress
Gets a dictionary of grid service agent with the key as the host address it is running on.

HostNames
Gets a dictionary of grid service agent with the key as the host name it is running on.

IsEmpty
Gets if there are no agents.

Uids
Gets a dictionary of grid service agent with the key as the uid.

WaitFor(Int32)
Waits for SetDefaultTimeout(TimeSpan) till the provided number of agents are up.

WaitFor(Int32, TimeSpan)
Waits for the given timeout till the provided number of agents are up.

WaitForAtLeastOne()()()
Waits for SetDefaultTimeout(TimeSpan) till at least one agent is discovered.

WaitForAtLeastOne(TimeSpan)
Waits for the given timeout till at least one agent is discovered.

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