include/hiker/attnmgr.h

Go to the documentation of this file.

/******************************************************************************
 *
 * Copyright (c) 1999-2008 ACCESS CO., LTD. All rights reserved.
 * Copyright 2006, 2007, ACCESS Systems Americas, Inc. All rights reserved.
 *
 * Version: MPL 1.1/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is hikerproject.org code.
 *
 * The Initial Developer of the Original Code is ACCESS Systems Americas, Inc.
 *               Portions created by the Initial Developer are
 *      Copyright 2006-2007 the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * the GNU Lesser General Public License Version 2.1 (the "LGPL"), in which
 * case the provisions of the LGPL are applicable instead of those above.
 * If you wish to allow use of your version of this file only under the terms
 * of the LGPL, and not to allow others to use your version of this file under
 * the terms of the MPL, indicate your decision by deleting the provisions
 * above and replace them with the notice and other provisions required by
 * the LGPL. If you do not delete the provisions above, a recipient may use
 * your version of this file under the terms of either the MPL or the LGPL. 
 * You may obtain a copy of the LGPL at http://www.gnu.org/licenses/lgpl.txt.
 *
 *****************************************************************************/
#ifndef __ALP_ATTNMGR_H__
#define __ALP_ATTNMGR_H__

#include <time.h>
#include <hiker/types.h>
#include <hiker/sysclass.h>

#include <hiker/attnmgr_properties.h>

#ifdef __cplusplus
extern "C" {
#endif

#define ALP_ALERT_TYPE_ALP                  "/alp"

#define ALP_ALERT_TYPE_ALARM                ALP_ALERT_TYPE_ALP "/alarm"

#define ALP_ALERT_TYPE_ALARM_CALENDAR       ALP_ALERT_TYPE_ALARM "/calendar"

#define ALP_ALERT_TYPE_ALARM_ANNIVERSARY    ALP_ALERT_TYPE_ALARM_CALENDAR "/anniversary"

#define ALP_ALERT_TYPE_ALARM_BIRTHDAY       ALP_ALERT_TYPE_ALARM_CALENDAR "/birthday"

#define ALP_ALERT_TYPE_ALARM_CLOCK              ALP_ALERT_TYPE_ALARM "/clock"

#define ALP_ALERT_TYPE_ALARM_TASK               ALP_ALERT_TYPE_ALARM "/task"

#define ALP_ALERT_TYPE_ALARM_WAKEUP             ALP_ALERT_TYPE_ALARM "/wakeup"

#define ALP_ALERT_TYPE_DOWNLOAD             ALP_ALERT_TYPE_ALP "/download"

#define ALP_ALERT_TYPE_DOWNLOAD_STATUS      ALP_ALERT_TYPE_DOWNLOAD "/status"

#define ALP_ALERT_TYPE_MESSAGING            ALP_ALERT_TYPE_ALP "/messaging"

#define ALP_ALERT_TYPE_SECURITY             ALP_ALERT_TYPE_ALP "/security"

 /* end alert types */

#ifndef ALP_ATTN_API_IMPL
#define ALP_ATTN_API_IMPL 0
#endif

#if ALP_ATTN_API_IMPL
#define ALP_ATTN_DEPRECATE
#else
#define ALP_ATTN_DEPRECATE __attribute((deprecated))
#endif

#define ALP_STATUS_ATTN                     (ALP_CLASS_ATTN  | 0x00010000)

#define ALP_STATUS_ATTN_BAD_PARAM           (ALP_STATUS_ATTN | 0x00000100)

#define ALP_STATUS_ATTN_NO_MEMORY           (ALP_STATUS_ATTN | 0x00000200)

#define ALP_STATUS_ATTN_INTERNAL_ERROR      (ALP_STATUS_ATTN | 0x00000300)

#define ALP_STATUS_ATTN_NOT_FOUND           (ALP_STATUS_ATTN | 0x00000400)

 /* end errors */

typedef enum {
    ALP_ATTN_PRIORITY_NONE = 0,   
    ALP_ATTN_PRIORITY_EMERGENCY, 
    ALP_ATTN_PRIORITY_CRITICAL,  
    ALP_ATTN_PRIORITY_IMPORTANT, 
    ALP_ATTN_PRIORITY_NOTICE,    
    ALP_ATTN_PRIORITY_INFO,      
} AlpAttnPriority;

#define ALP_ATTN_PRIORITY_DEFAULT     ALP_ATTN_PRIORITY_NONE

#define ALP_ATTN_PRIORITY_MAX         ALP_ATTN_PRIORITY_CRITICAL

#define ALP_ATTN_PRIORITY_MIN         ALP_ATTN_PRIORITY_LOW

#define ALP_ATTN_PRIORITY_HIGH        ALP_ATTN_PRIORITY_IMPORTANT

#define ALP_ATTN_PRIORITY_MEDIUM      ALP_ATTN_PRIORITY_NOTICE

#define ALP_ATTN_PRIORITY_LOW         ALP_ATTN_PRIORITY_SOUND

#define ALP_ATTN_PRIORITY_LIST        ALP_ATTN_PRIORITY_INFO

#define ALP_ATTN_PRIORITY_SOUND       0
 /* end priority level */

#define ALP_ATTN_NOTIFY_FLAG_ACTION_MASK     0x000000FF //<! Mask for action field
typedef enum {
    ALP_ATTN_NOTIFY_FLAG_ACTION_POST = 1, //<! Notify is for a post request
    ALP_ATTN_NOTIFY_FLAG_ACTION_UPDATE,   //<! Notify is for an update request
    ALP_ATTN_NOTIFY_FLAG_ACTION_DELETE,   //<! Notify is for a delete request
    ALP_ATTN_NOTIFY_FLAG_ACTION_PING     //<! Notify is a simple ping (Ready test)
} AlpAttnNotifyAction;

#define ALP_NOTIFY_EVENT_ATTN_ALERT     "/alp/attn/alert/"
typedef struct _AlpNotifyEventAttnAlert AlpNotifyEventAttnAlert;
struct _AlpNotifyEventAttnAlert {
    uint32_t index;    //<! Alert index
    uint32_t flags;    //<! Flags associated with alert
    char     handle[]; //<! Handle of alert associated with event
};

 /* end alert notify event */

typedef struct _AlpAttnProp AlpAttnProp;
struct _AlpAttnProp {
    char  *key;   
    char  *value; 
};

#define ALP_ATTN_PROP(k,v) { .key = (k), .value = (v), }

#define ALP_ATTN_PROPERTY(SHORTKEY,v) { .key = (ALP_ATTN_PROP_##SHORTKEY), .value = (v), }
 /* end alert property */


    alp_status_t alp_attn_post (const char  *sourceAppId,
                                const char  *alertTypeName,
                                const char  *handle,
                                uint32_t     nprops,
                                const AlpAttnProp properties[]);

    typedef void (*AlpAttnPostCB)(const char *sourceAppId,
                                  const char *alertTypeName,
                                  const char *handle,
                                  int argc,
                                  char *argv[],
                                  void *user_data);
    alp_status_t alp_attn_post_with_callback (const char  *sourceAppId,
                                              const char  *alertTypeName,
                                              const char  *handle,
                                              uint32_t     nprops,
                                              const AlpAttnProp properties[],
                                              AlpAttnPostCB callback,
                                              void        *user_data);

    alp_status_t alp_attn_update (const char  *sourceAppId,
                                  const char  *alertTypeName,
                                  const char  *handle,
                                  uint32_t     nprops,
                                  const AlpAttnProp properties[]);

    alp_status_t alp_attn_delete (const char  *sourceAppId,
                                  const char  *alertTypeName,
                                  const char  *handle);


    alp_status_t alp_attn_alert_post (const char  *sourceAppId,
                                      const char  *alertTypeName,
                                      const char  *handle,
                                      const char  *interface,
                                      int32_t      priority,
                                      int32_t      duration,
                                      uint32_t     nprops,
                                      const AlpAttnProp properties[]) ALP_ATTN_DEPRECATE;

    typedef void (*AlpAttnAlertCB)(const char *sourceAppId,
                                   const char *alertTypeName,
                                   const char *handle,
                                   int argc,
                                   char *argv[],
                                   void *user_data) /* THIS TYPEDEF IS DEPRECATED - DO NOT USE */;
    alp_status_t alp_attn_alert_post_with_callback (const char  *sourceAppId,
                                                    const char  *alertTypeName,
                                                    const char  *handle,
                                                    const char  *interface,
                                                    int32_t      priority,
                                                    int32_t      duration,
                                                    uint32_t     nprops,
                                                    const AlpAttnProp properties[],
                                                    AlpAttnAlertCB callback,
                                                    void        *user_data) ALP_ATTN_DEPRECATE;

    alp_status_t alp_attn_alert_update (const char  *sourceAppId,
                                        const char  *alertTypeName,
                                        const char  *handle,
                                        uint32_t     nprops,
                                        const AlpAttnProp properties[]) ALP_ATTN_DEPRECATE;

    alp_status_t alp_attn_alert_delete (const char  *sourceAppId,
                                        const char  *alertTypeName,
                                        const char  *handle) ALP_ATTN_DEPRECATE;
 /* enggroup ALP_ATTENTION_API */
 /* endgroup ALP_ATTENTION_MGR */

#ifdef __cplusplus
}
#endif

#endif /* __ALP_ATTNMGR_H__ */

---

Generated on Wed Jul 30 07:06:39 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.