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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 6507 - (show annotations) (download)
Tue Aug 15 17:01:21 2006 UTC (13 years, 3 months ago) by sgodin
File MIME type: text/plain
File size: 5525 byte(s)
- changed ExpiresCategory.cxx to be an UInt32 so that Expires parameter can handle up to 2^32-1 as in RFC
- modified dum so that expiration values use UInt32 instead of int for storage

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

Properties

Name Value
svn:eol-style native
svn:mime-type text/plain

webmaster AT resiprocate DOT org
ViewVC Help
Powered by ViewVC 1.1.27