1 /*
2  * Copyright (C) 2022 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.libraries.pcc.chronicle.api.flags
18 
19 import kotlinx.coroutines.flow.StateFlow
20 
21 /**
22  * Entrypoint of configuration [Flags] for Chronicle: an abstraction layer between Chronicle and the
23  * underlying application's configuration system.
24  *
25  * Each application integrating Chronicle will need to supply a [FlagsReader] to the dagger graph.
26  * Most applications will populate the [Flags] for their [FlagsReader] using DeviceConfig. For
27  * simplicity, it's required that [Flags] instances be identical for an entire application - even
28  * if the application has multiple processes.
29  */
30 interface FlagsReader {
31   /** The current value of the [Flags] for Chronicle. */
32   val config: StateFlow<Flags>
33 }
34