Struct AppBase 

pub struct AppBase<S: Server> {
    pub running_state: Option<RunningState<S::ExtraRunningState>>,
    pub handle: Handle<S>,
    pub self_check_code: String,
    pub phc_url: Url,
    pub jwt_key: SigningKey,
    pub enc_key: PrivateKey,
    pub admin_key: VerifyingKey,
    pub shared: SharedState<S>,
    pub client: Client,
    pub version: Option<String>,
    pub thread_id: ThreadId,
    pub generation: usize,
}

What’s internally common between PubHubs Apps.

Should NOT be cloned.

Fields

running_state: Option<RunningState<S::ExtraRunningState>>

handle: Handle<S>

self_check_code: String

phc_url: Url

jwt_key: SigningKey

enc_key: PrivateKey

admin_key: VerifyingKey

shared: SharedState<S>

client: Client

version: Option<String>

thread_id: ThreadId

generation: usize

Implementations

impl<S> AppBase<S>

where S::ObjectStoreT: AsObjectStore, S: Server,

pub async fn get_object<T>( &self, id: &T::Identifier, ) -> Result<Option<(T, UpdateVersion)>>

where T: ObjectDetails,

Tries to retrieve an object of type T from this server’s object store with the given id, returning Ok(None) if no such object exists.

pub async fn put_object<T>( &self, obj: &T, update: Option<UpdateVersion>, ) -> Result<Option<UpdateVersion>>

where T: ObjectDetails,

Attempts to put an object of type T into the object store, only overwriting the object that is already present when the version of the to-be-overwritten object is passed via update.

Returs Ok(None) when there is already an object present in the store with that id and type, but its version was not specified in update.

pub async fn delete_object<T>(&self, id: T::Identifier) -> Result<bool>

where T: ObjectDetails,

Attempts to delete an object with the given Id; returns true when an object was deleted, and false when no object with the given id was found.

impl<S: Server> AppBase<S>

pub fn new( creator_base: AppCreatorBase<S>, handle: &Handle<S>, generation: usize, ) -> Self

pub fn running_state_or_please_retry( &self, ) -> Result<&RunningState<S::ExtraRunningState>, ErrorCode>

Returns the current RunningState of this server when available. Otherwise returns api::ErrorCode::PleaseRetry.

pub fn running_state_or_internal_error( &self, ) -> Result<&RunningState<S::ExtraRunningState>, ErrorCode>

Returns the current RunningState of this server when available. Otherwise returns api::ErrorCode::InternalError.

pub fn configure_actix_app(app: &Rc<S::AppT>, sc: &mut ServiceConfig)

Configures common endpoints

pub async fn handle_hub_ping( app: Rc<S::AppT>, signed_req: Json<TicketSigned<PingReq>>, ) -> Result<PingResp>

Shared body of api::server::HubPingEP. Each server has its own handle_hub_ping method that delegates here.

async fn handle_admin_post_config( app: Rc<S::AppT>, signed_req: Json<Signed<UpdateConfigReq>>, ) -> Result<UpdateConfigResp>

Changes server config, and restarts server

async fn handle_admin_info( app: Rc<S::AppT>, signed_req: Json<Signed<InfoReq>>, ) -> Result<InfoResp>

Retrieve non-public information about the server

async fn handle_discovery_run(app: Rc<S::AppT>) -> Result<DiscoveryRunResp>

Run the discovery process, and restarts server if necessary. Returns when the discovery process is completed, but before a possible restart.

pub(super) async fn discover_phc(app: Rc<S::AppT>) -> Result<DiscoveryInfoResp>

fn cached_handle_discovery_info(app: &S::AppT) -> Result<DiscoveryInfoResp>

Trait Implementations

impl<S: Server> Drop for AppBase<S>

fn drop(&mut self)

Executes the destructor for this type.