15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef NET_SOCKET_STREAM_SOCKET_STREAM_JOB_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define NET_SOCKET_STREAM_SOCKET_STREAM_JOB_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/ref_counted.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/base/net_export.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/socket_stream/socket_stream.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class GURL; 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace net { 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class SSLConfigService; 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class SSLInfo; 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class TransportSecurityState; 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// SocketStreamJob represents full-duplex communication over SocketStream. 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// If a protocol (e.g. WebSocket protocol) needs to inspect/modify data 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// over SocketStream, you can implement protocol specific job (e.g. 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// WebSocketJob) to do some work on data over SocketStream. 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Registers the protocol specific SocketStreamJob by RegisterProtocolFactory 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// and call CreateSocketStreamJob to create SocketStreamJob for the URL. 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NET_EXPORT SocketStreamJob 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) : public base::RefCountedThreadSafe<SocketStreamJob> { 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Callback function implemented by protocol handlers to create new jobs. 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef SocketStreamJob* (ProtocolFactory)(const GURL& url, 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SocketStream::Delegate* delegate); 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static ProtocolFactory* RegisterProtocolFactory(const std::string& scheme, 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ProtocolFactory* factory); 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static SocketStreamJob* CreateSocketStreamJob( 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const GURL& url, 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SocketStream::Delegate* delegate, 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TransportSecurityState* sts, 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SSLConfigService* ssl); 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SocketStreamJob(); 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void InitSocketStream(SocketStream* socket) { 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) socket_ = socket; 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual SocketStream::UserData* GetUserData(const void* key) const; 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void SetUserData(const void* key, SocketStream::UserData* data); 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 52868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) URLRequestContext* context() const { 53eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch return socket_.get() ? socket_->context() : 0; 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 55868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) void set_context(URLRequestContext* context) { 56eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch if (socket_.get()) 57eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch socket_->set_context(context); 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Connect(); 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool SendData(const char* data, int len); 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Close(); 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void RestartWithAuth(const AuthCredentials& credentials); 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void CancelWithError(int error); 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void CancelWithSSLError(const net::SSLInfo& ssl_info); 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void ContinueDespiteError(); 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void DetachDelegate(); 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 77eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch friend class WebSocketJobTest; 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class base::RefCountedThreadSafe<SocketStreamJob>; 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~SocketStreamJob(); 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_refptr<SocketStream> socket_; 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(SocketStreamJob); 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace net 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // NET_SOCKET_STREAM_SOCKET_STREAM_JOB_H_ 89