Add basic versioning check to Chromoting's plugin/JS code.

remoting/client/plugin/chromoting_scriptable_object.h

 // 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.
 
 // This implements the JavaScript class entrypoint for the plugin instance.
 // The Javascript API is defined as follows.
 //
 // interface ChromotingScriptableObject {
 //
-//   // Dimension of the desktop area.
-//   readonly attribute int desktopWidth;
-//   readonly attribute int desktopHeight;
+//   // Chromoting session API version (for this plugin).
+//   // This is compared with the javascript API version to verify that they are
+//   // compatible.
+//   readonly attribute unsigned short apiVersion;
+//
+//   // The oldest API version that we support.
+//   // This will differ from |apiVersion| if we decide to maintain backward
+//   // compatibility with older API versions.
+//   readonly attribute unsigned short apiMinVersion;
 //
 //   // Connection status.
 //   readonly attribute unsigned short status;
 //
-//   // Statistics.
-//   // Video Bandwidth in bytes per second.
-//   readonly attribute float videoBandwidth;
-//   // Latency for capturing in milliseconds.
-//   readonly attribute int videoCaptureLatency;
-//   // Latency for video encoding in milliseconds.
-//   readonly attribute int videoEncodeLatency;
-//   // Latency for video decoding in milliseconds.
-//   readonly attribute int videoDecodeLatency;
-//   // Latency for rendering in milliseconds.
-//   readonly attribute int videoRenderLatency;
-//   // Latency between an event is sent and a corresponding video packet is
-//   // received.
-//   readonly attribute int roundTripLatency;
-//
 //   // Constants for connection status.
 //   const unsigned short STATUS_UNKNOWN = 0;
 //   const unsigned short STATUS_CONNECTING = 1;
 //   const unsigned short STATUS_INITIALIZING = 2;
 //   const unsigned short STATUS_CONNECTED = 3;
 //   const unsigned short STATUS_CLOSED = 4;
 //   const unsigned short STATUS_FAILED = 5;
 //
 //   // Connection quality.
 //   readonly attribute unsigned short quality;
+//
 //   // Constants for connection quality
 //   const unsigned short QUALITY_UNKNOWN = 0;
 //   const unsigned short QUALITY_GOOD = 1;
 //   const unsigned short QUALITY_BAD = 2;
 //
 //   // JS callback function so we can signal the JS UI when the connection
 //   // status has been updated.
 //   attribute Function connectionInfoUpdate;
 //
 //   // JS callback function to call when there is new debug info to display
 //   // in the client UI.
 //   attribute Function debugInfo;
 //
-//   // JS callback function to send an XMPP IQ stanza for performing the
-//   // signaling in a jingle connection.  The callback function should be
-//   // of type void(string request_xml).
-//   attribute Function sendIq;
-//
-//   // Method for receiving an XMPP IQ stanza in response to a previous
-//   // sendIq() invocation. Other packets will be silently dropped.
-//   void onIq(string response_xml);
+//   attribute Function desktopSizeUpdate;
 //
 //   // This function is called when login information for the host machine is
 //   // needed.
 //   //
 //   // User of this object should respond with calling submitLoginInfo() when
 //   // username and password is available.
 //   //
 //   // This function will be called multiple times until login was successful
 //   // or the maximum number of login attempts has been reached. In the
 //   // later case |connection_status| is changed to STATUS_FAILED.
 //   attribute Function loginChallenge;
 //
+//   // JS callback function to send an XMPP IQ stanza for performing the
+//   // signaling in a jingle connection.  The callback function should be
+//   // of type void(string request_xml).
+//   attribute Function sendIq;
+//
+//   // Dimension of the desktop area.
+//   readonly attribute int desktopWidth;
+//   readonly attribute int desktopHeight;
+//
+//   // Statistics.
+//   // Video Bandwidth in bytes per second.
+//   readonly attribute float videoBandwidth;
+//   // Latency for capturing in milliseconds.
+//   readonly attribute int videoCaptureLatency;
+//   // Latency for video encoding in milliseconds.
+//   readonly attribute int videoEncodeLatency;
+//   // Latency for video decoding in milliseconds.
+//   readonly attribute int videoDecodeLatency;
+//   // Latency for rendering in milliseconds.
+//   readonly attribute int videoRenderLatency;
+//   // Latency between an event is sent and a corresponding video packet is
+//   // received.
+//   readonly attribute int roundTripLatency;
+//
 //   // Methods for establishing a Chromoting connection.
 //   //
 //   // Either use connect() or connectSandboxed(), not both. If using
 //   // connectSandboxed(), sendIq must be set, and responses to calls on
 //   // sendIq must be piped back into onIq().
 //   void connect(string username, string host_jid, string auth_token,
 //                string nonce);
 //   void connectSandboxed(string your_jid, string host_jid, string nonce);
 //   void disconnect();
 //
 //   // Method for submitting login information.
 //   void submitLoginInfo(string username, string password);
 //
 //   // Method for setting scale-to-fit.
 //   void setScaleToFit(bool scale_to_fit);
+//
+//   // Method for receiving an XMPP IQ stanza in response to a previous
+//   // sendIq() invocation. Other packets will be silently dropped.
+//   void onIq(string response_xml);
 // }
 
 #ifndef REMOTING_CLIENT_PLUGIN_CHROMOTING_SCRIPTABLE_OBJECT_H_
 #define REMOTING_CLIENT_PLUGIN_CHROMOTING_SCRIPTABLE_OBJECT_H_
 
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/memory/weak_ptr.h"
@@ skipping 44 matching lines @@
                        pp::Var* exception);
 
   void SetConnectionInfo(ConnectionStatus status, ConnectionQuality quality);
   void LogDebugInfo(const std::string& info);
   void SetDesktopSize(int width, int height);
 
   // This should be called to signal JS code to provide login information.
   void SignalLoginChallenge();
 
   // Attaches the XmppProxy used for issuing and receivng IQ stanzas for
-  // initiaing a jingle connection from within the sandbox.
+  // initializing a jingle connection from within the sandbox.
   void AttachXmppProxy(PepperXmppProxy* xmpp_proxy);
 
   // Sends an IQ stanza, serialized as an xml string, into Javascript for
   // handling.
   void SendIq(const std::string& request_xml);
 
  private:
   typedef std::map<std::string, int> PropertyNameMap;
   typedef pp::Var (ChromotingScriptableObject::*MethodHandler)(
       const std::vector<pp::Var>& args, pp::Var* exception);
@@ skipping 45 matching lines @@
   PropertyNameMap property_names_;
   std::vector<PropertyDescriptor> properties_;
   scoped_refptr<PepperXmppProxy> xmpp_proxy_;
 
   ChromotingInstance* instance_;
 };
 
 }  // namespace remoting
 
 #endif  // REMOTING_CLIENT_PLUGIN_CHROMOTING_SCRIPTABLE_OBJECT_H_