public/fidl/fuchsia.sys2/runtime/component_runner.fidl

// Copyright 2016 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

library fuchsia.sys2;

using fuchsia.data;
using fuchsia.io;
using zx;

// An interface for running components.
//
// This interface is implemented by components that provide an execution
// environment for running particular classes of programs.  For example,
// the Dart virtual machine exposes a service with this interface to run
// Dart programs.
//
// To specify the runner needed to run your component, set the "runner_uri"
// property in your component's manifest.
//
// Note: The component manager is the only intended direct client of this
// interface.
[Discoverable]
interface ComponentRunner {
    // Starts running a new component instance described by |start_info|.
    //
    // The caller of this method takes responsibility for binding client
    // connections and controlling the lifetime of the newly started
    // component instance through the requested |controller|.
    1: Start(ComponentStartInfo start_info,
             request<ComponentController> controller);
};

// Parameters for starting a new component instance.
table ComponentStartInfo {
    // The resolved URI of the component.
    // This is the canonical URI obtained by the component resolver after
    // after following redirects and resolving relative paths.
    1: string resolved_uri;

    // The component's program declaration.
    // This information originates from |ComponentDecl.program|.
    2: fuchsia.data.Dictionary program;

    // The namespace to provide to the component instance.
    3: ComponentNamespace ns;
};

// An interface for binding client connections and controlling the lifetime
// of a component instance started using |ComponentRunner.Start()|.
//
// Closing the client endpoint of the controller interface implicitly stops the
// controlled component instance exactly as if |Stop()| had been called.
//
// When the controlled component instance terminates or becomes inaccessible
// for any reason, the server invokes |OnEpitaph()| and closes its endpoint
// of the controller interface.
//
// EPITAPH
//
// This interface uses a FIDL epitaph to indicate that the controller
// component instance has terminated and to describe its final disposition.
//
// The following epitaph status codes have particular significance:
//
// - |ZX_OK|: The component instance was successfully terminated in response
//   to |Stop()| and its runtime resources have been fully released.
// - |ZX_ERR_UNAVAILABLE|: The runner was unable to start the component
//   instance.  e.g. The runner could not retrieve the component's assets.
// - |ERR_COMPONENT_DIED|: The component instance was started but
//   subsequently terminated unexpectedly.
//
// Other status codes (e.g. |ZX_ERR_PEER_CLOSED|) may indicate a failure
// of the component runner itself.  The component manager may respond to such
// failures by terminating the component runner's job to ensure system
// stability.
interface ComponentController {
    // Stops the controlled component instance.
    //
    // After stopping the component instance, the server should report
    // an epitaph then close its endpoint of the controller interface.
    1: Stop();

    // Binds a client to the component instance's |exports| directory
    // if it has one.  If the instance does not offer exports, then the
    // controller should close the |exports| interface request.
    //
    // The |client_moniker| identifies the client to the component instance.
    2: Bind(Moniker client_moniker, request<fuchsia.io.Directory> exports);
};