blob: 92b6fca6b84566e79f00772def9461d4fba85dab [file] [log] [blame]
// Copyright 2015 The Cobalt Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef COBALT_DEBUG_CONSOLE_DEBUGGER_EVENT_TARGET_H_
#define COBALT_DEBUG_CONSOLE_DEBUGGER_EVENT_TARGET_H_
#include <set>
#include <string>
#include "base/callback.h"
#include "base/message_loop/message_loop.h"
#include "base/optional.h"
#include "base/synchronization/lock.h"
#include "cobalt/script/callback_function.h"
#include "cobalt/script/script_value.h"
#include "cobalt/script/wrappable.h"
namespace cobalt {
namespace debug {
namespace console {
// This class implements the onEvent attribute of the Chrome Debugger protocol:
// https://developer.chrome.com/extensions/debugger#event-onEvent
//
// It receives events from the debug dispatcher and passes along to registered
// listeners.
class DebuggerEventTarget : public script::Wrappable {
public:
// Type for JavaScript debugger event callback.
typedef script::CallbackFunction<void(
const std::string& method,
const base::Optional<std::string>& json_params)>
DebuggerEventCallback;
typedef script::ScriptValue<DebuggerEventCallback> DebuggerEventCallbackArg;
// Type for listener info.
// We store the message loop from which the listener was registered,
// so we can run the callback on the same loop.
struct ListenerInfo {
ListenerInfo(DebuggerEventTarget* const debugger_event_target,
const DebuggerEventCallbackArg& cb,
const scoped_refptr<base::SingleThreadTaskRunner>& task_runner)
: callback(debugger_event_target, cb), task_runner(task_runner) {}
DebuggerEventCallbackArg::Reference callback;
scoped_refptr<base::SingleThreadTaskRunner> task_runner;
};
DebuggerEventTarget();
~DebuggerEventTarget();
// Dispatches a debugger event to the registered listeners.
// May be called from any thread.
void DispatchEvent(const std::string& method, const std::string& json_params);
// Called from JavaScript to register an event listener callback.
// May be called from any thread.
void AddListener(const DebuggerEventCallbackArg& callback);
DEFINE_WRAPPABLE_TYPE(DebuggerEventTarget);
protected:
// Notifies a particular listener. Called on the same message loop the
// listener registered its callback from.
void NotifyListener(const ListenerInfo* listener, const std::string& method,
const base::Optional<std::string>& json_params);
private:
typedef std::set<ListenerInfo*> ListenerSet;
ListenerSet listeners_;
base::Lock lock_;
};
} // namespace console
} // namespace debug
} // namespace cobalt
#endif // COBALT_DEBUG_CONSOLE_DEBUGGER_EVENT_TARGET_H_