Struct StateSynchronousProxy

pub struct StateSynchronousProxy { /* private fields */ }

Implementations

impl StateSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<StateEvent, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

pub fn set( &self, payload: &SystemActivityGovernorState, ___deadline: MonotonicInstant, ) -> Result<StateSetResult, Error>

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, ___deadline: MonotonicInstant, ) -> Result<SystemActivityGovernorState, Error>

Return immediately with the current state of SAG.

pub fn watch( &self, ___deadline: MonotonicInstant, ) -> Result<SystemActivityGovernorState, Error>

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 Debug for StateSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for StateSynchronousProxy

type Proxy = StateProxy

The async proxy for the same protocol.

type Protocol = StateMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.