zircon::dart::Handle Class Reference

#include <handle.h>

Inheritance diagram for zircon::dart::Handle:

Public Member Functions
	~Handle ()
zx_handle_t	ReleaseHandle ()
bool	is_valid () const
zx_handle_t	handle () const
zx_koid_t	koid () const
zx_status_t	Close ()
fml::RefPtr< HandleWaiter >	AsyncWait (zx_signals_t signals, Dart_Handle callback)
void	ReleaseWaiter (HandleWaiter *waiter)
Dart_Handle	Duplicate (uint32_t rights)
Dart_Handle	Replace (uint32_t rights)
Public Member Functions inherited from fml::RefCountedThreadSafe< Handle >
void	Release () const
Public Member Functions inherited from fml::internal::RefCountedThreadSafeBase
void	AddRef () const
bool	HasOneRef () const
void	AssertHasOneRef () const
Public Member Functions inherited from tonic::DartWrappable
	DartWrappable ()
virtual const DartWrapperInfo &	GetDartWrapperInfo () const =0
Dart_Handle	CreateDartWrapper (DartState *dart_state)
void	AssociateWithDartWrapper (Dart_Handle wrappable)
void	ClearDartWrapper ()
Dart_WeakPersistentHandle	dart_wrapper () const

Static Public Member Functions
static void	RegisterNatives (tonic::DartLibraryNatives *natives)
static fml::RefPtr< Handle >	Create (zx_handle_t handle)
static fml::RefPtr< Handle >	Create (zx::handle handle)
static fml::RefPtr< Handle >	Unwrap (Dart_Handle handle)
static Dart_Handle	CreateInvalid ()

Private Member Functions
void	RetainDartWrappableReference () const override
void	ReleaseDartWrappableReference () const override

Additional Inherited Members
Public Types inherited from tonic::DartWrappable
enum	DartNativeFields { kPeerIndex , kNumberOfNativeFields }
Protected Member Functions inherited from fml::RefCountedThreadSafe< Handle >
	RefCountedThreadSafe ()
	~RefCountedThreadSafe ()
Protected Member Functions inherited from fml::internal::RefCountedThreadSafeBase
	RefCountedThreadSafeBase ()
	~RefCountedThreadSafeBase ()
bool	Release () const
void	Adopt ()
Protected Member Functions inherited from tonic::DartWrappable
virtual	~DartWrappable ()
Static Protected Member Functions inherited from tonic::DartWrappable
static Dart_PersistentHandle	GetTypeForWrapper (tonic::DartState *dart_state, const tonic::DartWrapperInfo &wrapper_info)

Detailed Description

Handle is the native peer of a Dart object (Handle in dart:zircon) that holds an zx_handle_t. It tracks active waiters on handle too.

Definition at line 26 of file handle.h.

Constructor & Destructor Documentation

~Handle()

zircon::dart::Handle::~Handle

(

)

Definition at line 21 of file handle.cc.

                {
  if (is_valid()) {
    zx_status_t status = Close();
    FML_DCHECK(status == ZX_OK);
  }
}

Member Function Documentation

AsyncWait()

fml::RefPtr< HandleWaiter > zircon::dart::Handle::AsyncWait	(	zx_signals_t	signals,
		Dart_Handle	callback
	)

Definition at line 62 of file handle.cc.

                                                                  {
  if (!is_valid()) {
    FML_LOG(WARNING) << "Attempt to wait on an invalid handle.";
    return nullptr;
  }
 
  fml::RefPtr<HandleWaiter> waiter =
      HandleWaiter::Create(this, signals, callback);
  waiters_.push_back(waiter.get());
 
  return waiter;
}

Close()

zx_status_t zircon::dart::Handle::Close

(

)

Definition at line 54 of file handle.cc.

                          {
  if (is_valid()) {
    zx_handle_t handle = ReleaseHandle();
    return zx_handle_close(handle);
  }
  return ZX_ERR_BAD_HANDLE;
}

Create() [1/2]

static fml::RefPtr< Handle > zircon::dart::Handle::Create ( zx::handle  handle )

inlinestatic

Definition at line 38 of file handle.h.

                                                   {
    return Create(handle.release());
  }

Create() [2/2]

fml::RefPtr< Handle > zircon::dart::Handle::Create ( zx_handle_t  handle )

static

Definition at line 28 of file handle.cc.

                                                   {
  return fml::MakeRefCounted<Handle>(handle);
}

CreateInvalid()

Dart_Handle zircon::dart::Handle::CreateInvalid ( )

static

Definition at line 32 of file handle.cc.

                                  {
  return ToDart(Create(ZX_HANDLE_INVALID));
}

Duplicate()

Dart_Handle zircon::dart::Handle::Duplicate

(

uint32_t

rights

)

Definition at line 84 of file handle.cc.

                                             {
  if (!is_valid()) {
    return ToDart(Create(ZX_HANDLE_INVALID));
  }
 
  zx_handle_t out_handle;
  zx_status_t status = zx_handle_duplicate(handle_, rights, &out_handle);
  if (status != ZX_OK) {
    return ToDart(Create(ZX_HANDLE_INVALID));
  }
  return ToDart(Create(out_handle));
}

handle()

zx_handle_t zircon::dart::Handle::handle ( ) const

inline

Definition at line 53 of file handle.h.

{ return handle_; }

is_valid()

bool zircon::dart::Handle::is_valid ( ) const

inline

Definition at line 51 of file handle.h.

{ return handle_ != ZX_HANDLE_INVALID; }

koid()

zx_koid_t zircon::dart::Handle::koid ( ) const

inline

Definition at line 55 of file handle.h.

                         {
    if (!cached_koid_.has_value()) {
      zx_info_handle_basic_t info;
      zx_status_t status = zx_object_get_info(
          handle_, ZX_INFO_HANDLE_BASIC, &info, sizeof(info), nullptr, nullptr);
      cached_koid_ = std::optional<zx_koid_t>(
          status == ZX_OK ? info.koid : ZX_KOID_INVALID);
    }
    return cached_koid_.value();
  }

RegisterNatives()

void zircon::dart::Handle::RegisterNatives ( tonic::DartLibraryNatives *  natives )

static

Definition at line 132 of file handle.cc.

                                                             {
  natives->Register({FOR_EACH_STATIC_BINDING(DART_REGISTER_NATIVE_STATIC_)
                         FOR_EACH_BINDING(DART_REGISTER_NATIVE)});
}

ReleaseDartWrappableReference()

void zircon::dart::Handle::ReleaseDartWrappableReference ( ) const

inlineoverrideprivatevirtual

Implements tonic::DartWrappable.

Definition at line 82 of file handle.h.

{ Release(); }

ReleaseHandle()

zx_handle_t zircon::dart::Handle::ReleaseHandle

(

)

Definition at line 36 of file handle.cc.

                                  {
  FML_DCHECK(is_valid());
 
  zx_handle_t handle = handle_;
  handle_ = ZX_HANDLE_INVALID;
  cached_koid_ = std::nullopt;
  while (waiters_.size()) {
    // HandleWaiter::Cancel calls Handle::ReleaseWaiter which removes the
    // HandleWaiter from waiters_.
    FML_DCHECK(waiters_.back()->is_pending());
    waiters_.back()->Cancel();
  }
 
  FML_DCHECK(!is_valid());
 
  return handle;
}

ReleaseWaiter()

void zircon::dart::Handle::ReleaseWaiter

(

HandleWaiter *

waiter

)

Definition at line 76 of file handle.cc.

                                               {
  FML_DCHECK(waiter);
  auto iter = std::find(waiters_.cbegin(), waiters_.cend(), waiter);
  FML_DCHECK(iter != waiters_.cend());
  FML_DCHECK(*iter == waiter);
  waiters_.erase(iter);
}

Replace()

Dart_Handle zircon::dart::Handle::Replace

(

uint32_t

rights

)

Definition at line 97 of file handle.cc.

                                           {
  if (!is_valid()) {
    return ToDart(Create(ZX_HANDLE_INVALID));
  }
 
  zx_handle_t out_handle;
  zx_status_t status = zx_handle_replace(ReleaseHandle(), rights, &out_handle);
  if (status != ZX_OK) {
    return ToDart(Create(ZX_HANDLE_INVALID));
  }
  return ToDart(Create(out_handle));
}

RetainDartWrappableReference()

void zircon::dart::Handle::RetainDartWrappableReference ( ) const

inlineoverrideprivatevirtual

Implements tonic::DartWrappable.

Definition at line 80 of file handle.h.

{ AddRef(); }

Unwrap()

static fml::RefPtr< Handle > zircon::dart::Handle::Unwrap ( Dart_Handle  handle )

inlinestatic

Definition at line 42 of file handle.h.

                                                      {
    return fml::RefPtr<Handle>(
        tonic::DartConverter<zircon::dart::Handle*>::FromDart(handle));
  }

---

The documentation for this class was generated from the following files:

• shell/platform/fuchsia/dart-pkg/zircon/sdk_ext/handle.h
• shell/platform/fuchsia/dart-pkg/zircon/sdk_ext/handle.cc