HttpGetMessage.hxx

Go to the documentation of this file.

#ifndef RESIP_HttpGetMessage_hxx
#define RESIP_HttpGetMessage_hxx 
 
#include <map>
#include "resip/dum/DumFeatureMessage.hxx"
#include "resip/stack/Mime.hxx"
#include "rutil/Data.hxx"
 
namespace resip
{
 
class HttpGetMessage : public DumFeatureMessage
{
   public:
      // Map of HTTP response header name -> value.
      // Header names are stored lower-cased so lookups are case-insensitive.
      // If a header appears multiple times in the response, values are comma-joined
      // (RFC 9110 section 5.3).  Note: this loses separation for Set-Cookie, but we don't
      // currently need cookies; callers that do should access the raw response elsewhere.
      typedef std::map<Data, Data> HeaderMap;
 
      // Synthetic (non-IETF) status codes used to convey internal outcomes that do not
      // correspond to an HTTP response.  The IETF does not assign status codes >= 600, so we
      // use the 900 range for our own purposes; add new values counting up from here.
      //   900  StatusBlockedByPolicy: the request was not performed because local policy
      //        (e.g. the x5u address ACL) forbade the destination.
      static const unsigned int StatusBlockedByPolicy = 900;
 
      HttpGetMessage(const Data& tid, bool success, const Data& body, const Mime& type);
      HttpGetMessage(const Data& tid, const Data& userData, unsigned int statusCode, HeaderMap headers, const Data& body, const Mime& type);
 
      bool success() const { return mSuccess; }
      const Data& getBodyData() const { return mBody; }
      const Mime& getType() const {return mType;}
 
      const Data& getUserData() const { return mUserData; }
      unsigned int getStatusCode() const { return mStatusCode; }
 
      // Case-insensitive header lookup.  Returns Data::Empty if the header is not present.
      const Data& getHeader(const Data& name) const;
      const HeaderMap& getHeaders() const { return mHeaders; }
 
      virtual Message* clone() const;
      virtual EncodeStream& encode(EncodeStream& strm) const;
      virtual EncodeStream& encodeBrief(EncodeStream& strm) const;
 
   private:
      bool mSuccess;
      Data mBody;
      Mime mType;
 
      Data mUserData;
      unsigned int mStatusCode;
      HeaderMap mHeaders;
};
 
}
 
#endif
/* ====================================================================
 * The Vovida Software License, Version 1.0 
 * 
 * Copyright (c) 2026, SIP Spectrum, Inc. https://www.sipspectrum.com
 * Copyright (c) 2000 Vovida Networks, Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 
 * 3. The names "VOCAL", "Vovida Open Communication Application Library",
 *    and "Vovida Open Communication Application Library (VOCAL)" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact vocal@vovida.org.
 *
 * 4. Products derived from this software may not be called "VOCAL", nor
 *    may "VOCAL" appear in their name, without prior written
 *    permission of Vovida Networks, Inc.
 * 
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
 * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA
 * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
 * IN EXCESS OF $1,000, NOR FOR ANY INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 * 
 * ====================================================================
 * 
 * This software consists of voluntary contributions made by Vovida
 * Networks, Inc. and many individuals on behalf of Vovida Networks,
 * Inc.  For more information on Vovida Networks, Inc., please see
 * <http://www.vovida.org/>.
 *
 */