Honoring Asian Pacific American Heritage Month. See how.

fuchsia.thermal

Added: 7

PROTOCOLS

ClientStateConnector

Defined in fuchsia.thermal/client_state.fidl

Allows a client to connect a ClientStateWatcher to the thermal state of a given ClientType.

Connect

Connects a ClientStateWatcher to the thermal state of the specified ClientType.

A client may call this method and begin using the ClientStateWatcher client endpoint immediately.

If client_type does not exactly (case-sensitive) match with a client entry found in the central thermal configuration, then the request will fail. On failure, both the watcher server endpoint as well as the current ClientStateConnector connection will be terminated.

  • client_type specifies the client-specific thermal state to which watcher should be connected. The value is valid iff it matches with a client entry found in the central thermal configuration.

  • watcher is the server endpoint of a ClientStateWatcher channel that will be connected to the thermal state of client_type.

Request

NameType
client_type ClientType
watcher request<ClientStateWatcher>

ClientStateWatcher

Defined in fuchsia.thermal/client_state.fidl

Allows a client to watch for changes to its thermal state.

This protocol cannot be connected to the service directly. Instead, the server endpoint of a ClientStateWatcher channel must be connected to the thermal state of the desired client type using the [ClientStateConnector.Connect'] method. The client endpoint of a ClientStateWatcher` channel is only useful after it has been connected in this way.

Watch

Watches for changes to a client's thermal state.

A client's thermal state is determined according to the central thermal configuration of its specific type. See the README.md for more details.

On a given connection, the first call will return immediately with the client's current thermal state. Subsequent Watch requests will only return a new state if the client's thermal state has changed. This follows the hanging get pattern.

  • state is an unsigned integer representing the client's thermal state.

Request

<EMPTY>

Response

NameType
state uint64

CONSTANTS

NameValueTypeDescription
MAX_THERMAL_LOAD 100 uint32

The maximum value of the normalized thermal load. This value bounds the width (and therefore also the precision) of the normalized thermal limiting range starting from 0. Trip points must be specified within this range.

TYPE ALIASES

NameValueDescription
ClientType string[8]

A string that represents the type of client using the protocol.

ClientType is used as a parameter to ClientStateConnector.Connect to connect a ClientStateWatcher to the thermal state of the desired client type.

A ClientType value should describe the type of subsystem a client represents and must exactly (case-sensitive) match with a client entry found in the central thermal configuration. Typical examples include "audio", "wifi", etc.