Struct ServerImpl 

pub struct ServerImpl<D: Details> {
    config: Config,
    app_creator: D::AppCreatorT,
}

Basic implementation of Server.

Fields

config: Config

app_creator: D::AppCreatorT

Implementations

impl<D: Details> ServerImpl<D>

where D::AppT: App<Self>, D::AppCreatorT: AppCreator<Self>, D::ObjectStoreT: Sync,

async fn run_discovery_and_then_wait_forever( &self, app: Rc<D::AppT>, ) -> Result<Infallible>

async fn run_discovery(&self, app: Rc<D::AppT>) -> Result<()>

Trait Implementations

impl App<ServerImpl<Details>> for App

fn configure_actix_app(self: &Rc<Self>, sc: &mut ServiceConfig)

Allows App to add server-specific endpoints. Non-server specific endpoints are added by AppBase::configure_actix_app.

fn check_constellation(&self, constellation: &Constellation) -> bool

Checks whether the given constellation properly reflects this server’s configuration.

async fn discover( self: &Rc<Self>, phc_inf: DiscoveryInfoResp, ) -> Result<DiscoverVerdict>

Runs the discovery routine for this server given api::DiscoveryInfoResp already obtained from Pubhubs Central. If the server is not PHC itself, the Constellation in this api::DiscoveryInfoResp must be set.

fn master_enc_key_part(&self) -> Option<&PrivateKey>

Should return the master encryption key part for PHC and the transcryption.

async fn local_task(_weak: Weak<Self>)

Will be invoked for each instance of App that is created.

async fn global_task(_app: Rc<Self>) -> Result<Infallible>

Will be invoked once for each server, after discovery

impl App<ServerImpl<Details>> for App

fn configure_actix_app(self: &Rc<Self>, sc: &mut ServiceConfig)

Allows App to add server-specific endpoints. Non-server specific endpoints are added by AppBase::configure_actix_app.

fn check_constellation(&self, _constellation: &Constellation) -> bool

Checks whether the given constellation properly reflects this server’s configuration.

async fn discover( self: &Rc<Self>, _phc_di: DiscoveryInfoResp, ) -> Result<DiscoverVerdict>

Runs the discovery routine for this server given api::DiscoveryInfoResp already obtained from Pubhubs Central. If the server is not PHC itself, the Constellation in this api::DiscoveryInfoResp must be set.

fn master_enc_key_part(&self) -> Option<&PrivateKey>

Should return the master encryption key part for PHC and the transcryption.

async fn local_task(weak: Weak<Self>)

Will be invoked for each instance of App that is created.

async fn global_task(app: Rc<Self>) -> Result<Infallible>

Will be invoked once for each server, after discovery

impl App<ServerImpl<Details>> for App

fn configure_actix_app(self: &Rc<Self>, sc: &mut ServiceConfig)

Allows App to add server-specific endpoints. Non-server specific endpoints are added by AppBase::configure_actix_app.

fn check_constellation(&self, constellation: &Constellation) -> bool

Checks whether the given constellation properly reflects this server’s configuration.

fn master_enc_key_part(&self) -> Option<&PrivateKey>

Should return the master encryption key part for PHC and the transcryption.

async fn discover( self: &Rc<Self>, phc_inf: DiscoveryInfoResp, ) -> Result<DiscoverVerdict>

Runs the discovery routine for this server given api::DiscoveryInfoResp already obtained from Pubhubs Central. If the server is not PHC itself, the Constellation in this api::DiscoveryInfoResp must be set.

async fn local_task(_weak: Weak<Self>)

Will be invoked for each instance of App that is created.

async fn global_task(_app: Rc<Self>) -> Result<Infallible>

Will be invoked once for each server, after discovery

impl AppCreator<ServerImpl<Details>> for AppCreator

type ContextT = ()

When Apps are created a new AppCreator::ContextT is created, and a reference to it is passed to AppCreator::into_app.

fn new(config: &Config) -> Result<Self>

Creates a new instance of this AppCreator based on the given configuration.

fn into_app( self, handle: &Handle<ServerImpl<Details>>, _context: &Self::ContextT, generation: usize, ) -> App

Create an App instance.

impl AppCreator<ServerImpl<Details>> for AppCreator

type ContextT = AppCreatorContext

When Apps are created a new AppCreator::ContextT is created, and a reference to it is passed to AppCreator::into_app.

fn into_app( self, handle: &Handle<ServerImpl<Details>>, context: &Self::ContextT, generation: usize, ) -> App

Create an App instance.

fn new(config: &Config) -> Result<Self>

Creates a new instance of this AppCreator based on the given configuration.

impl AppCreator<ServerImpl<Details>> for AppCreator

type ContextT = ()

When Apps are created a new AppCreator::ContextT is created, and a reference to it is passed to AppCreator::into_app.

fn new(config: &Config) -> Result<Self>

Creates a new instance of this AppCreator based on the given configuration.

fn into_app( self, handle: &Handle<ServerImpl<Details>>, _context: &Self::ContextT, generation: usize, ) -> App

Create an App instance.

impl<D: Details> Deref for ServerImpl<D>

type Target = <D as Details>::AppCreatorT

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<D: Details> DerefMut for ServerImpl<D>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<D: Details> Server for ServerImpl<D>

where D::AppT: App<Self>, D::AppCreatorT: AppCreator<Self>, D::ObjectStoreT: Sync,

const NAME: Name = D::NAME

type AppCreatorT = <D as Details>::AppCreatorT

Is moved accross threads to create the Apps.

type AppT = <D as Details>::AppT

type ExtraConfig = <D as GetServerConfig>::Extra

type ExtraRunningState = <D as Details>::ExtraRunningState

Additional state when the server is running

type ExtraSharedState = <D as Details>::ExtraSharedState

Additional shared state

type ObjectStoreT = <D as Details>::ObjectStoreT

Type of this server’s object store, usually an object_store::ObjectStore, or ().

fn new(config: &Config) -> Result<Self>

fn config(&self) -> &Config

fn server_config_from(config: &Config) -> &ServerConfig<Self::ExtraConfig>

fn create_running_state( &self, constellation: &Constellation, ) -> Result<Self::ExtraRunningState>

fn create_extra_shared_state(config: &Config) -> Result<Self::ExtraSharedState>

async fn run_until_modifier( self: Rc<Self>, shutdown_receiver: Receiver<Infallible>, app: Rc<Self::AppT>, ) -> Result<Option<Box<dyn Modifier<Self>>>>

This function is called when the server is started to run discovery.

fn default_port() -> u16

Returns the default TCP port this server binds to.

fn server_config(&self) -> &ServerConfig<Self::ExtraConfig>

fn cors() -> Cors

Creates cross-origin resource sharing middleware for this server.