sdk/fidl/fuchsia.sys2/decls/expose_decl.fidl

// Copyright 2019 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.io2;
using fuchsia.component;

/// Declares a capability exposed to either a component's containing realm or to the framework.
/// For example, a legacy service exposed by the component at runtime.
type ExposeDecl = flexible union {
    1: service ExposeServiceDecl;
    2: protocol ExposeProtocolDecl;
    3: directory ExposeDirectoryDecl;
    4: runner ExposeRunnerDecl;
    5: resolver ExposeResolverDecl;
};

/// Declares a service exposed to a component's containing realm, such as a
/// service exposed by the component or one of its children at runtime.
///
/// To learn more about services, see:
/// https://fuchsia.dev/fuchsia-src/glossary#service
type ExposeServiceDecl = table {
    /// The provider of the capability relative to the component itself. Must
    /// be `self` or `child`.
    1: source Ref;

    /// Name identifying the service, by which it was presented to this
    /// component.
    2: source_name fuchsia.component.name;

    /// The destination to which the service is exposed: either the component's realm or the
    /// framework.
    3: target Ref;

    /// The name by which the capability is being exposed.
    4: target_name fuchsia.component.name;
};

/// Declares a protocol exposed to a component's containing realm, such as
/// a protocol exposed by the component or one of its children at runtime.
///
/// To learn more about protocols, see:
/// https://fuchsia.dev/fuchsia-src/glossary#protocol
type ExposeProtocolDecl = table {
    /// The provider of the capability relative to the component itself. Must
    /// be `self` or `child`.
    1: source Ref;

    /// Name identifying the protocol, by which it was presented to this
    /// component.
    2: source_name fuchsia.component.name;

    /// The destination to which the protocol is exposed: either the component's
    /// realm or the framework.
    3: target Ref;

    /// The name by which the capability is being exposed.
    4: target_name fuchsia.component.name;
};

/// Declares a directory exposed to a component's containing realm, such as a
/// directory exposed by the component or one of its children at runtime.
type ExposeDirectoryDecl = table {
    /// The provider of the capability relative to the component itself. Must
    /// be `self` or `child`.
    1: source Ref;

    /// Name identifying the directory, by which it was presented to this
    /// component.
    2: source_name fuchsia.component.name;

    /// The destination to which the directory is exposed: either the component's realm or the
    /// framework.
    3: target Ref;

    /// The name by which the capability is being exposed.
    4: target_name fuchsia.component.name;

    /// The maximum rights that can be set by a component using this directory,
    /// required iff `source == self`.
    5: rights fuchsia.io2.Rights;

    /// The subdirectory of this directory to expose instead of the root. Optional.
    6: subdir string:fuchsia.component.MAX_PATH_LENGTH;
};

/// Declares a runner exposed to a component's containing realm, such as a
/// runner exposed by the component or one of its children at runtime.
type ExposeRunnerDecl = table {
    /// The provider of the capability relative to the component itself. Must
    /// be `self` or `child`.
    1: source Ref;

    /// The name of the runner, by which it was presented to this component.
    2: source_name fuchsia.component.name;

    /// The destination to which the runner is exposed: either the component's realm or the
    /// framework.
    3: target Ref;

    /// The name by which the capability is being exposed.
    4: target_name fuchsia.component.name;
};

/// Declares a resolver exposed to a component's containing realm, such as a
/// resolver exposed by the component or one of its children at runtime.
type ExposeResolverDecl = table {
    /// The provider of the capability relative to the component itself. Must
    /// be `self` or `child`.
    1: source Ref;

    /// The name of the resolver, by which it was presented to this component.
    2: source_name fuchsia.component.name;

    /// The destination to which the resolver is exposed: either the component's realm or the
    /// framework.
    3: target Ref;

    /// The name by which the capability is being exposed.
    4: target_name fuchsia.component.name;
};