1 | // |
---|
2 | // HTTPStreamFactory.h |
---|
3 | // |
---|
4 | // $Id: //poco/1.3/Net/include/Poco/Net/HTTPStreamFactory.h#2 $ |
---|
5 | // |
---|
6 | // Library: Net |
---|
7 | // Package: HTTP |
---|
8 | // Module: HTTPStreamFactory |
---|
9 | // |
---|
10 | // Definition of the HTTPStreamFactory class. |
---|
11 | // |
---|
12 | // Copyright (c) 2005-2006, Applied Informatics Software Engineering GmbH. |
---|
13 | // and Contributors. |
---|
14 | // |
---|
15 | // Permission is hereby granted, free of charge, to any person or organization |
---|
16 | // obtaining a copy of the software and accompanying documentation covered by |
---|
17 | // this license (the "Software") to use, reproduce, display, distribute, |
---|
18 | // execute, and transmit the Software, and to prepare derivative works of the |
---|
19 | // Software, and to permit third-parties to whom the Software is furnished to |
---|
20 | // do so, all subject to the following: |
---|
21 | // |
---|
22 | // The copyright notices in the Software and this entire statement, including |
---|
23 | // the above license grant, this restriction and the following disclaimer, |
---|
24 | // must be included in all copies of the Software, in whole or in part, and |
---|
25 | // all derivative works of the Software, unless such copies or derivative |
---|
26 | // works are solely in the form of machine-executable object code generated by |
---|
27 | // a source language processor. |
---|
28 | // |
---|
29 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
30 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
31 | // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT |
---|
32 | // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE |
---|
33 | // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, |
---|
34 | // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
---|
35 | // DEALINGS IN THE SOFTWARE. |
---|
36 | // |
---|
37 | |
---|
38 | |
---|
39 | #ifndef Net_HTTPStreamFactory_INCLUDED |
---|
40 | #define Net_HTTPStreamFactory_INCLUDED |
---|
41 | |
---|
42 | |
---|
43 | #include "Poco/Net/Net.h" |
---|
44 | #include "Poco/Net/HTTPSession.h" |
---|
45 | #include "Poco/URIStreamFactory.h" |
---|
46 | |
---|
47 | |
---|
48 | namespace Poco { |
---|
49 | namespace Net { |
---|
50 | |
---|
51 | |
---|
52 | class Net_API HTTPStreamFactory: public Poco::URIStreamFactory |
---|
53 | /// An implementation of the URIStreamFactory interface |
---|
54 | /// that handles Hyper-Text Transfer Protocol (http) URIs. |
---|
55 | { |
---|
56 | public: |
---|
57 | HTTPStreamFactory(); |
---|
58 | /// Creates the HTTPStreamFactory. |
---|
59 | |
---|
60 | HTTPStreamFactory(const std::string& proxyHost, Poco::UInt16 proxyPort = HTTPSession::HTTP_PORT); |
---|
61 | /// Creates the HTTPStreamFactory. |
---|
62 | /// |
---|
63 | /// HTTP connections will use the given proxy. |
---|
64 | |
---|
65 | virtual ~HTTPStreamFactory(); |
---|
66 | /// Destroys the HTTPStreamFactory. |
---|
67 | |
---|
68 | virtual std::istream* open(const Poco::URI& uri); |
---|
69 | /// Creates and opens a HTTP stream for the given URI. |
---|
70 | /// The URI must be a http://... URI. |
---|
71 | /// |
---|
72 | /// Throws a NetException if anything goes wrong. |
---|
73 | /// |
---|
74 | /// Redirect responses are handled and the redirect |
---|
75 | /// location is automatically resolved, as long |
---|
76 | /// as the redirect location is still accessible |
---|
77 | /// via the HTTP protocol. If a redirection to |
---|
78 | /// a non http://... URI is received, a |
---|
79 | /// UnsupportedRedirectException exception is thrown. |
---|
80 | /// The offending URI can then be obtained via the message() |
---|
81 | /// method of UnsupportedRedirectException. |
---|
82 | |
---|
83 | static void registerFactory(); |
---|
84 | /// Registers the HTTPStreamFactory with the |
---|
85 | /// default URIStreamOpener instance. |
---|
86 | |
---|
87 | static void unregisterFactory(); |
---|
88 | /// Unregisters the HTTPStreamFactory with the |
---|
89 | /// default URIStreamOpener instance. |
---|
90 | |
---|
91 | private: |
---|
92 | enum |
---|
93 | { |
---|
94 | MAX_REDIRECTS = 10 |
---|
95 | }; |
---|
96 | |
---|
97 | std::string _proxyHost; |
---|
98 | Poco::UInt16 _proxyPort; |
---|
99 | }; |
---|
100 | |
---|
101 | |
---|
102 | } } // namespace Poco::Net |
---|
103 | |
---|
104 | |
---|
105 | #endif // Net_HTTPStreamFactory_INCLUDED |
---|