RegistrationHandler.hxx

Go to the documentation of this file.

#if !defined(RESIP_REGISTRATIONHANDLER_HXX)
#define RESIP_REGISTRATIONHANDLER_HXX

#include "resip/dum/Handles.hxx"
#include "rutil/SharedPtr.hxx"
#include "resip/dum/ContactInstanceRecord.hxx"

namespace resip
{

class SipMessage;
class NameAddr;
class MasterProfile;

class ClientRegistrationHandler
{
   public:
      virtual ~ClientRegistrationHandler() { }
      virtual void onSuccess(ClientRegistrationHandle, const SipMessage& response)=0;

      // Called when all of my bindings have been removed
      virtual void onRemoved(ClientRegistrationHandle, const SipMessage& response) = 0;
      
      virtual int onRequestRetry(ClientRegistrationHandle, int retrySeconds, const SipMessage& response)=0;
      
      virtual void onFailure(ClientRegistrationHandle, const SipMessage& response)=0;

      //  Called only if clientOutbound is enabled on the UserProfile and the first hop server 
      virtual void onFlowTerminated(ClientRegistrationHandle);
};

class ServerRegistrationHandler
{
   public:
      virtual ~ServerRegistrationHandler() {}

      virtual void onRefresh(ServerRegistrationHandle, const SipMessage& reg)=0;
      
      virtual void onRemove(ServerRegistrationHandle, const SipMessage& reg)=0;
      
      virtual void onRemoveAll(ServerRegistrationHandle, const SipMessage& reg)=0;
      
      virtual void onAdd(ServerRegistrationHandle, const SipMessage& reg)=0;

      virtual void onQuery(ServerRegistrationHandle, const SipMessage& reg)=0;

      virtual void getGlobalExpires(const SipMessage& msg, 
                                    SharedPtr<MasterProfile> masterProfile, 
                                    UInt32 &expires, 
                                    UInt32 &returnCode);

      virtual void getContactExpires(const NameAddr &contact, 
                                     SharedPtr<MasterProfile> masterProfile, 
                                     UInt32 &expires, 
                                     UInt32 &returnCode);

      virtual bool asyncProcessing(void) const
      {
         return false;
      } 

      virtual void asyncGetContacts(ServerRegistrationHandle, const Uri& aor)
      {
      }

      virtual void asyncUpdateContacts(ServerRegistrationHandle,
                                       const Uri& aor,
                                       std::auto_ptr<ContactPtrList> modifiedContactList, 
                                       std::auto_ptr<ContactRecordTransactionLog> transactionLog)
      {
      }

      virtual void asyncRemoveExpired(ServerRegistrationHandle, 
                                      const resip::Uri& aor,
                                      std::auto_ptr<resip::ContactPtrList> contacts)
      {
      }
};

}

#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/>.
 *
 */