Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
96 lines (83 sloc) 3.57 KB
// Copyright 2018 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.
import 'dart:async';
import 'package:fidl/fidl.dart';
import 'package:fidl_fuchsia_auth/fidl_async.dart' as fidl_auth;
import 'package:fidl_fuchsia_modular/fidl_async.dart' as fidl_agent;
import 'agent_task_handler.dart';
import 'internal/_agent_impl.dart';
/// The service provider function that is responsible to return a service that
/// will be exposed upon receiving a service request. Where [T] represents the
/// service type.
typedef ServiceProvider<T> = FutureOr<T> Function();
/// Agent is a globally available object which simplifies common tasks that
/// agent developers will face. At a high level, it is a wrapper around the
/// [agent_context.fidl] and [agent.fidl] interface.
abstract class Agent {
static Agent _agent;
/// Initializes the shared [Agent] instance.
factory Agent() {
return _agent ??= AgentImpl();
}
/// Associate [serviceImpl] to this [Agent] and exposes it to the rest of the
/// system so that it can be discovered and connected to. Notice that
/// [serviceImpl] is of type `FutureOr<T>`, where [T] represents the service
/// type, to enable the ability to wait for any asynchronous operations to
/// finish before initializing and exposing the service.
///
/// Note: Multiple connections will be allowed to this [serviceImpl].
/// [serviceData] can be found as part of the generated FIDL bindings, it
/// holds the service runtime name and bindings object used for establishing a
/// connection.
///
/// Usage example:
/// ```
/// import 'package:fidl_fuchsia_foo/fidl_async.dart' as fidl;
/// import 'package:fuchsia_modular/agent.dart';
/// import 'src/foo_service_impl.dart';
///
/// void main(List<String> args) {
/// Agent().exposeService(FooServiceImpl(), fidl.FooServiceData());
/// }
///
/// class FooServiceImpl extends fidl.FooService { ... }
/// ```
void exposeService<T>(FutureOr<T> serviceImpl, ServiceData<T> serviceData);
/// Similar to [#exposeService] but instead of passing the service
/// implementation directly, pass a provider function that can be invoked
/// asynchronously, when a request is received, to provide the service
/// implementation at run time.
///
/// [ServiceProvider] is defined as follows:
/// ```
/// typedef ServiceProvider<T> = FutureOr<T> Function();
/// ```
/// Where [T] represents the service type.
void exposeServiceProvider<T>(
ServiceProvider<T> serviceProvider, ServiceData<T> serviceData);
/// Returns the auth token manager this Agent may use for accessing external
/// services.
fidl_auth.TokenManagerProxy getTokenManager();
/// Registers the [taskHandler] with this.
///
/// This method must be called before scheduling any tasks via [scheduleTask].
/// It is also recommend to register as part of the main method in order to
/// start running tasks as soon as possible.
///
/// ```
/// void main(List<String> args) {
/// Agent()
/// ..registerTaskHandler(MyAgentTaskHandler());
/// }
///
/// class MyAgentTaskHandler extends AgentTaskHandler { ... }
/// ```
void registerTaskHandler(AgentTaskHandler taskHandler);
/// Schedules a task described in [taskInfo]. [registerTaskHandler] must be
/// called before scheduling any tasks. When this task is scheduled to
/// run, [AgentTaskHandler.runTask()] is called.
void scheduleTask(fidl_agent.TaskInfo taskInfo);
/// No new runs of this [taskId] will be scheduled.
void deleteTask(String taskId);
}