ServerRegistration.hxx

Go to the documentation of this file.

#if !defined(RESIP_SERVERREGISTRATION_HXX)
#define RESIP_SERVERREGISTRATION_HXX
 
#include "resip/dum/NonDialogUsage.hxx"
#include "resip/dum/RegistrationPersistenceManager.hxx"
#include "resip/stack/SipMessage.hxx"
 
#include <memory>
#include <utility>
 
namespace resip
{
 
class ServerRegistration: public NonDialogUsage 
{
   public:
      ServerRegistrationHandle getHandle();
 
      void accept(SipMessage& ok);
 
      void accept(int statusCode = 200);
 
      void reject(SipMessage& failure);
 
      void reject(int statusCode);
 
      void end() override;
      void dispatch(const SipMessage& msg) override;
      void dispatch(const DumTimeout& timer) override;
 
      EncodeStream& dump(EncodeStream& strm) const override;
 
      bool asyncProvideContacts(std::unique_ptr<resip::ContactPtrList> contacts);
 
      std::shared_ptr<ContactList> getOriginalContacts() const noexcept { return mOriginalContacts; }  // WARNING - use this only if async mode is not used
      const ContactList& getRequestContacts() const noexcept { return mRequestContacts; }
 
   protected:
      virtual ~ServerRegistration();
   private:
      friend class DialogSet;
      ServerRegistration(DialogUsageManager& dum, DialogSet& dialogSet, const SipMessage& request);
 
      bool tryFlow(ContactInstanceRecord& rec,
                   const resip::SipMessage& msg);
      bool flowTokenNeededForTls(const ContactInstanceRecord &rec) const;
      bool flowTokenNeededForSigcomp(const ContactInstanceRecord &rec) const;
      bool testFlowRequirements(ContactInstanceRecord &rec,
                                const resip::SipMessage& msg,
                                bool hasFlow) const;
 
      SipMessage mRequest;
      Uri mAor;
      std::shared_ptr<ContactList> mOriginalContacts;  // Used only for non-async processing
      ContactList mRequestContacts;  // Contains the Contacts from the REGISTER request
      bool mDidOutbound;
 
      typedef enum AsyncState
      {
         asyncStateNone,
         asyncStateWaitingForInitialContactList, 
         asyncStateProcessingRegistration, 
         asyncStateWaitingForAcceptReject, 
         asyncStateAcceptedWaitingForFinalContactList, 
         asyncStateProvidedFinalContacts, 
         asyncStateQueryOnly 
      } AsyncState;
 
      AsyncState mAsyncState;
 
      void processRegistration(const SipMessage& msg);
 
      void asyncProcessFinalOkMsg(SipMessage &msg, ContactPtrList &contacts);
 
      void processFinalOkMsg(SipMessage &msg, ContactList &contacts);
 
      void asyncProcessFinalContacts(std::unique_ptr<resip::ContactPtrList> contacts);
 
      class AsyncLocalStore
      {
         public:
 
            AsyncLocalStore(std::unique_ptr<ContactPtrList> originalContacts)
            {
               create(std::move(originalContacts));
            }
 
            ~AsyncLocalStore(void)
            {
               destroy();
            }
 
            void create(std::unique_ptr<ContactPtrList> originalContacts);
 
            void destroy(void);
 
            void removeContact(const ContactInstanceRecord &rec);
            void removeAllContacts(void);
 
            RegistrationPersistenceManager::update_status_t
            updateContact(const ContactInstanceRecord &rec);
 
            void releaseLog(std::unique_ptr<ContactRecordTransactionLog> &log, std::unique_ptr<ContactPtrList> &modifiedContacts)
            {
               log = std::move(mLog);
               modifiedContacts = std::move(mModifiedContacts);
            }
 
            unsigned int numContacts() { if(mModifiedContacts.get()) return (unsigned int)mModifiedContacts->size(); return 0; }
         private:
            std::unique_ptr<ContactRecordTransactionLog> mLog;
            std::unique_ptr<ContactPtrList> mModifiedContacts;
      };
 
      std::shared_ptr<AsyncLocalStore> mAsyncLocalStore;
 
      std::shared_ptr<SipMessage> mAsyncOkMsg;
};
 
}
 
#endif
 
/* ====================================================================
 * The Vovida Software License, Version 1.0 
 * 
 * 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/>.
 *
 */