CK-DeviceModel/CK.DeviceModel/Host/DeviceApplyConfigurationResult.cs at develop · signature-opensource/CK-DeviceModel · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
namespace CK.DeviceModel;

/// <summary>
/// Describes the result of a device initial configuration or reconfiguration.
/// This is returned for each device in <see cref="DeviceHost{T, THostConfiguration, TConfiguration}.ConfigurationResult"/>
/// and is the result of the <see cref="ConfigureDeviceCommand{THost,TConfiguration}"/>.
/// </summary>
public enum DeviceApplyConfigurationResult
{
    /// <summary>
    /// No configuration happened.
    /// </summary>
    None,

    /// <summary>
    /// A new configuration is invalid: a new device failed to be instantiated.
    /// </summary>
    CreateFailed,

    /// <summary>
    /// A new configuration has successfully created a new device.
    /// </summary>
    CreateSucceeded,

    /// <summary>
    /// A new configuration has successfully created a new device that has been started (see <see cref="DeviceConfigurationStatus.AlwaysRunning"/> or <see cref="DeviceConfigurationStatus.RunnableStarted"/>).
    /// </summary>
    CreateAndStartSucceeded,

    /// <summary>
    /// A new configuration has successfully created a new device but its start failed (see <see cref="DeviceConfigurationStatus.AlwaysRunning"/> or <see cref="DeviceConfigurationStatus.RunnableStarted"/>).
    /// </summary>
    CreateSucceededButStartFailed,

    /// <summary>
    /// Changing the device's configuration has failed.
    /// </summary>
    UpdateFailed,

    /// <summary>
    /// The device's configuration has been changed.
    /// </summary>
    UpdateSucceeded,

    /// <summary>
    /// Changing the configuration requires the device to be stopped first.
    /// </summary>
    UpdateFailedRestartRequired,

    /// <summary>
    /// The device's configuration has been changed but the configured status (<see cref="DeviceConfigurationStatus.AlwaysRunning"/> or <see cref="DeviceConfigurationStatus.RunnableStarted"/>)
    /// implied a Start that failed.
    /// </summary>
    UpdateSucceededButStartFailed,

    /// <summary>
    /// The configuration was invalid.
    /// </summary>
    InvalidConfiguration,

    /// <summary>
    /// The device has been destroyed.
    /// </summary>
    DeviceDestroyed,

    /// <summary>
    /// The configuration has been canceled.
    /// </summary>
    ConfigurationCanceled,

    /// <summary>
    /// The <see cref="IDevice.ControllerKey"/> doesn't match the <see cref="BaseDeviceCommand.ControllerKey"/>.
    /// </summary>
    InvalidControllerKey,

    /// <summary>
    /// An unexpected error occurred.
    /// </summary>
    UnexpectedError

}