OOB messages and general message refactor.

runtime/include/dart_api.h

 // Copyright (c) 2011, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 #ifndef INCLUDE_DART_API_H_
 #define INCLUDE_DART_API_H_
 
 /** \mainpage Dart Embedding API Reference
  *
  * Dart is a class-based programming language for creating structured
@@ skipping 403 matching lines @@
  * 'isolate' as the current isolate (see
  * Dart_IsolateInterruptCallback).
  *
  * \param isolate The isolate to be interrupted.
  */
 DART_EXPORT void Dart_InterruptIsolate(Dart_Isolate isolate);
 
 // --- Messages and Ports ---
 
 /**
- * Messages are used to communicate between isolates.
- */
-typedef struct _Dart_Message* Dart_Message;
-
-/**
  * A port is used to send or receive inter-isolate messages
  */
 typedef int64_t Dart_Port;
 
-const Dart_Port kNoReplyPort = 0;
+/**
+ * A message notification callback.
+ *
+ * This callback allows the embedder to provide an alternate wakeup
+ * mechanism for the delivery of inter-isolate messages.  It is the
+ * responsibility of the embedder to call Dart_HandleMessage to
+ * process the message.
+ */
+typedef void (*Dart_MessageNotifyCallback)(Dart_Isolate dest_isolate);
 
 /**
- * A message posting callback.
- *
- * This callback allows the embedder to provide an alternate delivery
- * mechanism for inter-isolate messages. It is the responsibility of
- * the embedder to call Dart_HandleMessage to process the message.
- *
- * If there is no reply port, then the constant 'kNoReplyPort' is
- * passed as the 'reply_port' parameter.
- *
- * The memory pointed to by 'message' has been allocated by malloc. It
- * is the responsibility of the callback to ensure that free(message)
- * is called once the message has been processed.
- *
- * The callback should return false if it runs into a problem
- * processing this message.
- */
-typedef bool (*Dart_PostMessageCallback)(Dart_Isolate dest_isolate,
-                                         Dart_Port dest_port_id,
-                                         Dart_Port reply_port_id,
-                                         Dart_Message message);
-// TODO(turnidge): Add a Dart_ReleaseMessage to hide allocation details.
-
-const Dart_Port kCloseAllPorts = 0;
-
-/**
- * A close port callback.
- *
- * This callback allows the embedder to receive notification when a
- * port is closed. The constant 'kCloseAllPorts' is passed as the
- * 'port' parameter when all active ports are being closed at once.
- */
-typedef void (*Dart_ClosePortCallback)(Dart_Isolate isolate,
-                                       Dart_Port port_id);
-
-/**
- * Allows embedders to provide an alternative mechanism for sending
- * inter-isolate messages. This setting only applies to the current
- * isolate.
+ * Allows embedders to provide an alternative wakeup mechanism for the
+ * delivery of inter-isolate messages. This setting only applies to
+ * the current isolate.
  *
  * Most embedders will only call this function once, before isolate
  * execution begins. If this function is called after isolate
  * execution begins, the embedder is responsible for threading issues.
  */
-DART_EXPORT void Dart_SetMessageCallbacks(
-    Dart_PostMessageCallback post_message_callback,
-    Dart_ClosePortCallback close_port_callback);
+DART_EXPORT void Dart_SetMessageNotifyCallback(
+    Dart_MessageNotifyCallback message_notify_callback);
 // TODO(turnidge): Consider moving this to isolate creation so that it
 // is impossible to mess up.
 
 /**
- * Handles a message on the current isolate.
+ * Handles the next pending message for the current isolate.
  *
  * May generate an unhandled exception error.
  *
- * Note that this function does not free the memory associated with
- * 'dart_message'.
- *
  * \return A valid handle if no error occurs during the operation.
  */
-DART_EXPORT Dart_Handle Dart_HandleMessage(Dart_Port dest_port_id,
-                                           Dart_Port reply_port_id,
-                                           Dart_Message dart_message);
-// TODO(turnidge): Revisit memory management of 'dart_message'.
+DART_EXPORT Dart_Handle Dart_HandleMessage();
 
 /**
  * Processes any incoming messages for the current isolate.
  *
  * This function may only be used when the embedder has not provided
  * an alternate message delivery mechanism with
  * Dart_SetMessageCallbacks. It is provided for convenience.
  *
  * This function waits for incoming messages for the current
  * isolate. As new messages arrive, they are handled using
@@ skipping 19 matching lines @@
  */
 DART_EXPORT bool Dart_HasLivePorts();
 
 /**
  * Posts a message for some isolate. The message is built from a raw
  * array.
  *
  * \param port The destination port.
  * \param length The length of the data array.
  * \param data A data array to be sent in the message.
- *
- * \return True if the message was posted.
  */
 DART_EXPORT bool Dart_PostIntArray(Dart_Port port_id,
                                    intptr_t length,
                                    intptr_t* data);
 // TODO(turnidge): Should this be intptr_t or some fixed length type?
 // TODO(turnidge): Reverse length/data for consistency.
 
 /**
  * Posts a message for some isolate. The message is a serialized
  * object.
  *
  * Requires there to be a current isolate.
  *
  * \param port The destination port.
  * \param object An object from the current isolate.
- *
- * \return True if the message was posted.

[Ivan Posva, 2012/01/23 22:00:43]

Why are you removing the documentation for these two functions?

[turnidge, 2012/01/23 22:32:52]

In an earlier rev, I made these void functions.  Then I undid it and forgot to
fix the docs.  Thanks.  Fixed.

  */
 DART_EXPORT bool Dart_Post(Dart_Port port_id, Dart_Handle object);
 
 /**
  * Returns a new SendPort with the provided port id.
  */
 DART_EXPORT Dart_Handle Dart_NewSendPort(Dart_Port port_id);
 
 /**
  * Gets the ReceivePort for the provided port id, creating it if necessary.
@@ skipping 814 matching lines @@
 
 // --- Profiling support ----
 
 // External pprof support for gathering and dumping symbolic
 // information that can be used for better profile reports for
 // dynamically generated code.
 DART_EXPORT void Dart_InitPprofSupport();
 DART_EXPORT void Dart_GetPprofSymbolInfo(void** buffer, int* buffer_size);
 
 #endif  // INCLUDE_DART_API_H_