 | AutoUpdateConstants Class |
Constants used within Auto Update.
Inheritance HierarchySystemObject
Crestron.AutoUpdateApiCommonAutoUpdateConstants
Crestron.AutoUpdateApiCommonAutoUpdateConstants
Namespace: Crestron.AutoUpdateApiCommon
Assembly: SimplSharpAutoUpdateInterface (in SimplSharpAutoUpdateInterface.dll)
SyntaxC#
public static class AutoUpdateConstants
The AutoUpdateConstants type exposes the following members.
Fields| Name | Description | |
|---|---|---|
  | AnyChangeToSleepyParametersEventName |
This is the name of the event that will be pulsed when there is a change (via console command or API) to any of the following:
1. AUMANIFESTURL
2. AUPASSWORD
3. AUUSERNAME
|
| auApiSyncWaitTimeout |
How long the API waits for the initial sync to take place [DWORD]
|
| auAuiEngineExitThreadPriority |
The priority of the thread that monitors the engine wanting to exit event [DWORD]
|
| auCloudDiagTimeIntervalStr |
Registry Key name - time and interval written by the Cloud Diagnostics to trigger autodiscovery [String]
|
| auConfirmUpdateEventName |
When an update starts, after the initial information block is sent, the engine will wait on
auConfirmUpdateEventName and auDenyUpdateEventName.
If it gets this, it will continue with the update.
|
| auConfirmUpdateTimeout |
The timeout when a message is sent to the API for confirming/denying an update. If the timeout happens,
the update proceeds ahead.
|
| auDefaultConfirmationUpdateTimeout |
Default timeout for API confirmation/denial of update (in ms).
|
| auDefaultLogPath |
Path to the log files for consumption by the API.
|
| auDefaultPluginCatalogUrl |
The default URL to be used for the plugin catalog if NONE is used.
|
| auDenyUpdateEventName |
When an update starts, after the initial information block is sent, the engine will wait on
auConfirmUpdateEventName and auDenyUpdateEventName
If it gets this, it will exit.
|
| auDeviceLoginNameStr |
Registry Key name - The username for auto update to login to remote devices with [String]
|
| auDeviceLoginPasswordStr |
Registry Key name - The password for auto update to login to remote devices with [String]
|
| auEnabledStr |
Registry Key name - auto update is enabled or disabled. 0 is disabled, 1 is enabled [DWORD]
|
| auEngineAppNumberStr |
Registry Key Name - the app number that the Engine is supposed to be [DWORD].
|
| auErSleepyDeviceFileName |
The location of the "Grumpy" device list.
|
| auFriendlyNameForPythagoras |
This is the name used to set in the InitialParameters class so that the Crestron Scheduler (aka Pythagoras) sees it like a App.
|
| auInterfaceRegistryPathStr |
The general path to the auto update interface in the registry.
|
| auLogFilePath |
The path to the log files [STRING]
|
| auLogFilesDirectoryStr |
Registry Key name - The location where the engine will place the log files. This path has a trailing backslash on it [String]
|
| auManifestUrlStr |
Registry Key name - the URL of the manifest file used by the auto update engine [String]
|
| auMaxAppMessageQSizeStr |
Registry Key name - The maximum size of the message queue between the apps and the interface [DWORD]
|
| auMaxAppMessageSizeStr |
Registry Key name - The maximum message size in the queue between the apps and the interface [DWORD]
|
| auMsgHandlerThreadPriority |
For each API, this is the thread priority of the Message Handler [DWORD]
|
| auPerAppThreadPriority |
The priority of the threads for App00-AppNN + Engine [DWORD]
|
| auPluginCatalogUrlStr |
Registry Key name - the URL of the plugin catalog used by the auto update engine [String]
|
| auPollIntervalStr |
Registry Key name - the value to poll at (assuming no autime is set) [DWORD].
|
| auQueueWriteTimeout |
The timeout when writing to a message queue (used by API->AUI, AUI->Engine) [DWORD]
|
| auReleaseNotesFilename |
Filename that the Engine will dump the "Description" field from the manifest into. It is considered current when
the API receives the "UpdateAvailable" message.
|
| auServerLoginNameStr |
Registry Key name - The username for the server to log into for auto update to obtain files to download [String]
|
| auServerLoginPasswordStr |
Registry Key name - The password for the server to log into for auto update to obtain files to download [String]
|
| auTimerEventEngineAuCloudDiscoveryName |
For Crestron Timer Event Engine - the name of the Event that corresponds to the data for AUCLOUDAUTODISCOVERYINTERVAL
|
| auTimerEventEngineAupollintervalName |
For Crestron Timer Event Engine - the name of the Event that corresponds to the data for AUPOLLINTERVAL
|
| auTimerEventEngineAutimeName |
For Crestron Timer Event Engine - the name of the Event that corresponds to the data for AUTIME
|
| auTimerEventEngineGroupNameForAutoUpdate |
For Crestron Timer Event Engine - the name of our Timer group for AUTIME, AUPOLLINTERVAL.
|
| auTimerEventEngineGroupNameForEngineEvents |
For Crestron Timer Event Engine - the name of our Timer group for engine scheduled events.
|
| AutoUpdateEngineSchedulingEventStruct |
Constant AutoUpdateEngineSchedulingEventStruct
|
| AutoUpdateInitialInformationStructOverhead |
Constant AutoUpdateInitialInformationStructOverhead
|
| AutoUpdateIntegerValueStruct |
Constant AutoUpdateIntegerValueStruct
|
| AutoUpdateNoValueStruct |
Constant AutoUpdateNoValueStruct
|
| AutoUpdateStringStructSize |
For the queues - the size of the string for fixed data.
|
| AutoUpdateTimeToPerformDiscoveryStruct |
Constant AutoUpdateTimeToPerformUpdateStruct
|
| AutoUpdateTimeToPerformUpdateStruct |
Constant AutoUpdateTimeToPerformUpdateStruct
|
| ControlSystemToDeviceUpdateProgressStructOverhead |
Constant ControlSystemToDeviceUpdateProgressStructOverhead
|
| EngineExitCancelViaApiEventName |
Event that the AUI will set so that the engine knows it needs to exit as a cancel from the API.
|
| EngineExitCancelViaConsoleEventName |
Event that the AUI will set so that the engine knows it needs to exit as a cancel from the Console.
|
| EngineExitFromApiForceEventName |
Event that the AUI will set to let the engine know we want to do a FORCE through the API. Engine waits on it.
|
| EngineExitFromConsoleForceEventName |
Event that the AUI will set to let the engine know we want to do a FORCE through the console. Engine waits on it.
|
| EngineExitOkEventName |
Event that the AUI will set so that the engine knows it is OK to exit cleanly.
|
| EngineIsRunningEventName |
Event that both the engine and AUI create - if the AUI creates it and then does a GetLastError() and sees that ERROR_ALREADY_EXISTS, then
we know the engine is up and running, otherwise, we should close the event and assume it's not running.
|
| EngineWantsToExitEventName |
The name of the event that the Auto Update Engine will set when it wants to exit cleanly. AUI will wait on it.
|
| EngineWantsToExitFromApiCancelEventName |
The name of the event that the Auto Update Engine will set when it wants to exit from an API cancel. AUI will wait on it.
|
| EngineWantsToExitFromApiForceEventName |
The name of the event that the Auto Update Engine will set when it wants to exit from an API Force. AUI will wait on it.
|
| EngineWantsToExitFromConsoleCancelEventName |
The name of the event that the Auto Update Engine will set when it wants to exit from a Console cancel. AUI will wait on it.
|
| EngineWantsToExitFromConsoleForceEventName |
The name of the event that the Auto Update Engine will set when it wants to exit from a Console Force. AUI will wait on it.
|
| EngineWantsToExitFromGenerateDeviceListsEventName |
The name of the event hat the Auto Update Engine will set when it wants to exit from the GenerateDeviceLists() API call.
|
| ERROR_ALREADY_EXISTS |
From unmanaged API
|
| FromEngineQueue |
The name of the queue where the AUI receives from the engine.
|
| INFINITE |
Constant INFINITE
|
| ParseSeparator |
When building strings in the engine, this is used to concatenate entities. Also used to split them back up in the AUI.
|
| PreviouslyDiscoveredList |
Path for file that holds the contents of the previous discovery (Cresnet, Ethernet, etc...)
|
| RemoteServerToControlSystemUpdateProgressStructOverhead |
Constant RemoteServerToControlSystemUpdateProgressStructOverhead
|
| StringStructOverhead |
Constant StringStructOverhead
|
| TimeoutAfterEngineIsToldToExitUntilItActuallyExits |
When the AUI tells the engine it's OK to exit, there is still some finite time it takes to go away.
The engine will notify us via an event, but we should have some timeout in case the engine never goes away,
We can't wait forever.
This is in milliseconds.
|
| TimeoutForEngineAbortSuccess |
Timeout to wait for the engine to actually abort when it's cancelled.
|
| ToEngineQueue |
The name of the queue where the AUI transmits to the engine.
|
| WAIT_ABANDONED |
Constant WAIT_ABANDONED
|
| WAIT_ABANDONED_0 |
Constant WAIT_ABANDONED_0
|
| WAIT_FAILED |
Constant WAIT_FAILED
|
| WAIT_OBJECT_0 |
Constant WAIT_OBJECT_0
|
RemarksFor any new registry keys or branches, please remember to make entries into SaveRegistry.cpp under EthCmdUtility.
See Also