ConfigurationManager - класс |
Объект, управляющий конфигурацией приложений Tessa.
К объекту возможно одновременное обращение из нескольких потоков.
Иерархия наследованияПространство имён: Tessa.Platform
Сборка: Tessa (в Tessa.dll) Версия: 3.5.0.19
Синтаксисpublic sealed class ConfigurationManager : IConfigurationManager, IAsyncInitializable
Тип ConfigurationManager предоставляет следующие члены.
Конструкторы| Имя | Описание | |
|---|---|---|
 | ConfigurationManager(String, IEnumerableKeyValuePairString, String) |
Создаёт экземпляр класса с указанием полного пути до файла с конфигурацией.
Вызов конструктора не может завершиться исключением.
После создания объекта необходимо вызвать метод асинхронной инициализации InitializeAsync(CancellationToken).
|
| ConfigurationManager(ConfigurationObject, IEnumerableKeyValuePairString, String) |
Создаёт экземпляр класса с указанием значений его свойств.
После создания объекта необходимо вызвать метод асинхронной инициализации InitializeAsync(CancellationToken).
|
| ConfigurationManager(Assembly, String, IEnumerableKeyValuePairString, String) |
Создаёт экземпляр класса с указанием сборки, рядом с которой лежит файл конфигурации app.json.
Вызов конструктора не может завершиться исключением.
После создания объекта необходимо вызвать метод асинхронной инициализации InitializeAsync(CancellationToken).
|
Свойства| Имя | Описание | |
|---|---|---|
 | Configuration | Объект, описывающий конфигурацию приложения Tessa. |
 | Connections |
Строки подключения для приложения, доступные по умолчанию.
В качестве ключа выступает имя строки подключения,
а в качестве значения - сама строка.
|
| Default |
Конфигурация приложения, доступная по умолчанию. Рекомендуется использовать метод GetDefaultAsync(CancellationToken)
для асинхронной инициализации конфигурации.
|
| DefinedSymbols |
Текущие объявленные символы. По умолчанию соответствуют операционной системе, разрядности процессора
и другим параметрам среды выполнения. В ходе разбора конфигурационных файлов список символов
может изменяться директивой ".define".
|
| Dynamic |
Объект, позволяющий получить любые свойства для текущего приложения.
Например: string serverCode = ConfigurationManager.Dynamic.Settings.ServerCode; |
| Errors | Ошибки, которые возникли при разборе файлов конфигурации сервера. |
| GlobalDefinedSymbols |
Глобально объявленные символы по умолчанию, доступные для всех объектов конфигурации.
По умолчанию соответствуют операционной системе, разрядности процессора и другим параметрам среды выполнения.
Используются для инициализации начального значения свойства DefinedSymbols для каждого объекта конфигурации.
|
| Settings |
Настройки для приложения, доступные по умолчанию.
В качестве ключа выступает имя настройки,
а в качестве значения - её значение (строка, число и т.п.).
Целые числа обычно представление как тип Int64.
|
Методы| Имя | Описание | |
|---|---|---|
| CreateDbManager |
Создаёт объект DbManager с использованием строки подключения с заданным именем.
|
| CreateDefaultAsync |
Создает конфигурацию приложения
|
| Equals | Determines whether the specified object is equal to the current object. (Унаследован от Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Унаследован от Object.) |
| GetConfigurationDataProviderFromType |
Возвращает объект ConfigurationDataProvider по строке, которая описывает
его имя (алиас), полное имя типа или пространство имён.
|
| GetCurrentSymbols |
Возвращает текущие объявленные символы DefinedSymbols, соответствующие операционной системе,
разрядности процессора и другим параметрам среды выполнения.
|
| GetDataProvider |
Получает объект IDataProvider с использованием строки подключения с заданным именем.
|
| GetDbProviderFactory |
Получает объект DbProviderFactory с использованием строки подключения с заданным именем.
|
| GetDefaultAsync |
Получает конфигурацию приложения, доступную по умолчанию.
|
| GetHashCode | Serves as the default hash function. (Унаследован от Object.) |
| GetType | Gets the Type of the current instance. (Унаследован от Object.) |
| InitializeAsync | Выполняет асинхронную инициализацию объекта. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Унаследован от Object.) |
| ToString | Returns a string that represents the current object. (Унаследован от Object.) |
Поля| Имя | Описание | |
|---|---|---|
 | DefaultSymbolValue |
Значение по умолчанию для символов.
|
| DefineDirective |
Директива в конфигурационном файле, выполняющая включение или исключение символов из текущей конфигурации.
Символы в дальнейшей используются в директиве IfDirective.
Пример: ".define": [ "addedSymbol", "!removedSymbol" ] |
| IfDirective |
Директива в конфигурационном файле, выполняющая включение в текущую конфигурацию нижележащего блока при условии,
что выполняется условие, связанное с перечисленными символами.
Пример: ".if": [ [ "existentSymbol", "!absentSymbol" ], { "Key": value } ] |
| IncludeDirective |
Директива в конфигурационном файле, выполняющая включение содержимого указанного файла в текущую конфигурацию.
Пример: ".include": "../app.json" |
| LinuxSymbol |
Символ, объявленный при выполнении на Linux.
|
| Process32BitSymbol |
Символ, объявленный при выполнении в 32-битном процессе.
|
| Process64BitSymbol |
Символ, объявленный при выполнении в 64-битном процессе.
|
| WindowsSymbol |
Символ, объявленный при выполнении на Windows.
|
Методы расширения| Имя | Описание | |
|---|---|---|
 | Get | (Определяется ComHelper.) |
| InternalMarkerCanvas |
Возвращает маркер аннотации
(Определяется AnnotationInternalsAccessor.) |
| Invoke | (Определяется ComHelper.) |
| Set | (Определяется ComHelper.) |
| TryGetConfigurationException |
Возвращает исключение, описывающее все ошибки, которые произошли при инициализации конфигурации,
или null, если ошибок не было. Такое исключение можно выбросить, чтобы передать больше информации о проблеме с конфигурацией.
(Определяется PlatformExtensions.) |
Заметки
После создания объекта необходимо вызвать метод асинхронной инициализации InitializeAsync(CancellationToken).
См. также