src/include/common/syncml/core/SyncNotification.h

00001 /*
00002  * Funambol is a mobile platform developed by Funambol, Inc. 
00003  * Copyright (C) 2003 - 2007 Funambol, Inc.
00004  * 
00005  * This program is free software; you can redistribute it and/or modify it under
00006  * the terms of the GNU Affero General Public License version 3 as published by
00007  * the Free Software Foundation with the addition of the following permission 
00008  * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
00009  * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 
00010  * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
00011  * 
00012  * This program is distributed in the hope that it will be useful, but WITHOUT
00013  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00014  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
00015  * details.
00016  * 
00017  * You should have received a copy of the GNU Affero General Public License 
00018  * along with this program; if not, see http://www.gnu.org/licenses or write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
00020  * MA 02110-1301 USA.
00021  * 
00022  * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 
00023  * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
00024  * 
00025  * The interactive user interfaces in modified source and object code versions
00026  * of this program must display Appropriate Legal Notices, as required under
00027  * Section 5 of the GNU Affero General Public License version 3.
00028  * 
00029  * In accordance with Section 7(b) of the GNU Affero General Public License
00030  * version 3, these Appropriate Legal Notices must retain the display of the
00031  * "Powered by Funambol" logo. If the display of the logo is not reasonably 
00032  * feasible for technical reasons, the Appropriate Legal Notices must display
00033  * the words "Powered by Funambol".
00034  */
00035 
00036 /*
00037  * This class represent a Server Alerted Notification for DS message (Pkg0).
00038  * After a call to method parse(), the object contains the message data in
00039  * a usable form.
00040  */
00041 
00042 #ifndef INCL_NOTIF_PROCESSOR
00043 #define INCL_NOTIF_PROCESSOR
00044 
00046 #include "syncml/core/SyncAlert.h"
00047 #include "base/globalsdef.h"
00048 
00049 BEGIN_NAMESPACE
00050 
00051 // Define User Interaction Modes
00052 enum SN_UIMode {
00053     UI_NotSpecified,
00054     UI_Background,
00055     UI_Info,
00056     UI_Interactive
00057 };
00058 
00059 // Define Sync Initiator
00060 enum SN_Initiator {
00061     UserInitiated,
00062     ServerInitiated
00063 };
00064 
00065 // Sync Notification Error Codes
00066 enum SN_Errors {
00067     SNErr_Ok,
00068     SNErr_BadReq,
00069     SNErr_InvSync,
00070     SNErr_Incomplete,
00071     SNErr_NullValue,
00072     SNErr_Undefined = 255         // Generic error
00073 };
00074 
00075 
00076 class SyncNotification {
00077 
00078     public:
00079 
00080         // Constructor
00081         SyncNotification();
00082         // Destructor
00083         ~SyncNotification();
00084 
00085         /*
00086          * Parse a PKG0 message
00087          */
00088         SN_Errors parse(const char *msg, int len);
00089 
00090         /*
00091          * Accessor methods
00092          */
00093         int getVersion();
00094         SN_UIMode getUIMode();
00095         SN_Initiator getInitiator();
00096         int getSessionId();
00097         const char*  getServerId();
00098         int getNumSyncs();
00099         SyncAlert* getSyncAlert ( int idx );
00100 
00101     private:
00102         // Notification Header
00103         int version;
00104         SN_UIMode uiMode;
00105         SN_Initiator initiator;
00106         int sessionId;
00107         char*  serverId;
00108         // Notification Body
00109         int numSyncs;
00110         SyncAlert *syncAlerts;
00111 
00112         void reset(bool free);
00113 };
00114 
00115 
00116 END_NAMESPACE
00117 
00119 #endif
00120 

Generated on Fri Jul 25 15:04:15 2008 for Funambol C++ Client Library by  doxygen 1.5.1