dart::Message Class Reference

#include <message.h>

Public Types
enum	Priority { kNormalPriority = 0 , kOOBPriority = 1 , kFirstPriority = 0 , kNumPriorities = 2 }
enum	OOBMsgTag { kIllegalOOB = 0 , kServiceOOBMsg = 1 , kIsolateLibOOBMsg = 2 , kDelayedIsolateLibOOBMsg = 3 }

Public Member Functions
	Message (Dart_Port dest_port, uint8_t *snapshot, intptr_t snapshot_length, MessageFinalizableData *finalizable_data, Priority priority)
	Message (Dart_Port dest_port, ObjectPtr raw_obj, Priority priority)
	Message (Dart_Port dest_port, PersistentHandle *handle, Priority priority)
	Message (PersistentHandle *handle, Priority priority)
	~Message ()
Dart_Port	dest_port () const
uint8_t *	snapshot () const
intptr_t	snapshot_length () const
MessageFinalizableData *	finalizable_data ()
intptr_t	Size () const
ObjectPtr	raw_obj () const
PersistentHandle *	persistent_handle () const
Priority	priority () const
bool	IsOOB () const
bool	IsSnapshot () const
bool	IsRaw () const
bool	IsPersistentHandle () const
bool	IsFinalizerInvocationRequest () const
void	DropFinalizers ()
intptr_t	Id () const

Static Public Member Functions
template<typename... Args>
static std::unique_ptr< Message >	New (Args &&... args)
static const char *	PriorityAsString (Priority priority)

Static Public Attributes
static const Dart_Port	kIllegalPort = 0

Friends
class	MessageQueue

Detailed Description

Definition at line 25 of file message.h.

Member Enumeration Documentation

OOBMsgTag

enum dart::Message::OOBMsgTag

Enumerator
kIllegalOOB
kServiceOOBMsg
kIsolateLibOOBMsg
kDelayedIsolateLibOOBMsg

Definition at line 39 of file message.h.

               {
    kIllegalOOB = 0,
    kServiceOOBMsg = 1,
    kIsolateLibOOBMsg = 2,
    kDelayedIsolateLibOOBMsg = 3,
  } OOBMsgTag;

Priority

enum dart::Message::Priority

Enumerator
kNormalPriority
kOOBPriority
kFirstPriority
kNumPriorities

Definition at line 27 of file message.h.

               {
    kNormalPriority = 0,  // Deliver message when idle.
    kOOBPriority = 1,     // Deliver message asap.
 
    // Iteration.
    kFirstPriority = 0,
    kNumPriorities = 2,
  } Priority;

Constructor & Destructor Documentation

Message() [1/4]

Message::Message	(	Dart_Port	dest_port,
		uint8_t *	snapshot,
		intptr_t	snapshot_length,
		MessageFinalizableData *	finalizable_data,
		Priority	priority
	)

Definition at line 19 of file message.cc.

    : dest_port_(dest_port),
      payload_(snapshot),
      snapshot_length_(snapshot_length),
      finalizable_data_(finalizable_data),
      priority_(priority) {
  ASSERT(IsSnapshot());
}

Message() [2/4]

Message::Message	(	Dart_Port	dest_port,
		ObjectPtr	raw_obj,
		Priority	priority
	)

Definition at line 32 of file message.cc.

    : dest_port_(dest_port), payload_(raw_obj), priority_(priority) {
  ASSERT(!raw_obj->IsHeapObject() || raw_obj->untag()->InVMIsolateHeap());
  ASSERT(IsRaw());
}

Message() [3/4]

Message::Message	(	Dart_Port	dest_port,
		PersistentHandle *	handle,
		Priority	priority
	)

Definition at line 38 of file message.cc.

    : dest_port_(dest_port),
      payload_(handle),
      snapshot_length_(kPersistentHandleSnapshotLen),
      priority_(priority) {
  ASSERT(IsPersistentHandle());
}

Message() [4/4]

Message::Message	(	PersistentHandle *	handle,
		Priority	priority
	)

Definition at line 48 of file message.cc.

    : dest_port_(ILLEGAL_PORT),
      payload_(handle),
      snapshot_length_(kFinalizerSnapshotLen),
      priority_(priority) {
  ASSERT(IsFinalizerInvocationRequest());
}

~Message()

Message::~Message

(

)

Definition at line 56 of file message.cc.

                  {
  if (IsSnapshot()) {
    free(payload_.snapshot_);
  }
  delete finalizable_data_;
  if (IsPersistentHandle() || IsFinalizerInvocationRequest()) {
    auto isolate_group = IsolateGroup::Current();
    isolate_group->api_state()->FreePersistentHandle(
        payload_.persistent_handle_);
  }
}

Member Function Documentation

dest_port()

Dart_Port dart::Message::dest_port ( ) const

inline

Definition at line 76 of file message.h.

{ return dest_port_; }

DropFinalizers()

void dart::Message::DropFinalizers ( )

inline

Definition at line 123 of file message.h.

                        {
    if (finalizable_data_ != nullptr) {
      finalizable_data_->DropFinalizers();
    }
  }

finalizable_data()

MessageFinalizableData * dart::Message::finalizable_data ( )

inline

Definition at line 84 of file message.h.

{ return finalizable_data_; }

Id()

intptr_t Message::Id

(

)

const

Definition at line 68 of file message.cc.

                           {
  // Messages are allocated on the C heap. Use the raw address as the id.
  return reinterpret_cast<intptr_t>(this);
}

IsFinalizerInvocationRequest()

bool dart::Message::IsFinalizerInvocationRequest ( ) const

inline

Definition at line 119 of file message.h.

                                            {
    return snapshot_length_ == kFinalizerSnapshotLen;
  }

IsOOB()

bool dart::Message::IsOOB ( ) const

inline

Definition at line 107 of file message.h.

{ return priority_ == Message::kOOBPriority; }

IsPersistentHandle()

bool dart::Message::IsPersistentHandle ( ) const

inline

Definition at line 115 of file message.h.

                                  {
    return snapshot_length_ == kPersistentHandleSnapshotLen;
  }

IsRaw()

bool dart::Message::IsRaw ( ) const

inline

Definition at line 112 of file message.h.

{ return snapshot_length_ == 0; }

IsSnapshot()

bool dart::Message::IsSnapshot ( ) const

inline

Definition at line 108 of file message.h.

                          {
    return !IsRaw() && !IsPersistentHandle() && !IsFinalizerInvocationRequest();
  }

New()

template<typename... Args>

static std::unique_ptr< Message > dart::Message::New ( Args &&...  args )

inlinestatic

Definition at line 72 of file message.h.

                                                    {
    return std::unique_ptr<Message>(new Message(std::forward<Args>(args)...));
  }

persistent_handle()

PersistentHandle * dart::Message::persistent_handle ( ) const

inline

Definition at line 98 of file message.h.

                                              {
    ASSERT(IsPersistentHandle() || IsFinalizerInvocationRequest());
    return payload_.persistent_handle_;
  }

priority()

Priority dart::Message::priority ( ) const

inline

Definition at line 102 of file message.h.

{ return priority_; }

PriorityAsString()

const char * Message::PriorityAsString ( Priority  priority )

static

Definition at line 73 of file message.cc.

                                                       {
  switch (priority) {
    case kNormalPriority:
      return "Normal";
      break;
    case kOOBPriority:
      return "OOB";
      break;
    default:
      UNIMPLEMENTED();
      return nullptr;
  }
}

raw_obj()

ObjectPtr dart::Message::raw_obj ( ) const

inline

Definition at line 94 of file message.h.

                            {
    ASSERT(IsRaw());
    return payload_.raw_obj_;
  }

Size()

intptr_t dart::Message::Size ( ) const

inline

Definition at line 86 of file message.h.

                        {
    intptr_t size = snapshot_length_;
    if (finalizable_data_ != nullptr) {
      size += finalizable_data_->external_size();
    }
    return size;
  }

snapshot()

uint8_t * dart::Message::snapshot ( ) const

inline

Definition at line 78 of file message.h.

                            {
    ASSERT(IsSnapshot());
    return payload_.snapshot_;
  }

snapshot_length()

intptr_t dart::Message::snapshot_length ( ) const

inline

Definition at line 82 of file message.h.

{ return snapshot_length_; }

Friends And Related Symbol Documentation

MessageQueue

friend class MessageQueue

friend

Definition at line 137 of file message.h.

Member Data Documentation

kIllegalPort

const Dart_Port Message::kIllegalPort = 0

static

Definition at line 47 of file message.h.

---

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

• third_party/dart-lang/sdk/runtime/vm/message.h
• third_party/dart-lang/sdk/runtime/vm/message.cc