sdk/dart/fuchsia_vfs/lib/src/service.dart

// 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 'package:fidl/fidl.dart' as fidl;
import 'package:fidl_fuchsia_io/fidl_async.dart';
import 'package:zircon/zircon.dart';

import 'vnode.dart';

// ignore_for_file: unnecessary_null_comparison

/// Function passed by service implementation which can be
/// used to serve connection over [request].
typedef Connector<T> = void Function(fidl.InterfaceRequest<T> request);

/// A node which binds a channel to a service implementation when opened.
class Service<T> extends Vnode {
  final Connector<T> _connector;
  bool _closed = false;

  /// Constructor with [Connector]
  Service.withConnector(this._connector) : assert(_connector != null);

  @override
  int inodeNumber() {
    return inoUnknown;
  }

  @override
  int connect(
      OpenFlags flags, ModeType mode, fidl.InterfaceRequest<Node> request,
      [OpenFlags? parentFlags]) {
    if (_closed) {
      sendErrorEvent(flags, ZX.ERR_NOT_SUPPORTED, request);
      return ZX.ERR_NOT_SUPPORTED;
    }
    final status = _validateFlags(flags);
    if (status != ZX.OK) {
      sendErrorEvent(flags, status, request);
      return status;
    }
    _connector(fidl.InterfaceRequest(request.passChannel()));

    return ZX.OK;
  }

  @override
  DirentType type() {
    return DirentType.service;
  }

  int _validateFlags(OpenFlags flags) {
    if (flags & OpenFlags.directory != OpenFlags.$none) {
      return ZX.ERR_NOT_DIR;
    }

    // We don't support OpenFlags.describe, as service request is not going
    // to be of type fidl.InterfaceRequest<Node> most of the time, but we do send
    // OnOpen event incase of bad flags and if OpenFlags.rightDescribe is passed
    // so that underlying services don't need to handle these flags.
    final unsupportedFlags = ~(OpenFlags.rightReadable |
        OpenFlags.rightWritable |
        OpenFlags.posixWritable |
        OpenFlags.posixExecutable |
        OpenFlags.cloneSameRights |
        OpenFlags.notDirectory);
    if (flags & unsupportedFlags != OpenFlags.$none) {
      return ZX.ERR_NOT_SUPPORTED;
    }

    return ZX.OK;
  }

  @override
  void close() {
    _closed = true;
  }
}