projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 0d6957a5 GL |
1 | \section{\class{wxHTTP}}\label{wxhttp} |
| 2 | ||
| 3 | \wxheading{Derived from} | |
| 4 | ||
| 5 | \helpref{wxProtocol}{wxprotocol} | |
| 6 | ||
| 7 | \wxheading{Include files} | |
| 8 | ||
| 9 | <wx/protocol/http.h> | |
| 10 | ||
| 11 | \wxheading{See also} | |
| 12 | ||
| 13 | \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxURL}{wxurl} | |
| 14 | ||
| 15 | % ---------------------------------------------------------------------------- | |
| 16 | % Members | |
| 17 | % ---------------------------------------------------------------------------- | |
| 18 | ||
| 19 | % ---------------------------------------------------------------------------- | |
| 2e622163 VZ |
20 | \membersection{wxHTTP::GetResponse}\label{wxhttpgetresponse} |
| 21 | ||
| 22 | \constfunc{int}{GetResponse}{\void} | |
| 23 | ||
| 24 | Returns the HTTP response code returned by the server. Please refer to the RFC | |
| 25 | 2616 for the list of the responses. | |
| 26 | ||
| 27 | ||
| 721b32e0 | 28 | \membersection{wxHTTP::GetInputStream}\label{wxhttpgetinputstream} |
| 0d6957a5 GL |
29 | |
| 30 | \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}} | |
| 31 | ||
| 721b32e0 JS |
32 | Creates a new input stream on the the specified path. You can use all except the seek |
| 33 | functionality of wxStream. Seek isn't available on all streams. For example, | |
| 39b91eca GL |
34 | http or ftp streams doesn't deal with it. Other functions like Tell and SeekI |
| 35 | for this sort of stream. | |
| 0d6957a5 GL |
36 | You will be notified when the EOF is reached by an error. |
| 37 | ||
| 39b91eca GL |
38 | \wxheading{Note} |
| 39 | ||
| 40 | You can know the size of the file you are getting using \helpref{wxStreamBase::GetSize()}{wxstreambasegetsize}. | |
| 2edb0bde | 41 | But there is a limitation: as HTTP servers aren't obliged to pass the size of |
| 39b91eca GL |
42 | the file, in some case, you will be returned 0xfffffff by GetSize(). In these |
| 43 | cases, you should use the value returned by \helpref{wxInputStream::LastRead()}{wxinputstreamlastread}: | |
| 44 | this value will be 0 when the stream is finished. | |
| 45 | ||
| 0d6957a5 GL |
46 | \wxheading{Return value} |
| 47 | ||
| 48 | Returns the initialized stream. You will have to delete it yourself once you | |
| 49 | don't use it anymore. The destructor closes the network connection. | |
| 50 | The next time you will try to get a file the network connection will have | |
| 51 | to be reestablished: but you don't have to take care of this wxHTTP reestablishes it automatically. | |
| 52 | ||
| 53 | \wxheading{See also} | |
| 54 | ||
| 55 | \helpref{wxInputStream}{wxinputstream} | |
| 56 | ||
| 57 | % ---------------------------------------------------------------------------- | |
| 58 | ||
| f0e8a2d0 | 59 | \membersection{wxHTTP::SetHeader}\label{wxhttpsetheader} |
| 0d6957a5 | 60 | |
| 294e9a7a | 61 | \func{void}{SetHeader}{\param{const wxString\&}{ header}, \param{const wxString\&}{ h\_data}} |
| 0d6957a5 GL |
62 | |
| 63 | It sets data of a field to be sent during the next request to the HTTP server. The field | |
| 605d715d | 64 | name is specified by {\it header} and the content by {\it h\_data}. |
| 0d6957a5 GL |
65 | This is a low level function and it assumes that you know what you are doing. |
| 66 | ||
| f0e8a2d0 | 67 | \membersection{wxHTTP::GetHeader}\label{wxhttpgetheader} |
| 721b32e0 | 68 | |
| 0d6957a5 GL |
69 | \func{wxString}{GetHeader}{\param{const wxString\&}{ header}} |
| 70 | ||
| 605d715d | 71 | Returns the data attached with a field whose name is specified by {\it header}. |
| 0d6957a5 | 72 | If the field doesn't exist, it will return an empty string and not a NULL string. |
| 721b32e0 | 73 | |
| 39b91eca GL |
74 | \wxheading{Note} |
| 75 | ||
| 76 | The header is not case-sensitive: I mean that "CONTENT-TYPE" and "content-type" | |
| 77 | represent the same header. | |
| 22d6efa8 | 78 |