include/alp/postal_types.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright (c) 1999-2008 ACCESS CO., LTD. All rights reserved.
 * Copyright (c) 2006 PalmSource, Inc (an ACCESS company). All rights reserved.
 *****************************************************************************/
#ifndef POSTAL_TYPES_H
#define POSTAL_TYPES_H

/******************************************************************************
 * Includes
 *****************************************************************************/

#ifdef ALP_BUILD

/* for size_t */
#include <stdlib.h>
/* for < typedef uint32_t alp_status_t > and < #define ALP_STATUS_OK 0 > */
#include <alp/types.h>
/* for < #define ALP_CLASS_POSTAL 0xXXXXXXXXX> System component identifier for postal traces and status */
#include <alp/sysclass.h>

#else // ACS

/* for < #define ALP_CLASS_POSTAL   0xXXXXXXXXX> System component identifier for postal traces and status */
#include <nmcs_alp_sysclass.h>
#include <nmcs_alp_types.h>

#endif // ALP_BUILD

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


/******************************************************************************
 * Defines
 *****************************************************************************/

typedef uint32_t alp_postal_object_id_t;

#define ALP_POSTAL_INVALID_OBJECT_ID    0

typedef int32_t alp_postal_time_t;

// Common types

typedef uint8_t alp_postal_number_id_t;

typedef void* alp_postal_context_t;

#define POSTAL_DEFAULT_CONTEXT NULL

/* @}*/

typedef uint8_t         alp_postal_service_id_t;

typedef uint8_t         alp_postal_service_class_id_t;

typedef struct _AlpPostalServiceIdList  AlpPostalServiceIdList;

struct _AlpPostalServiceIdList
{
        alp_postal_service_id_t*        serviceIdListP;         
        uint32_t                        count;                  
};

typedef struct _AlpPostalServiceAddressSchemeList       AlpPostalServiceAddressSchemeList;

struct _AlpPostalServiceAddressSchemeList
{
        char**          serviceAddressSchemeListPP;     
        uint32_t        count;                                          
};

/* @} */

typedef alp_postal_object_id_t alp_postal_session_id_t;

typedef struct _AlpPostalSessionIdList  AlpPostalSessionIdList;

struct _AlpPostalSessionIdList
{
        alp_postal_session_id_t*        sessionIdListP;         
        uint32_t                        count;                  
};
/* @} */

typedef struct _AlpPostalEnvelope AlpPostalEnvelope; // declared here to avoid multiple definitions

typedef alp_postal_object_id_t alp_postal_envelope_id_t;

// postal folder related types
typedef alp_postal_object_id_t alp_postal_folder_id_t;

// postal account related types
typedef alp_postal_object_id_t alp_postal_account_id_t;

typedef struct _AlpPostalAccountIdList  AlpPostalAccountIdList;

// postal rule related types
typedef alp_postal_object_id_t alp_postal_rule_id_t;

typedef uint32_t        alp_postal_property_id_t;

struct _AlpPostalAccountIdList
{
        alp_postal_account_id_t*        accountIdListP;         
        uint32_t                        count;                  
};
/* @} */

typedef struct _AlpPostalProperty AlpPostalProperty;

struct _AlpPostalProperty
{
        AlpPostalProperty*              itsNext;
        AlpPostalProperty*              itsPrev;
        alp_postal_property_id_t        id;             
        uint16_t                        size;           
        union
        {
                uint32_t                asInteger;      
                bool                    asBool;         
                alp_postal_time_t       asDate;         
                char                    asString[1];    
                uint8_t                 asBinary[1];    
        } value;
};


typedef struct _AlpPostalPropertyList AlpPostalPropertyList;

struct _AlpPostalPropertyList {         
        AlpPostalProperty*      itsHead;        
        AlpPostalProperty*      itsTail;        
};

typedef struct _AlpPostalPropertyContainer AlpPostalPropertyContainer;

typedef struct _AlpPostalPropertyContainerList AlpPostalPropertyContainerList;

struct _AlpPostalPropertyContainerList {
        AlpPostalPropertyContainer* itsHead;
        AlpPostalPropertyContainer* itsTail;
};

struct _AlpPostalPropertyContainer {
        AlpPostalPropertyContainer*     itsNext;
        AlpPostalPropertyContainer*     itsPrev;
        AlpPostalPropertyList           propertyList;           
        AlpPostalPropertyContainerList containerList;                                   
};



typedef struct _AlpPostalEnumerator AlpPostalEnumerator;

struct _AlpPostalEnumerator { 
        void*                           sqlStmtPtr;
        void*                           objectList; // depend of enumerator, envelope enum will store an envelope list, folder enum will store a folder list which is a propList
        void*                           currentNode; // depend of enumeratoro
        alp_postal_service_id_t         serviceId; // set to servceiId on get_xxx_enumerator and used by get_next and release
        alp_postal_session_id_t         sessionId; // set to sessionId on get_xxx_enumerator and used by get_next and release
        int                             currentIndex; // global index 0 based
        int                             currentOffset; // offset used the last time cache has been filled on client side.
        // [currentOffset, currentOffset+currentCacheSize] are the index accessible in cache on client side.
        int                             currentCacheSize; // number of object in objectList on client side
        int                             dbCacheSize; // cache to use on db size, 0 to use default
        int                             elemCount; // total number of object returned by the query
        int                             gotoIndex; // index that will be filled on gotoIndex. currentIndex will be equal to gotoIndex if get_next call after goto_index succeeds.
};
/* @} */

typedef struct _AlpPostalPropertyContainer AlpPostalAddress;

typedef struct _AlpPostalPropertyContainer AlpPostalAddressContainer;

typedef struct _AlpPostalPropertyContainerList AlpPostalAddressContainerList;
/* @} */

typedef alp_postal_object_id_t alp_postal_log_id_t;

/* @} */

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif // POSTAL_TYPES_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.