HttpProvider.hxx

Go to the documentation of this file.

#ifndef RESIP_HttpProvider
#define RESIP_HttpProvider
 
#include "rutil/Mutex.hxx"
#include "resip/dum/TargetCommand.hxx"
#include "resip/stack/Tuple.hxx"
#include <memory>
#include <vector>
 
namespace resip
{
class TransactionUser;
class Data;
class GenericUri;
class TargetCommand;
 
//To provide this functionality, plug in an instance of
//HttpProviderFactory(before any instances of DialogUsageManager/SipStack are
//created. Null will be returned by default.
class HttpProviderFactory;
 
struct HttpRequestOptions
{
   // Per-endpoint-attempt connection establishment timeout (TCP connect + TLS handshake).
   // On expiry the next resolved endpoint is tried.  Must be > 0.
   unsigned int mConnectTimeoutSeconds = 5;
   // Overall wall-clock budget for the entire request: DNS resolution, all endpoint
   // connection attempts, TLS handshake and response.  0 = no overall timeout.
   unsigned int mRequestTimeoutSeconds = 0;
 
   // Optional address access control list applied by the HTTP client to each IP address the
   // target host resolves to (after DNS resolution).  Deny wins; if mAllowedAddresses is
   // non-empty a resolved address must match one of its entries.  When all resolved addresses
   // are filtered out, the request fails as if blocked by policy (see HttpGetMessage's
   // blockedByPolicy flag).  Both lists empty (the default) means no address filtering.
   std::vector<AddressMask> mAllowedAddresses;
   std::vector<AddressMask> mDeniedAddresses;
};
 
class HttpProvider
{
   public:
      //HttpProvider assumes memory
      static void setFactory(std::unique_ptr<HttpProviderFactory> fact) noexcept;
      //ptr so users can check for existence
      static HttpProvider* instance();
      
      //.dcm. tu param will become a postable
      virtual void get(const GenericUri& target, const Data& tid, TransactionUser& tu, TargetCommand::Target& commandTarget)=0;
      virtual void get(const GenericUri& target, const Data& tid, const Data& userData, const HttpRequestOptions& options, TransactionUser& tu, TargetCommand::Target& commandTarget) {}  // Not =0 for back compat
      virtual ~HttpProvider(){} //impl. singleton destructor pattern later
   private:
      static HttpProvider* mInstance;
      static std::unique_ptr<HttpProviderFactory> mFactory;
      static Mutex mMutex;      
};
 
class HttpProviderFactory
{
   public:
      virtual HttpProvider* createHttpProvider()=0;
      virtual ~HttpProviderFactory(){}
};
}
 
#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/>.
 *
 */