public/dart-pkg/zircon/lib/src/system.dart

// Copyright 2017 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.

part of zircon;

// ignore_for_file: native_function_body_in_non_sdk_code
// ignore_for_file: public_member_api_docs

@pragma('vm:entry-point')
class _Namespace { // ignore: unused_element
  // No public constructor - this only has static methods.
  _Namespace._();

  // Library private variable set by the embedder used to cache the
  // namespace (as an fdio_ns_t*).
  @pragma('vm:entry-point')
  static int _namespace; // ignore: unused_field
}

/// An exception representing an error returned as an zx_status_t.
class ZxStatusException implements Exception {
  final String message;
  final int status;

  ZxStatusException(this.status, [this.message]);

  @override
  String toString() {
    if (message == null)
      return 'ZxStatusException: status = $status';
    else
      return 'ZxStatusException: status = $status, "$message"';
  }
}

class _Result {
  final int status;
  const _Result(this.status);
}

@pragma('vm:entry-point')
class HandleResult extends _Result {
  final Handle handle;
  @pragma('vm:entry-point')
  const HandleResult(final int status, [this.handle]) : super(status);
  @override
  String toString() => 'HandleResult(status=$status, handle=$handle)';
}

@pragma('vm:entry-point')
class HandlePairResult extends _Result {
  final Handle first;
  final Handle second;
  @pragma('vm:entry-point')
  const HandlePairResult(final int status, [this.first, this.second])
      : super(status);
  @override
  String toString() =>
      'HandlePairResult(status=$status, first=$first, second=$second)';
}

@pragma('vm:entry-point')
class ReadResult extends _Result {
  final ByteData bytes;
  final int numBytes;
  final List<Handle> handles;
  @pragma('vm:entry-point')
  const ReadResult(final int status, [this.bytes, this.numBytes, this.handles])
      : super(status);
  Uint8List bytesAsUint8List() =>
      bytes.buffer.asUint8List(bytes.offsetInBytes, numBytes);
  String bytesAsUTF8String() => utf8.decode(bytesAsUint8List());
  @override
  String toString() =>
      'ReadResult(status=$status, bytes=$bytes, numBytes=$numBytes, handles=$handles)';
}

@pragma('vm:entry-point')
class WriteResult extends _Result {
  final int numBytes;
  @pragma('vm:entry-point')
  const WriteResult(final int status, [this.numBytes]) : super(status);
  @override
  String toString() => 'WriteResult(status=$status, numBytes=$numBytes)';
}

@pragma('vm:entry-point')
class GetSizeResult extends _Result {
  final int size;
  @pragma('vm:entry-point')
  const GetSizeResult(final int status, [this.size]) : super(status);
  @override
  String toString() => 'GetSizeResult(status=$status, size=$size)';
}

@pragma('vm:entry-point')
class FromFileResult extends _Result {
  final Handle handle;
  final int numBytes;
  @pragma('vm:entry-point')
  const FromFileResult(final int status, [this.handle, this.numBytes])
      : super(status);
  @override
  String toString() =>
      'FromFileResult(status=$status, handle=$handle, numBytes=$numBytes)';
}

@pragma('vm:entry-point')
class MapResult extends _Result {
  final Uint8List data;
  @pragma('vm:entry-point')
  const MapResult(final int status, [this.data]) : super(status);
  @override
  String toString() => 'MapResult(status=$status, data=$data)';
}

@pragma('vm:entry-point')
class System extends NativeFieldWrapperClass2 {
  // No public constructor - this only has static methods.
  System._();

  // Channel operations.
  static HandlePairResult channelCreate([int options = 0])
      native 'System_ChannelCreate';
  static HandleResult channelFromFile(String path)
      native 'System_ChannelFromFile';
  static int connectToService(String path, Handle channel)
      native 'System_ConnectToService';
  static int channelWrite(Handle channel, ByteData data, List<Handle> handles)
      native 'System_ChannelWrite';
  static ReadResult channelQueryAndRead(Handle channel)
      native 'System_ChannelQueryAndRead';

  // Eventpair operations.
  static HandlePairResult eventpairCreate([int options = 0])
      native 'System_EventpairCreate';

  // Socket operations.
  static HandlePairResult socketCreate([int options = 0])
      native 'System_SocketCreate';
  static WriteResult socketWrite(Handle socket, ByteData data, int options)
      native 'System_SocketWrite';
  static ReadResult socketRead(Handle socket, int size)
      native 'System_SocketRead';

  // Vmo operations.
  static HandleResult vmoCreate(int size, [int options = 0])
      native 'System_VmoCreate';
  static FromFileResult vmoFromFile(String path) native 'System_VmoFromFile';
  static GetSizeResult vmoGetSize(Handle vmo) native 'System_VmoGetSize';
  static int vmoSetSize(Handle vmo, int size) native 'System_VmoSetSize';
  static int vmoWrite(Handle vmo, int offset, ByteData bytes)
      native 'System_VmoWrite';
  static ReadResult vmoRead(Handle vmo, int offset, int size)
      native 'System_VmoRead';
  static MapResult vmoMap(Handle vmo) native 'System_VmoMap';

  // Time operations.
  static int clockGet(int clockId) native 'System_ClockGet';

  // TODO(edcoyne): Remove this, it is required to safely do an API transition across repos.
  static int reboot() { return -2; /*ZX_ERR_NOT_SUPPORTED*/ }
}