adjusted indentation with astyle; added Id keyword

[wxWidgets.git] / interface / protocol / http.h

/////////////////////////////////////////////////////////////////////////////
// Name:        protocol/http.h
// Purpose:     documentation for wxHTTP class
// Author:      wxWidgets team
// RCS-ID:      $Id$
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

/**
    @class wxHTTP
    @headerfile http.h wx/protocol/http.h


    @library{wxnet}
    @category{net}

    @seealso
    wxSocketBase, wxURL
*/
class wxHTTP : public wxProtocol
{
public:
    /**
        Returns the data attached with a field whose name is specified by @e header.
        If the field doesn't exist, it will return an empty string and not a @NULL
        string.
    */
    wxString GetHeader(const wxString& header);

    /**
        Creates a new input stream on the specified path. Notice that this stream is
        unseekable, i.e. SeekI() and TellI() methods shouldn't be used.
        
        Note that you can still know the size of the file you are getting using
        wxStreamBase::GetSize. However there is a
        limitation: in HTTP protocol, the size is not always specified so sometimes
        @c (size_t)-1 can returned ot indicate that the size is unknown. In such
        case, you may want to use wxInputStream::LastRead
        method in a loop to get the total size.
        
        @returns Returns the initialized stream. You must delete it yourself once
                   you don't use it anymore and this must be done before
                   the wxHTTP object itself is destroyed. The destructor
                   closes the network connection. The next time you will
                   try to get a file the network connection will have to
                   be reestablished, but you don't have to take care of
                   this since wxHTTP reestablishes it automatically.
        
        @sa wxInputStream
    */
    wxInputStream * GetInputStream(const wxString& path);

    /**
        Returns the HTTP response code returned by the server. Please refer to
        RFC 2616 for the list of responses.
    */
    int GetResponse();

    /**
        It sets data of a field to be sent during the next request to the HTTP server.
        The field
        name is specified by @e header and the content by @e h_data.
        This is a low level function and it assumes that you know what you are doing.
    */
    void SetHeader(const wxString& header, const wxString& h_data);
};