include/alp/hs_common.h File Reference


Detailed Description

Common Header file for Alp HotSync Services.

#include <limits.h>
#include <alp/hs_status.h>
#include <alp/hs_id_mgr.h>

Go to the source code of this file.

Data Structures

struct  _AlpDatamodelChangeData
struct  _AlpHsDataStoreRegistration
struct  _AlpHsExternalID
 Represents an ID external to ALP. More...
struct  _AlpHsExternalObject
struct  _AlpHsObjectComparatorInfo
 Structure used to describe a single logical comparator. More...
struct  _AlpHsObjectType

Defines

#define _T(x)   x
#define _TCHAR   char
#define ALP_HS_AGENT_ID_SIZE   127
#define ALP_HS_APPID_DATACHANGE_NOTIFICATION   "/alp/datamodel"
 AppId for data change notification to identify notifications.
#define ALP_HS_COMPARATOR_ID_SIZE   127
 The maximum length of an agent id.
#define ALP_HS_COMPARATOR_NAME_SIZE   31
 The maximum length of an agent display name.
#define ALP_HS_DEFAULT_DESKTOP_NODE_NAME   _T("com.access-company.access desktop")
#define ALP_HS_DEFAULT_NODE_NAME   _T("local")
#define ALP_HS_EXT_COMPONENT_SIZE   4
 The number of component Ids that an external datastore can return during the get change info call.
#define ALP_HS_MIME_TYPE_SIZE   255
#define ALP_HS_MIME_VERSION_SIZE   127
#define ALP_HS_NODE_NAME_SIZE   127
 The maximum length of an node id for n-way sync.
#define ALP_HS_URI_SIZE   255

Typedefs

typedef _AlpDatamodelChangeData AlpDatamodelChangeData
 definition of data object for sending data-change notifications
typedef AlpDatamodelChangeDataAlpDatamodelChangeDataPtr
typedef void * AlpHsChangeMgrHandle
typedef enum _AlpHsChangeMgrType AlpHsChangeMgrType
 An enumeration of what change management system a datastore uses for its records.
typedef void * AlpHsDataStoreHandle
typedef _AlpHsDataStoreRegistration AlpHsDataStoreRegistration
typedef AlpHsDataStoreRegistrationAlpHsDataStoreRegistrationPtr
typedef enum _AlpHsDataStoreVersionType AlpHsDataStoreVersionType
typedef void * AlpHsDbHandle
typedef void * AlpHsDbPtr
typedef _AlpHsExternalID AlpHsExternalID
 Represents an ID external to ALP.
typedef _AlpHsExternalObject AlpHsExternalObject
typedef AlpHsExternalObjectAlpHsExternalObjectPtr
typedef alp_status_t(* AlpHsObjectComparatorFnPtr )(void *pContext, const _TCHAR *mimeType, const _TCHAR *mimeVersion, const _TCHAR *targetURI, uint16_t size1, const _TCHAR *buffer1, uint16_t size2, const _TCHAR *buffer2, int *result)
typedef _AlpHsObjectComparatorInfo AlpHsObjectComparatorInfo
typedef AlpHsObjectComparatorInfoAlpHsObjectComparatorInfoPtr
typedef enum _AlpHsObjectComparatorType AlpHsObjectComparatorType
 An enumeration of different types of comparators.
typedef enum _AlpHsObjectState AlpHsObjectState
typedef _AlpHsObjectType AlpHsObjectType
typedef AlpHsObjectTypeAlpHsObjectTypePtr
typedef enum _AlpHsSupportedDbType AlpHsSupportedDbType

Enumerations

enum  _AlpHsChangeMgrType { kChMgrTypeInvalid = 0, kChMgrTypeHotsync = 1, kChMgrTypeExternal = 2, kChMgrTypeEnumLimit = 3 }
 An enumeration of what change management system a datastore uses for its records. More...
enum  _AlpHsDataStoreVersionType { kVersionTypeCapabilities = 1, kVersionTypeStringTable = 2, kVersionTypeEnumLimit = 3 }
enum  _AlpHsObjectComparatorType {
  kComparatorTypeInvalid = 0, kComparatorTypeExternal = 1, kComparatorTypeCanonical = 2, kComparatorTypeInternal = 3,
  kComparatorTypeEnumLimit = 4
}
 An enumeration of different types of comparators. More...
enum  _AlpHsObjectState {
  kObjectStateModified = 1, kObjectStateDeleted = 2, kObjectStateArchived = 3, kObjectStateNew = 4,
  kObjectStateEnumLimit = 5
}
enum  _AlpHsSupportedDbType { kDbTypeUnsupported = 0, kDbTypeSQLite = 1, kDbTypeEnumLimit = 2 }


Define Documentation

#define _T  )     x
 

#define _TCHAR   char
 


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

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