WebSocket Pepper API: C++ utility class implementation.

ppapi/cpp/helper/dev/websocket_api_dev.cc

+// Copyright (c) 2011 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#include "ppapi/cpp/helper/dev/websocket_api_dev.h"
+
+#include "ppapi/c/pp_errors.h"
+#include "ppapi/c/pp_macros.h"
+#include "ppapi/cpp/completion_callback.h"
+#include "ppapi/cpp/dev/websocket_dev.h"
+#include "ppapi/cpp/instance.h"
+#include "ppapi/cpp/module.h"
+#include "ppapi/cpp/module_impl.h"
+#include "ppapi/cpp/var.h"
+
+namespace pp {
+
+namespace helper {

[brettw, 2011/12/21 18:31:57]

There was a thread on the Pepper mailing list and we decided to just use the
namespace "pp" (no "helper" needed) for this type of classes.

[Takashi Toyoshima, 2011/12/22 07:56:29]

OK. I fix it.

+
+class WebSocketAPI_Dev::Implement : public WebSocket_Dev {
+ public:
+  Implement(Instance* instance, WebSocketAPI_Dev* api)
+      : WebSocket_Dev(instance),
+        api_(api),
+        callback_factory_(PP_ALLOW_THIS_IN_INITIALIZER_LIST(this)) {
+  }
+
+  ~Implement() {}
+
+  int32_t Connect(const Var& url, const Var protocols[],
+                  uint32_t protocol_count) {
+    CompletionCallback callback =
+        callback_factory_.NewOptionalCallback(&Implement::DidConnect);

[brettw, 2011/12/21 18:31:57]

Sorry if I wasn't clear in my email, I think we want a required callback here so
you don't run the callback directly. This is to avoid reentering the user of the
object.

Imagine you're writing calling code that calls Connect or Close. You may not
necessarily expect that your OnOpen call will be called from within that
callstack. Depending on how you wrote your code, you may not be set up to handle
a OnOpen call. This is why we have "required" callbacks rather than just making
the underlying Pepper implementation always call the completion callback as soon
as anything fails. Required callbacks go back to the message loop so your
handlers don't get called re-entrantly.

With optional callbacks, you have to handle the "synchronous" case explicitly.
This is the annoying part of them, but it also means that the caller calls into
their code explicitly which makes this type of error very difficult to make.

[Takashi Toyoshima, 2011/12/22 07:56:29]

I understand that you afraid of calling Connect or Close recursively from On*
virtual methods. Right?

As I added comments below, callback.Run is just for consuming objects allocated
by factory class. Actually, I passed PP_ERROR_ABORTED in order to do nothing in
actual callback DidConnect and DidClose. Synchronous invoking callbacks is
totally hidden from caller, and On* virtual methods are never called in these
cases. Then caller has no chance to reenter the object.

But, I think also you might feel returning error synchronously is not so
suitable for pepper.

Behaviors on OnOpen, OnError, and OnClose are defined strictly by The WebSocket
API specification. So, I think changing their behaviors on pepper bindings is
not better way.

If you think I had better to return all errors asynchronously, how about adding
other virtual functions like OnOpenException, OnSendException, and
OnCloseException. It will not break original API's semantics and fit the pepper
style.

+    int32_t result =
+        WebSocket_Dev::Connect(url, protocols, protocol_count, callback);
+    if (result != PP_OK_COMPLETIONPENDING) {
+      // Consumes callback here and uses PP_ERROR_ABORTED instead of result
+      // in order to avoid side effects in DidConnect.
+      callback.Run(PP_ERROR_ABORTED);
+    }
+    return result;
+  }
+
+  int32_t Close(uint16_t code, const Var& reason) {
+    CompletionCallback callback =
+        callback_factory_.NewOptionalCallback(&Implement::DidClose);
+    int32_t result = WebSocket_Dev::Close(code, reason, callback);
+    if (result != PP_OK_COMPLETIONPENDING) {
+      // Consumes callback here and uses PP_ERROR_ABORTED instead of result
+      // in order to avoid side effects in DidClose.
+      callback.Run(PP_ERROR_ABORTED);
+    }
+    return result;
+  }
+
+  void Receive() {
+    int32_t result;
+    do {
+      CompletionCallback callback =
+          callback_factory_.NewOptionalCallback(&Implement::DidReceive);
+      result = WebSocket_Dev::ReceiveMessage(&receive_message_var_, callback);
+      if (result != PP_OK_COMPLETIONPENDING)
+        callback.Run(result);
+    } while (result == PP_OK);
+  }
+
+  void DidConnect(int32_t result) {
+    if (result == PP_OK) {
+      api_->OnOpen();
+      Receive();
+    } else if (result != PP_ERROR_ABORTED) {
+      DidClose(result);
+    }
+  }
+
+  void DidReceive(int32_t result) {
+    if (result == PP_OK) {
+      api_->OnMessage(receive_message_var_);
+      Receive();
+    } else if (result != PP_ERROR_ABORTED) {
+      DidClose(result);
+    }
+  }
+
+  void DidClose(int32_t result) {
+    if (result == PP_ERROR_ABORTED)
+      return;
+    bool was_clean = GetCloseWasClean() && result == PP_OK;
+    if (!was_clean)
+      api_->OnError();

[brettw, 2011/12/21 18:31:57]

Maybe we can sent the Pepper error value to OnError? Otherwise it will get lost
when everything is async.

[Takashi Toyoshima, 2011/12/22 07:56:29]

To tell the truth, only PP_ERROR_ABORTED and PP_OK are passed to the Close's
callback.

This is because Close() doesn't have any error originally and incoming close
events caused by the peer server or underlying network troubles have code and
reason arguments in OnClose() handler.

Yes, now I notice that the condition 'result == PP_OK' is meaningless here...

+    api_->OnClose(was_clean, GetCloseCode(), GetCloseReason());
+  }
+
+ private:
+  WebSocketAPI_Dev* api_;
+  CompletionCallbackFactory<Implement> callback_factory_;
+  Var receive_message_var_;
+};
+
+WebSocketAPI_Dev::WebSocketAPI_Dev(Instance* instance)
+    : impl_(new Implement(instance, PP_ALLOW_THIS_IN_INITIALIZER_LIST(this))) {
+}
+
+WebSocketAPI_Dev::~WebSocketAPI_Dev() {
+  delete impl_;
+}
+
+int32_t WebSocketAPI_Dev::Connect(const Var& url, const Var protocols[],
+                                  uint32_t protocol_count) {
+  return impl_->Connect(url, protocols, protocol_count);
+}
+
+int32_t WebSocketAPI_Dev::Close(uint16_t code, const Var& reason) {
+  return impl_->Close(code, reason);
+}
+
+int32_t WebSocketAPI_Dev::Send(const Var& data) {
+  return impl_->SendMessage(data);
+}
+
+uint64_t WebSocketAPI_Dev::GetBufferedAmount() {
+  return impl_->GetBufferedAmount();
+}
+
+Var WebSocketAPI_Dev::GetExtensions() {
+  return impl_->GetExtensions();
+}
+
+Var WebSocketAPI_Dev::GetProtocol() {
+  return impl_->GetProtocol();
+}
+
+PP_WebSocketReadyState_Dev WebSocketAPI_Dev::GetReadyState() {
+  return impl_->GetReadyState();
+}
+
+Var WebSocketAPI_Dev::GetURL() {
+  return impl_->GetURL();
+}
+
+}  // namespace helper
+
+}  // namespace pp