Struct PublishNamespaceStateMachine 

pub struct PublishNamespaceStateMachine {
    state: PublishNamespaceState,
}

State machine for PUBLISH_NAMESPACE flow. Idle -> Pending -> Active -> Done.

Fields

state: PublishNamespaceState

Implementations

impl PublishNamespaceStateMachine

pub fn new() -> Self

Creates a new machine in PublishNamespaceState::Idle.

pub fn state(&self) -> PublishNamespaceState

Returns the current state of the publish-namespace flow.

pub fn on_publish_namespace_sent(&mut self) -> Result<(), NamespaceError>

Idle -> Pending.

pub fn on_publish_namespace_ok(&mut self) -> Result<(), NamespaceError>

Pending -> Active.

pub fn on_publish_namespace_error(&mut self) -> Result<(), NamespaceError>

Pending -> Done.

pub fn on_publish_namespace_done(&mut self) -> Result<(), NamespaceError>

Active -> Done (publisher withdrawing).

pub fn on_publish_namespace_cancel(&mut self) -> Result<(), NamespaceError>

Active -> Done (subscriber cancelling).

impl PublishNamespaceStateMachine

The same transitions, named for the end the advertisement arrives at.

An announcement this endpoint accepts passes through the states in the same order as one it makes, with every message going the other way: the PUBLISH_NAMESPACE arrives instead of leaving, the answer leaves instead of arriving, the withdrawal arrives and the cancellation leaves. Sharing the transitions and not the names is what lets a refusal say which event was refused, rather than naming the mirror image of it.

pub fn on_publish_namespace_received(&mut self) -> Result<(), NamespaceError>

Idle -> Pending (PUBLISH_NAMESPACE received from the peer).

pub fn on_publish_namespace_ok_sent(&mut self) -> Result<(), NamespaceError>

Pending -> Active (REQUEST_OK sent, accepting the announcement).

pub fn on_publish_namespace_error_sent(&mut self) -> Result<(), NamespaceError>

Pending -> Done (REQUEST_ERROR sent, refusing the announcement).

pub fn on_publish_namespace_done_received( &mut self, ) -> Result<(), NamespaceError>

Active -> Done (PUBLISH_NAMESPACE_DONE received, the peer withdrawing).

pub fn on_publish_namespace_cancel_sent(&mut self) -> Result<(), NamespaceError>

Active -> Done (PUBLISH_NAMESPACE_CANCEL sent, revoking an acceptance).

Active is the acceptance: it is the state an announcement reaches by being answered REQUEST_OK and no other way, which is why a cancellation of one never answered is refused here rather than sent.

Trait Implementations

impl Default for PublishNamespaceStateMachine

fn default() -> Self

Returns the “default value” for a type.