src/third_party/WebKit/Source/platform/network/ProxyServer.h

   1 /*
   2  * Copyright (C) 2010 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef ProxyServer_h
  27 #define ProxyServer_h
  28
  29 #include "platform/PlatformExport.h"
  30 #include "wtf/Vector.h"
  31 #include "wtf/text/WTFString.h"
  32
  33 namespace blink {
  34
  35 class KURL;
  36 class NetworkingContext;
  37
  38 // Represents a single proxy server.
  39 class PLATFORM_EXPORT ProxyServer {
  40 public:
  41     enum Type {
  42         Direct,
  43         HTTP,
  44         HTTPS,
  45         SOCKS,
  46     };
  47
  48     ProxyServer()
  49         : m_type(Direct)
  50         , m_port(-1)
  51     {
  52     }
  53
  54     ProxyServer(Type type, const String& hostName, int port)
  55         : m_type(type)
  56         , m_hostName(hostName)
  57         , m_port(port)
  58     {
  59     }
  60
  61     Type type() const { return m_type; }
  62     const String& hostName() const { return m_hostName; }
  63     int port() const { return m_port; }
  64
  65 private:
  66     Type m_type;
  67     String m_hostName;
  68     int m_port;
  69 };
  70
  71 // Return a vector of proxy servers for the given URL.
  72 PLATFORM_EXPORT Vector<ProxyServer> proxyServersForURL(const KURL&, const NetworkingContext*);
  73
  74 // Converts the given vector of proxy servers to a PAC string, as described in
  75 // http://web.archive.org/web/20060424005037/wp.netscape.com/eng/mozilla/2.0/relnotes/demo/proxy-live.html
  76 PLATFORM_EXPORT String toString(const Vector<ProxyServer>&);
  77
  78 } // namespace blink
  79
  80 #endif // ProxyServer_h