RoleInstanceStatusCheckEventArgs Class

 

Updated: October 18, 2011

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)

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

public ref class RoleInstanceStatusCheckEventArgs : EventArgs

NameDescription
System_CAPS_pubmethodRoleInstanceStatusCheckEventArgs()

Initializes a new instance of the RoleInstanceStatusCheckEventArgs class.

NameDescription
System_CAPS_pubpropertyStatus

Gets the status of the role instance.

NameDescription
System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodSetBusy()

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.

System_CAPS_pubmethodToString()

(Inherited from Object.)

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");
}

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

Return to top
Show: