Sessions API - previously Session Restore API. Supports restoring currently open foreign windows an…

chrome/browser/extensions/api/sessions/foreign_session_id.h

-// Copyright (c) 2012 The Chromium Authors. All rights reserved.
+// Copyright (c) 2013 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 NET_SERVER_HTTP_CONNECTION_H_
-#define NET_SERVER_HTTP_CONNECTION_H_
+#ifndef CHROME_BROWSER_EXTENSIONS_API_SESSIONS_FOREIGN_SESSION_ID_H__
+#define CHROME_BROWSER_EXTENSIONS_API_SESSIONS_FOREIGN_SESSION_ID_H__
 
 #include <string>
 
 #include "base/basictypes.h"
-#include "base/memory/ref_counted.h"
-#include "base/memory/scoped_ptr.h"
-#include "net/http/http_status_code.h"
 
-namespace net {
+namespace extensions {
 
-class HttpServer;
-class HttpServerResponseInfo;
-class StreamListenSocket;
-class WebSocket;
+class ForeignSessionId {
+ public:
+  // Constructs a ForeignSessionId object for the given session information.
+  ForeignSessionId(const std::string& session_tag, int id);

[not at google - send to devlin, 2013/08/12 23:51:34]

maybe you need to explain the difference between the tag and the ID.

[Kristen Dwan, 2013/08/15 07:11:56]

Done.

 
-class HttpConnection {
- public:
-  ~HttpConnection();
+  // Constructs a ForeignSessionId, given a string formatted by ToString().
+  explicit ForeignSessionId(const std::string& foreign_session_string);

[not at google - send to devlin, 2013/08/12 23:51:34]

generally nicer to have a static method like Parse or FromString which returns a
ForeignSessionId. Avoid doing initialization work from with a constructor.

[Kristen Dwan, 2013/08/15 07:11:56]

Done.

 
-  void Send(const std::string& data);
-  void Send(const char* bytes, int len);
-  void Send(const HttpServerResponseInfo& response);
+  // Returns true if the provided |id| is in the format of a ForeignSessionId.
+  static bool IsForeignSessionId(const std::string& id);
 
-  void Shift(int num_bytes);
+  // Returns the compressed std::string representation of a ForeignSessionId.
+  std::string ToString();
 
-  const std::string& recv_data() const { return recv_data_; }
+  std::string session_tag() const { return session_tag_; }

[not at google - send to devlin, 2013/08/12 23:51:34]

return a const std::string& here

[Kristen Dwan, 2013/08/15 07:11:56]

Done.

   int id() const { return id_; }
 
  private:
-  friend class HttpServer;
-  static int last_id_;
+  // Associated session tag for this foreign entry.
+  std::string session_tag_;
 
-  HttpConnection(HttpServer* server, StreamListenSocket* sock);
+  // ID corresponding to this foreign entry.
+  int id_;
 
-  void DetachSocket();
-
-  HttpServer* server_;
-  scoped_refptr<StreamListenSocket> socket_;
-  scoped_ptr<WebSocket> web_socket_;
-  std::string recv_data_;
-  int id_;
-  DISALLOW_COPY_AND_ASSIGN(HttpConnection);
+  DISALLOW_COPY_AND_ASSIGN(ForeignSessionId);
 };
 
-}  // namespace net
+}  // namespace extensions
 
-#endif  // NET_SERVER_HTTP_CONNECTION_H_
+#endif  // CHROME_BROWSER_EXTENSIONS_API_SESSIONS_FOREIGN_SESSION_ID_H__