RoleInstanceStatusCheckEventArgs Class

Article
08/18/2015

Represents the arguments for the StatusCheck event, which occurs at a regular interval to indicate the status of a role instance.

Namespace: Microsoft.WindowsAzure.ServiceRuntime
Assembly: Microsoft.WindowsAzure.ServiceRuntime (in Microsoft.WindowsAzure.ServiceRuntime.dll)

Inheritance Hierarchy

System.Object
System.EventArgs
Microsoft.WindowsAzure.ServiceRuntime.RoleInstanceStatusCheckEventArgs

Syntax

public class RoleInstanceStatusCheckEventArgs : EventArgs

public ref class RoleInstanceStatusCheckEventArgs : EventArgs

type RoleInstanceStatusCheckEventArgs = 
    class
        inherit EventArgs
    end

Public Class RoleInstanceStatusCheckEventArgs
    Inherits EventArgs

Constructors

	Name	Description
	RoleInstanceStatusCheckEventArgs()	Initializes a new instance of the RoleInstanceStatusCheckEventArgs class.

Properties

	Name	Description
	Status	Gets the status of the role instance.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	SetBusy()	Sets the status of the role instance to Busy until the status is checked again, which occurs at regular intervals. When the status of the role instance is Busy it will not receive requests from the load balancer.
	ToString()	(Inherited from Object.)

Remarks

A role instance may indicate that it is in one of two states: Ready or Busy. If the state of a role instance is Ready, it is prepared to receive requests from the load balancer. If the state of the instance is Busy, it will not receive requests from the load balancer.

The following code example shows how to write out the status of the role instance:

public override bool OnStart()
{
   RoleEnvironment.StatusCheck += RoleEnvironmentStatusCheck;

   return base.OnStart();
}

private void RoleEnvironmentStatusCheck(object sender, RoleInstanceStatusCheckEventArgs e)
{
   Trace.WriteLine("The status of the role instance: " + e.Status, "Information");
}

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via