Click or drag to resize
SimpleServerImageWaitForState Method (ImageState, ImageState, Int32, NullableTimeSpan, ActionInt32)
Waits for the image to enter a specified state.

Namespace: net.openstack.Core.Domain
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax
public void WaitForState(
	ImageState expectedState,
	ImageState[] errorStates,
	int refreshCount = 600,
	Nullable<TimeSpan> refreshDelay = null,
	Action<int> progressUpdatedCallback = null
)

Parameters

expectedState
Type: net.openstack.Core.DomainImageState
The expected state.
errorStates
Type: net.openstack.Core.DomainImageState
The error state(s) in which to throw an exception if the image enters.
refreshCount (Optional)
Type: SystemInt32
Number of times to poll the image's status.
refreshDelay (Optional)
Type: SystemNullableTimeSpan
The time to wait between polling requests for the image status. If this value is , the default is 2.4 seconds.
progressUpdatedCallback (Optional)
Type: SystemActionInt32
A callback delegate to execute each time the Progress value increases. If this value is , progress updates are not reported.
Exceptions
ExceptionCondition
ArgumentNullException If expectedState is .

-or-

If errorStates is .

ArgumentOutOfRangeException If refreshCount is less than 0.

-or-

If refreshDelay is negative.

ImageEnteredErrorStateExceptionIf the method returned due to the image entering one of the errorStates.
ResponseExceptionIf the REST API request failed.
Remarks
When the method returns, the current instance is updated to reflect the state of the image at the end of the operation.
Note Notes to Callers
This is a blocking operation and will not return until the image enters either the expected state, an error state, or the retry count is exceeded.
Version Information

.NET Framework

Supported in: 4.5

openstack.net

Supported in: 1.6, 1.5, 1.4, 1.3.6
See Also