12a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 22a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 32a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// found in the LICENSE file. 42a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 52a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#ifndef CHROME_TEST_CHROMEDRIVER_NET_SYNC_WEBSOCKET_H_ 62a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#define CHROME_TEST_CHROMEDRIVER_NET_SYNC_WEBSOCKET_H_ 72a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 82a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include <string> 92a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 10eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "base/time/time.h" 11868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) 122a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class GURL; 132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Proxy for using a WebSocket running on a background thread synchronously. 152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class SyncWebSocket { 162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) public: 17868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) enum StatusCode { 18868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) kOk = 0, 19868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) kTimeout, 20868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) kDisconnected 21868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) }; 22868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) 232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual ~SyncWebSocket() {} 242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Return true if connected, otherwise return false. 262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual bool IsConnected() = 0; 272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Connects to the WebSocket server. Returns true on success. 292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual bool Connect(const GURL& url) = 0; 302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Sends message. Returns true on success. 322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual bool Send(const std::string& message) = 0; 332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 34868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) // Receives next message and modifies the message on success. Returns 35868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) // StatusCode::kTimedout if no message is received within |timeout|. 36868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) // Returns StatusCode::kDisconnected if the socket is closed. 37868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) virtual StatusCode ReceiveNextMessage( 38868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) std::string* message, 39868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) const base::TimeDelta& timeout) = 0; 402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns whether there are any messages that have been received and not yet 422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // handled by ReceiveNextMessage. 432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual bool HasNextMessage() = 0; 442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)}; 452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#endif // CHROME_TEST_CHROMEDRIVER_NET_SYNC_WEBSOCKET_H_ 47