UserAgent.hxx

Go to the documentation of this file.

#if !defined(UserAgent_hxx)
#define UserAgent_hxx
 
#include "ConversationManager.hxx"
#include "ConversationProfile.hxx"
#include "UserAgentMasterProfile.hxx"
#include "HandleTypes.hxx"
 
#include <resip/stack/EventStackThread.hxx>
#include <resip/dum/MasterProfile.hxx>
#include <resip/dum/RegistrationHandler.hxx>
#include <resip/dum/SubscriptionHandler.hxx>
#include <resip/dum/DumShutdownHandler.hxx>
#include <resip/dum/DialogUsageManager.hxx>
#include <resip/dum/PublicationHandler.hxx>
#include <rutil/SelectInterruptor.hxx>
#include <rutil/Log.hxx>
#include <rutil/Mutex.hxx>
 
#include <memory>
 
namespace recon
{
 
class UserAgentShutdownCmd;
class SetActiveConversationProfileCmd;
class UserAgentClientSubscription;
class UserAgentClientPublication;
class UserAgentRegistration;
 
class UserAgent : public resip::ClientRegistrationHandler,
                  public resip::ClientSubscriptionHandler,
                  public resip::ClientPublicationHandler,
                  public resip::DumShutdownHandler,
                  public resip::Postable
{
public:
 
   UserAgent(ConversationManager* conversationManager, std::shared_ptr<UserAgentMasterProfile> masterProfile, resip::AfterSocketCreationFuncPtr socketFunc=0);
   virtual ~UserAgent();
 
   void startup(); 
 
   virtual void process(int timeoutMs); // call this in a loop
 
   void shutdown();
 
   void logDnsCache();
 
   void clearDnsCache();
 
   ConversationManager* getConversationManager();
 
   // Utility Methods ////////////////////////////////////////////////////////////
   typedef enum 
   {
      SubsystemAll,
      SubsystemContents,
      SubsystemDns,
      SubsystemDum,
      SubsystemSdp,
      SubsystemSip,
      SubsystemTransaction,
      SubsystemTransport,
      SubsystemStats,
      SubsystemRecon,
      SubsystemFlowManager,
      SubsystemReTurn
   } LoggingSubsystem;
 
   static void setLogLevel(resip::Log::Level level, LoggingSubsystem subsystem=SubsystemAll);
 
   ConversationProfileHandle addConversationProfile(std::shared_ptr<ConversationProfile> conversationProfile, bool defaultOutgoing=true); // thread safe
 
   void setDefaultOutgoingConversationProfile(ConversationProfileHandle handle); 
 
   void destroyConversationProfile(ConversationProfileHandle handle);
 
   virtual void startApplicationTimer(unsigned int timerId, std::chrono::duration<double> duration, unsigned int seqNumber);
 
   SubscriptionHandle createSubscription(const resip::Data& eventType, const resip::NameAddr& target, unsigned int subscriptionTime, const resip::Mime& mimeType); // thread safe
 
   void destroySubscription(SubscriptionHandle handle); 
 
   PublicationHandle createPublication(const resip::Data& eventType, const resip::NameAddr& target, const resip::Data& status, unsigned int publicationTime, const resip::Mime& mimeType);
   void destroyPublication(PublicationHandle handle);
 
   // UserAgent Handlers //////////////////////////////////////////////
 
   virtual void onApplicationTimer(unsigned int timerId, std::chrono::duration<double> duration, unsigned int seqNumber);
 
   virtual void onSubscriptionNotify(SubscriptionHandle handle, const resip::Data& notifyData); 
 
   virtual void onSubscriptionTerminated(SubscriptionHandle handle, unsigned int statusCode);   
 
   const char* sendMessage(const resip::NameAddr& destination, const resip::Data& msg, const resip::Mime& mimeType);
 
   std::shared_ptr<UserAgentMasterProfile> getUserAgentMasterProfile() const noexcept;
 
protected:
   resip::SipStack& getSipStack() { return mStack; };
   resip::DialogUsageManager& getDialogUsageManager();
 
   // Shutdown Handler ////////////////////////////////////////////////////////////
   void onDumCanBeDeleted();
 
   // Postable for Connection Terminated event
   virtual void post(resip::Message* msg);
 
   // Registration Handler ////////////////////////////////////////////////////////
   virtual void onSuccess(resip::ClientRegistrationHandle h, const resip::SipMessage& response);
   virtual void onFailure(resip::ClientRegistrationHandle h, const resip::SipMessage& response);
   virtual void onRemoved(resip::ClientRegistrationHandle h, const resip::SipMessage& response);
   virtual int onRequestRetry(resip::ClientRegistrationHandle h, int retryMinimum, const resip::SipMessage& msg);
 
   // ClientSubscriptionHandler ///////////////////////////////////////////////////
   virtual void onUpdatePending(resip::ClientSubscriptionHandle h, const resip::SipMessage& notify, bool outOfOrder);
   virtual void onUpdateActive(resip::ClientSubscriptionHandle h, const resip::SipMessage& notify, bool outOfOrder);
   virtual void onUpdateExtension(resip::ClientSubscriptionHandle, const resip::SipMessage& notify, bool outOfOrder);
   virtual void onTerminated(resip::ClientSubscriptionHandle h, const resip::SipMessage* notify);
   virtual void onNewSubscription(resip::ClientSubscriptionHandle h, const resip::SipMessage& notify);
   virtual int  onRequestRetry(resip::ClientSubscriptionHandle h, int retryMinimum, const resip::SipMessage& notify);
 
   // ClientPublicationHandler ///////////////////////////////////////////////////
   virtual void onSuccess(resip::ClientPublicationHandle h, const resip::SipMessage& status);
   virtual void onRemove(resip::ClientPublicationHandle h, const resip::SipMessage& status);
   virtual int onRequestRetry(resip::ClientPublicationHandle h, int retrySeconds, const resip::SipMessage& status);
   virtual void onFailure(resip::ClientPublicationHandle h, const resip::SipMessage& status);
 
   // UserProfile selection for incoming and outgoing calls, override to customize
   std::shared_ptr<ConversationProfile> getDefaultOutgoingConversationProfile();
   // Returns the ConversationProfile for a specific media address
   std::shared_ptr<ConversationProfile> getConversationProfileByMediaAddress(const resip::Data& mediaAddress);
   virtual std::shared_ptr<ConversationProfile> getIncomingConversationProfile(const resip::SipMessage& msg);  // returns the most appropriate conversation profile for the message
 
   friend class ConversationManager;
   friend class SipXMediaStackAdapter;
   friend class UserAgentShutdownCmd;
   friend class AddConversationProfileCmd;
   friend class SetDefaultOutgoingConversationProfileCmd;
   friend class DestroyConversationProfileCmd;
   friend class CreateSubscriptionCmd;
   friend class DestroySubscriptionCmd;
   friend class MediaResourceParticipant;
   friend class CreatePublicationCmd;
   friend class DestroyPublicationCmd;
 
   // Note:  In general the following fns are not thread safe and must be called from dum process 
   //        loop only
   friend class UserAgentServerAuthManager;
   friend class RemoteParticipant;
   friend class RemoteIMPagerParticipant;
   friend class SipXRemoteParticipant;
   friend class RemoteIMSessionParticipant;
   friend class DefaultDialogSet;
   friend class RemoteParticipantDialogSet;
   friend class SipXRemoteParticipantDialogSet;
   friend class RemoteIMSessionParticipantDialogSet;
 
   void addTransports();
   void post(resip::ApplicationMessage& message, std::chrono::duration<double> duration);
   void shutdownImpl(); 
   void addConversationProfileImpl(ConversationProfileHandle handle, std::shared_ptr<ConversationProfile> conversationProfile, bool defaultOutgoing=true);
   void setDefaultOutgoingConversationProfileImpl(ConversationProfileHandle handle);
   void destroyConversationProfileImpl(ConversationProfileHandle handle);
   void createSubscriptionImpl(SubscriptionHandle handle, const resip::Data& eventType, const resip::NameAddr& target, unsigned int subscriptionTime, const resip::Mime& mimeType);
   void destroySubscriptionImpl(SubscriptionHandle handle);
   void createPublicationImpl(PublicationHandle handle, const resip::Data& status, const resip::Data& eventType, const resip::NameAddr& target, unsigned int publicationTime, const resip::Mime& mimeType);
   void destroyPublicationImpl(PublicationHandle handle);
 
   // Subscription storage
   friend class UserAgentClientSubscription;
   typedef std::map<SubscriptionHandle, UserAgentClientSubscription *> SubscriptionMap;
   SubscriptionMap mSubscriptions;
   resip::Mutex mSubscriptionHandleMutex;
   SubscriptionHandle mCurrentSubscriptionHandle;
   SubscriptionHandle getNewSubscriptionHandle();  // thread safe
   void registerSubscription(UserAgentClientSubscription *);
   void unregisterSubscription(UserAgentClientSubscription *);
 
   // Publication storage
   friend class UserAgentClientPublication;
   typedef std::map<PublicationHandle, UserAgentClientPublication *> PublicationMap;
   PublicationMap mPublications;
   resip::Mutex mPublicationHandleMutex;
   PublicationHandle mCurrentPublicationHandle;
   PublicationHandle getNewPublicationHandle(); // thread safe
   void registerPublication(UserAgentClientPublication *);
   void unregisterPublication(UserAgentClientPublication *);
 
   // Conversation Profile Storage
   typedef std::map<ConversationProfileHandle, std::shared_ptr<ConversationProfile> > ConversationProfileMap;
   ConversationProfileMap mConversationProfiles;
   resip::Mutex mConversationProfileHandleMutex;
   ConversationProfileHandle mCurrentConversationProfileHandle;
   ConversationProfileHandle mDefaultOutgoingConversationProfileHandle;
   ConversationProfileHandle getNewConversationProfileHandle();  // thread safe
 
   friend class UserAgentRegistration;
   typedef std::map<ConversationProfileHandle, UserAgentRegistration*> RegistrationMap;
   RegistrationMap mRegistrations;
   void registerRegistration(UserAgentRegistration *);
   void unregisterRegistration(UserAgentRegistration *);
 
   ConversationManager* mConversationManager;
   std::shared_ptr<UserAgentMasterProfile> mProfile;
   resip::Security* mSecurity;
   resip::FdPollGrp *mPollGrp;
   resip::EventThreadInterruptor *mEventInterruptor;
   resip::SipStack mStack;
   resip::DialogUsageManager mDum;
   resip::EventStackThread mStackThread;
   volatile bool mDumShutdown;
   volatile bool mUserAgentShutdown;
};
 
}
 
#endif
 
 
/* ====================================================================
 
 Copyright (c) 2021, Daniel Pocock https://danielpocock.com
 Copyright (c) 2016-2022, SIP Spectrum, Inc. http://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.
 
 ==================================================================== */