/[resiprocate]/main/resip/dum/SubscriptionHandler.hxx
ViewVC logotype

Annotation of /main/resip/dum/SubscriptionHandler.hxx

Parent Directory Parent Directory | Revision Log Revision Log


Revision 5767 - (hide annotations) (download)
Thu Dec 22 23:55:37 2005 UTC (13 years, 11 months ago) by daniel
File size: 5426 byte(s)
1. handling of overlapping NOTIFY
2. added an additional boolean parameter to client subscription handler onUpdateFoo
3. dispatch 2xx to SUBSCRIBE to ClientSubscription.
1 jason 2727 #if !defined(RESIP_SUBSCRIPTIONHANDLER_HXX)
2     #define RESIP_SUBSCRIPTIONHANDLER_HXX
3    
4 jason 5276 #include "resip/dum/Handles.hxx"
5 derek 5283 #include "resip/stack/Mime.hxx"
6     #include "resip/stack/Contents.hxx"
7 jason 2727
8     namespace resip
9     {
10     class SipMessage;
11 jason 3545 class SecurityAttributes;
12 jason 2727
13     class ClientSubscriptionHandler
14     {
15     public:
16 greg 4768 virtual ~ClientSubscriptionHandler() { }
17    
18 derek 3676 //Client must call acceptUpdate or rejectUpdate for any onUpdateFoo
19 daniel 5767 virtual void onUpdatePending(ClientSubscriptionHandle, const SipMessage& notify, bool outOfOrder)=0;
20     virtual void onUpdateActive(ClientSubscriptionHandle, const SipMessage& notify, bool outOfOrder)=0;
21 derek 3067 //unknown Subscription-State value
22 daniel 5767 virtual void onUpdateExtension(ClientSubscriptionHandle, const SipMessage& notify, bool outOfOrder)=0;
23 derek 3066
24 dlb 4052 virtual int onRequestRetry(ClientSubscriptionHandle, int retrySeconds, const SipMessage& notify)=0;
25    
26 derek 3066 //subscription can be ended through a notify or a failure response.
27     virtual void onTerminated(ClientSubscriptionHandle, const SipMessage& msg)=0;
28     //not sure if this has any value.
29 derek 3570 virtual void onNewSubscription(ClientSubscriptionHandle, const SipMessage& notify)=0;
30 daniel 5505
31     /// called to allow app to adorn a message.
32 jason 5508 virtual void onReadyToSend(ClientSubscriptionHandle, SipMessage& msg);
33 jason 2727 };
34    
35     class ServerSubscriptionHandler
36     {
37 derek 3067 public:
38 greg 4768 virtual ~ServerSubscriptionHandler() {}
39    
40 derek 3058 virtual void onNewSubscription(ServerSubscriptionHandle, const SipMessage& sub)=0;
41 derek 3450 virtual void onRefresh(ServerSubscriptionHandle, const SipMessage& sub);
42 jason 3545 virtual void onPublished(ServerSubscriptionHandle associated,
43     ServerPublicationHandle publication,
44     const Contents* contents,
45     const SecurityAttributes* attrs);
46 derek 3066
47 derek 3676 virtual void onNotifyRejected(ServerSubscriptionHandle, const SipMessage& msg);
48    
49 derek 3066 //called when this usage is destroyed for any reason. One of the following
50     //three methods will always be called before this, but this is the only
51     //method that MUST be implemented by a handler
52     virtual void onTerminated(ServerSubscriptionHandle)=0;
53    
54 jason 5508 virtual void onReadyToSend(ServerSubscriptionHandle, SipMessage& msg);
55 daniel 5505
56 derek 3676 //will be called when a NOTIFY is not delivered(with a usage terminating
57     //statusCode), or the Dialog is destroyed
58 derek 3067 virtual void onError(ServerSubscriptionHandle, const SipMessage& msg);
59 derek 3066
60 jason 3433 //app can synchronously decorate terminating NOTIFY messages. The only
61 derek 3066 //graceful termination mechanism is expiration, but the client can
62     //explicity end a subscription with an Expires header of 0.
63     virtual void onExpiredByClient(ServerSubscriptionHandle, const SipMessage& sub, SipMessage& notify);
64     virtual void onExpired(ServerSubscriptionHandle, SipMessage& notify);
65 derek 3450
66     virtual bool hasDefaultExpires() const;
67     virtual int getDefaultExpires() const;
68 derek 3570
69     const Mimes& getSupportedMimeTypes() const;
70 jason 2727 };
71    
72     }
73    
74 derek 3058 #endif
75 jason 4010
76     /* ====================================================================
77     * The Vovida Software License, Version 1.0
78     *
79     * Copyright (c) 2000 Vovida Networks, Inc. All rights reserved.
80     *
81     * Redistribution and use in source and binary forms, with or without
82     * modification, are permitted provided that the following conditions
83     * are met:
84     *
85     * 1. Redistributions of source code must retain the above copyright
86     * notice, this list of conditions and the following disclaimer.
87     *
88     * 2. Redistributions in binary form must reproduce the above copyright
89     * notice, this list of conditions and the following disclaimer in
90     * the documentation and/or other materials provided with the
91     * distribution.
92     *
93     * 3. The names "VOCAL", "Vovida Open Communication Application Library",
94     * and "Vovida Open Communication Application Library (VOCAL)" must
95     * not be used to endorse or promote products derived from this
96     * software without prior written permission. For written
97     * permission, please contact vocal@vovida.org.
98     *
99     * 4. Products derived from this software may not be called "VOCAL", nor
100     * may "VOCAL" appear in their name, without prior written
101     * permission of Vovida Networks, Inc.
102     *
103     * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
104     * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
105     * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
106     * NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL VOVIDA
107     * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
108     * IN EXCESS OF $1,000, NOR FOR ANY INDIRECT, INCIDENTAL, SPECIAL,
109     * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
110     * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
111     * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
112     * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
113     * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
114     * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
115     * DAMAGE.
116     *
117     * ====================================================================
118     *
119     * This software consists of voluntary contributions made by Vovida
120     * Networks, Inc. and many individuals on behalf of Vovida Networks,
121     * Inc. For more information on Vovida Networks, Inc., please see
122     * <http://www.vovida.org/>.
123     *
124     */

Properties

Name Value
svn:eol-style LF

webmaster AT resiprocate DOT org
ViewVC Help
Powered by ViewVC 1.1.27