Struct StateProxy

pub struct StateProxy { /* private fields */ }

Implementations

impl StateProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for test.sagcontrol/State.

pub fn take_event_stream(&self) -> StateEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn set( &self, payload: &SystemActivityGovernorState, ) -> QueryResponseFut<StateSetResult, DefaultFuchsiaResourceDialect>

Sets the power elements to specific states supported by SAG.

The initial state of SAG is (2, 0, 0, 0). SAG maintains execution_state_level == 2 until a “boot complete” logic is triggered. “boot complete” logic is triggered by setting SAG states to (2, 1, any, any).

Supported states before “boot complete”:

• (2, any, any, any) Supported states after “boot complete”:
• (2, 1, any, any)
• (1, 0, 1, any)
• (1, 0, any, 1)
• (0, 0, 0, 0)

In SystemActivityGovernorState, omitting specifying a power element’s state will preserve its existing state.

pub fn get( &self, ) -> QueryResponseFut<SystemActivityGovernorState, DefaultFuchsiaResourceDialect>

Return immediately with the current state of SAG.

pub fn watch( &self, ) -> QueryResponseFut<SystemActivityGovernorState, DefaultFuchsiaResourceDialect>

On a given connection, the first call will return immediately with SAG’s current state. Subsequent Watch requests will only return if and only if a test.sagcontrol.State.Set call sends a request and SAG’s state has changed to the requested supported state.

For example, if the current state of SAG is (1, 0, 1, 0), the first Watch will return (1, 0, 1, 0). If a test.sagcontrol.State.Set call sends a request to change state to (2, 1, 0, 1), the next Watch will return when the SAG’s state has fully transitioned to (2, 1, 0, 1), any intermediate transient state (in this example, (2, 0, 1, 0), (2, 1, 1, 0) and (2, 1, 1, 1)) will not be returned.

Clients should use this to synchronize SAG states.

Trait Implementations

impl Clone for StateProxy

fn clone(&self) -> StateProxy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StateProxy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Proxy for StateProxy

type Protocol = StateMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.

impl StateProxyInterface for StateProxy

type SetResponseFut = QueryResponseFut<Result<(), SetSystemActivityGovernorStateError>>

type GetResponseFut = QueryResponseFut<SystemActivityGovernorState>

type WatchResponseFut = QueryResponseFut<SystemActivityGovernorState>

fn set(&self, payload: &SystemActivityGovernorState) -> Self::SetResponseFut

fn get(&self) -> Self::GetResponseFut

fn watch(&self) -> Self::WatchResponseFut