ServerBaseWaitForState Method (ServerState, ServerState, Int32, NullableTimeSpan, ActionInt32) |
Waits for the server to enter a specified state.
Namespace: net.openstack.Core.DomainAssembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax public void WaitForState(
ServerState expectedState,
ServerState[] errorStates,
int refreshCount = 600,
Nullable<TimeSpan> refreshDelay = null,
Action<int> progressUpdatedCallback = null
)
Public Sub WaitForState (
expectedState As ServerState,
errorStates As ServerState(),
Optional refreshCount As Integer = 600,
Optional refreshDelay As Nullable(Of TimeSpan) = Nothing,
Optional progressUpdatedCallback As Action(Of Integer) = Nothing
)
public:
void WaitForState(
ServerState^ expectedState,
array<ServerState^>^ errorStates,
int refreshCount = 600,
Nullable<TimeSpan> refreshDelay = nullptr,
Action<int>^ progressUpdatedCallback = nullptr
)
member WaitForState :
expectedState : ServerState *
errorStates : ServerState[] *
?refreshCount : int *
?refreshDelay : Nullable<TimeSpan> *
?progressUpdatedCallback : Action<int>
(* Defaults:
let _refreshCount = defaultArg refreshCount 600
let _refreshDelay = defaultArg refreshDelay null
let _progressUpdatedCallback = defaultArg progressUpdatedCallback null
*)
-> unit
Parameters
- expectedState
- Type: net.openstack.Core.DomainServerState
The expected state. - errorStates
- Type: net.openstack.Core.DomainServerState
The error state(s) in which to throw an exception if the server enters. - refreshCount (Optional)
- Type: SystemInt32
Number of times to poll the server's status. - refreshDelay (Optional)
- Type: SystemNullableTimeSpan
The time to wait between polling requests for the server 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 Remarks
When the method returns, the current instance is updated to reflect the state
of the server at the end of the operation.
Notes to Callers |
---|
This is a blocking operation and will not return until the server enters either an 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