Introduced SpeechRecognitionDispatcher(Host) classes, handling dispatch of IPC messages for continu…

content/browser/speech/speech_recognition_dispatcher_host.h

 // Copyright (c) 2012 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.
 
-#ifndef CONTENT_BROWSER_SPEECH_INPUT_TAG_SPEECH_DISPATCHER_HOST_H_
-#define CONTENT_BROWSER_SPEECH_INPUT_TAG_SPEECH_DISPATCHER_HOST_H_
+#ifndef CONTENT_BROWSER_SPEECH_SPEECH_RECOGNITION_DISPATCHER_HOST_H_
+#define CONTENT_BROWSER_SPEECH_SPEECH_RECOGNITION_DISPATCHER_HOST_H_
 #pragma once
 
-#include "base/compiler_specific.h"
-#include "base/memory/ref_counted.h"
+#include "base/memory/scoped_ptr.h"
 #include "content/common/content_export.h"
 #include "content/public/browser/browser_message_filter.h"
 #include "content/public/browser/speech_recognition_event_listener.h"
 #include "net/url_request/url_request_context_getter.h"
 
-struct InputTagSpeechHostMsg_StartRecognition_Params;
+struct SpeechRecognitionHostMsg_StartRequest_Params;
 
 namespace content {
 class SpeechRecognitionManager;
 class SpeechRecognitionPreferences;
 struct SpeechRecognitionResult;
 }
 
 namespace speech {
 
-// InputTagSpeechDispatcherHost is a delegate for Speech API messages used by
+// SpeechRecognitionDispatcherHost is a delegate for Speech API messages used by
 // RenderMessageFilter. Basically it acts as a proxy, relaying the events coming
 // from the SpeechRecognitionManager to IPC messages (and vice versa).
 // It's the complement of SpeechRecognitionDispatcher (owned by RenderView).
-class CONTENT_EXPORT InputTagSpeechDispatcherHost
+class CONTENT_EXPORT SpeechRecognitionDispatcherHost
     : public content::BrowserMessageFilter,
       public content::SpeechRecognitionEventListener {
  public:
-  InputTagSpeechDispatcherHost(
+  SpeechRecognitionDispatcherHost(
       int render_process_id,
-      net::URLRequestContextGetter* url_request_context_getter,
+      net::URLRequestContextGetter* context_getter,
       content::SpeechRecognitionPreferences* recognition_preferences);
 
   // SpeechRecognitionEventListener methods.
   virtual void OnRecognitionStart(int session_id) OVERRIDE;
   virtual void OnAudioStart(int session_id) OVERRIDE;
   virtual void OnEnvironmentEstimationComplete(int session_id) OVERRIDE;
   virtual void OnSoundStart(int session_id) OVERRIDE;
   virtual void OnSoundEnd(int session_id) OVERRIDE;
   virtual void OnAudioEnd(int session_id) OVERRIDE;
   virtual void OnRecognitionEnd(int session_id) OVERRIDE;
   virtual void OnRecognitionResult(
       int session_id, const content::SpeechRecognitionResult& result) OVERRIDE;
   virtual void OnRecognitionError(
       int session_id, const content::SpeechRecognitionError& error) OVERRIDE;
   virtual void OnAudioLevelsChange(
       int session_id, float volume, float noise_volume) OVERRIDE;
 
   // content::BrowserMessageFilter implementation.
   virtual bool OnMessageReceived(const IPC::Message& message,
                                  bool* message_was_ok) OVERRIDE;
 
   // Singleton manager setter useful for tests.
   static void SetManagerForTests(content::SpeechRecognitionManager* manager);
 
  private:
-  virtual ~InputTagSpeechDispatcherHost();
+  virtual ~SpeechRecognitionDispatcherHost();
 
-  void OnStartRecognition(
-      const InputTagSpeechHostMsg_StartRecognition_Params &params);
-  void OnCancelRecognition(int render_view_id, int request_id);
-  void OnStopRecording(int render_view_id, int request_id);
+  void OnStartRequest(
+      const SpeechRecognitionHostMsg_StartRequest_Params& params);
+  void OnAbortRequest(int render_view_id, int js_handle_id);

[Satish, 2012/05/20 22:57:46]

I'd suggest replacing 'js_handle_id' with something opaque and not mentioning JS
(which is why we chose 'request_id' in the earlier code). Also, typically both
'handle' and 'id' are used interchangeably for an opaque value passed through an
API so it is somewhat funny to see both in the same name :)

+  void OnStopCaptureRequest(int render_view_id, int js_handle_id);
 
-  // Returns the speech recognition manager to forward events to, creating one
-  // if needed.
+  // Returns the speech recognition manager to forward requests to.
   content::SpeechRecognitionManager* manager();
 
   int render_process_id_;
-  bool may_have_pending_requests_;  // Set if we received any speech IPC request
-
-  scoped_refptr<net::URLRequestContextGetter> url_request_context_getter_;
+  scoped_refptr<net::URLRequestContextGetter> context_getter_;
   scoped_refptr<content::SpeechRecognitionPreferences> recognition_preferences_;
 
   static content::SpeechRecognitionManager* manager_for_tests_;
 
-  DISALLOW_COPY_AND_ASSIGN(InputTagSpeechDispatcherHost);
+  DISALLOW_COPY_AND_ASSIGN(SpeechRecognitionDispatcherHost);
 };
 
 }  // namespace speech
 
-#endif  // CONTENT_BROWSER_SPEECH_INPUT_TAG_SPEECH_DISPATCHER_HOST_H_
+#endif  // CONTENT_BROWSER_SPEECH_SPEECH_RECOGNITION_DISPATCHER_HOST_H_