ServerSubscription.hxx

Go to the documentation of this file.

#if !defined(RESIP_SERVERSUBSCRIPTION_HXX)
#define RESIP_SERVERSUBSCRIPTION_HXX

#include "resip/dum/BaseSubscription.hxx"

namespace resip
{

class DialogUsageManager;

class ServerSubscription : public BaseSubscription 
{
   public:
      typedef Handle<ServerSubscription> ServerSubscriptionHandle;
      ServerSubscriptionHandle getHandle();

      const Data& getSubscriber() const { return mSubscriber; }
      UInt32 getTimeLeft();
     
      //only 200 and 202 are permissable.  SubscriptionState is not affected.
      //currently must be called for a refresh as well as initial creation.
      SharedPtr<SipMessage> accept(int statusCode = 202);
      SharedPtr<SipMessage> reject(int responseCode);

      //used to accept a reresh when there is no useful state to convey to the
      //client     
      SharedPtr<SipMessage> neutralNotify();
      
      void setSubscriptionState(SubscriptionState state);

      SharedPtr<SipMessage> update(const Contents* document);
      void end(TerminateReason reason, const Contents* document = 0);

      virtual void end();
      virtual void send(SharedPtr<SipMessage> msg);
      virtual void sendCommand(SharedPtr<SipMessage> msg)
      {
         BaseSubscription::sendCommand(msg);
      }

//      void setTerminationState(TerminateReason reason);
//      void setCurrentEventDocument(const Contents* document);

      virtual void dispatch(const SipMessage& msg);
      virtual void dispatch(const DumTimeout& timer);

      virtual EncodeStream& dump(EncodeStream& strm) const;

   protected:
      virtual ~ServerSubscription();
      virtual void dialogDestroyed(const SipMessage& msg);           
      void onReadyToSend(SipMessage& msg);
      virtual void flowTerminated();
      
   private:
      friend class Dialog;
      
      ServerSubscription(DialogUsageManager& dum, Dialog& dialog, const SipMessage& req);

      void makeNotifyExpires();
      void makeNotify();    
      
      bool shouldDestroyAfterSendingFailure(const SipMessage& msg);      

      Data mSubscriber;

//      const Contents* mCurrentEventDocument;
      SipMessage mLastSubscribe;

      UInt32 mExpires;

      // disabled
      ServerSubscription(const ServerSubscription&);
      ServerSubscription& operator=(const ServerSubscription&);
      UInt64 mAbsoluteExpiry;      
};
 
}

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