UserAgentMasterProfile.hxx

Go to the documentation of this file.

#if !defined(UserAgentMasterProfile_hxx)
#define UserAgentMasterProfile_hxx
 
#include <rutil/TransportType.hxx>
#include <rutil/dns/DnsStub.hxx>
#include <resip/stack/SecurityTypes.hxx> 
#include <resip/stack/Transport.hxx>
#include <resip/dum/MasterProfile.hxx>
#include <reflow/RTCPEventLoggingHandler.hxx>
 
#include <memory>
#include <vector>
 
namespace recon
{
 
class UserAgentMasterProfile : public resip::MasterProfile
{
public:  
   UserAgentMasterProfile();  
 
   class TransportInfo
   {
   public:
      resip::TransportType mProtocol;
      int mPort;
      int mActualPort; // Only set after UserAgent is created and transports are added.  Useful if mPort is specified as ephemeral (0).
      resip::IpVersion mIPVersion;
      resip::StunSetting mStunEnabled;
      resip::Data mIPInterface;
      resip::Data mSipDomainname;
      resip::Data mTlsPrivateKeyPassPhrase;
      resip::SecurityTypes::SSLType mSslType;
      unsigned mTransportFlags;
      resip::Data mTlsCertificate;
      resip::Data mTlsPrivateKey;
      resip::SecurityTypes::TlsClientVerificationMode mCvm;
      bool mUseEmailAsSIP;
      unsigned int mRcvBufLen;
   };
 
   void setTransportSipMessageLoggingHandler(std::shared_ptr<resip::Transport::SipMessageLoggingHandler> handler) noexcept;
 
   std::shared_ptr<resip::Transport::SipMessageLoggingHandler> getTransportSipMessageLoggingHandler() const noexcept;
 
   void setRTCPEventLoggingHandler(std::shared_ptr<flowmanager::RTCPEventLoggingHandler> handler) noexcept;
 
   std::shared_ptr<flowmanager::RTCPEventLoggingHandler> getRTCPEventLoggingHandler() const noexcept;
 
   virtual bool& dtmfDigitLoggingEnabled();
   virtual const bool dtmfDigitLoggingEnabled() const;
 
   void addTransport( resip::TransportType protocol,
                      int port, 
                      resip::IpVersion version=resip::V4,
                      resip::StunSetting stun=resip::StunDisabled,
                      const resip::Data& ipInterface = resip::Data::Empty, 
                      const resip::Data& sipDomainname = resip::Data::Empty, // TLS only
                      const resip::Data& privateKeyPassPhrase = resip::Data::Empty,
                      resip::SecurityTypes::SSLType sslType = resip::SecurityTypes::DynamicTLS,
                      unsigned transportFlags = 0,
                      const resip::Data& certificateFilename = resip::Data::Empty,
                      const resip::Data& privateKeyFilename = resip::Data::Empty,
                      resip::SecurityTypes::TlsClientVerificationMode cvm = resip::SecurityTypes::None,
                      bool useEmailAsSIP = false,
                      unsigned int rcvBufLen = 0);
 
   std::vector<TransportInfo>& getTransports();
 
   void addEnumSuffix(const resip::Data& enumSuffix);
 
   const std::vector<resip::Data>& getEnumSuffixes() const;
 
   void addAdditionalDnsServer(const resip::Data& dnsServerIPAddress);
 
   const resip::DnsStub::NameserverList& getAdditionalDnsServers() const;
 
   virtual resip::Data& certPath();
   virtual const resip::Data certPath() const; 
 
   virtual std::vector<resip::Data>& rootCertDirectories();
   virtual const std::vector<resip::Data>& rootCertDirectories() const;
 
   virtual std::vector<resip::Data>& rootCertBundles();
   virtual const std::vector<resip::Data>& rootCertBundles() const;
 
   virtual bool& statisticsManagerEnabled();
   virtual const bool statisticsManagerEnabled() const; 
 
 
   virtual bool& serverAuthManagerEnabled();
   virtual const bool serverAuthManagerEnabled() const;
 
   virtual unsigned short& rtpPortRangeMin();
   virtual const unsigned short rtpPortRangeMin() const;
 
   virtual unsigned short& rtpPortRangeMax();
   virtual const unsigned short rtpPortRangeMax() const;
 
   virtual int& subscriptionRetryInterval();
   virtual const int subscriptionRetryInterval() const;
 
private:            
   resip::Data mCertPath;
   std::vector<resip::Data> mRootCertDirectories;
   std::vector<resip::Data> mRootCertBundles;
   bool mStatisticsManagerEnabled;
   bool mServerAuthManagerEnabled;
   std::shared_ptr<resip::Transport::SipMessageLoggingHandler> mTransportSipMessageLoggingHandler;
   std::shared_ptr<flowmanager::RTCPEventLoggingHandler> mRTCPEventLoggingHandler;
   bool mDTMFDigitLoggingEnabled;
   std::vector<TransportInfo> mTransports;
   std::vector<resip::Data> mEnumSuffixes;
   resip::DnsStub::NameserverList mAdditionalDnsServers;
   unsigned short mRTPPortRangeMin;
   unsigned short mRTPPortRangeMax;
   int mSubscriptionRetryInterval;
};
 
}
 
#endif
 
 
/* ====================================================================
 
 Copyright (c) 2021-2026, SIP Spectrum, Inc. www.sipspectrum.com
 Copyright (c) 2007-2008, Plantronics, 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. Neither the name of Plantronics nor the names of its contributors 
    may be used to endorse or promote products derived from this 
    software without specific prior written permission. 
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 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.
 
 ==================================================================== */