#include <stddef.h>
#include <alp/hs_change_mgr.h>
Go to the source code of this file.
Data Structures | |
| struct | _AlpHsObject |
| struct | _AlpHsServerRegistration |
Defines | |
| #define | ALP_HS_MAX_GUID_SIZE 256 |
| #define | ALP_HS_SERVER_ANCHOR_SIZE 64 |
| #define | ALP_HS_SERVER_ID_SIZE 255 |
Typedefs | |
| typedef uint32_t | AlpHsAnchor |
| typedef AlpHsAnchor * | AlpHsAnchorPtr |
| typedef AlpGuidPtr | AlpHsClockIdPtr |
| typedef void * | AlpHsDataStoreIteratorPtr |
| typedef void * | AlpHsIdMapIteratorPtr |
| typedef _AlpHsObject | AlpHsObject |
| typedef AlpHsObject * | AlpHsObjectPtr |
| typedef void * | AlpHsObjectReadHandle |
| typedef void * | AlpHsObjectWriteHandle |
| typedef void * | AlpHsPedigreePtr |
| typedef char | AlpHsServerAnchor [ALP_HS_SERVER_ANCHOR_SIZE] |
| typedef char | AlpHsServerId [ALP_HS_MAX_GUID_SIZE] |
| typedef _AlpHsServerRegistration | AlpHsServerRegistration |
| typedef AlpHsServerRegistration * | AlpHsServerRegistrationPtr |
| typedef void * | AlpHsSnapshotHandle |
| typedef enum _AlpHsSyncType | AlpHsSyncType |
Enumerations | |
| enum | _AlpHsSyncType { kSyncTypeInvalid = 0, kSyncTypeFirst = 1, kSyncTypeClientInitiatedTwoWayFast = 1, kSyncTypeClientInitiatedTwoWaySlow = 2, kSyncTypeClientInitiatedOneWayFromClient = 3, kSyncTypeClientInitiatedRefreshFromClient = 4, kSyncTypeClientInitiatedOneWayFromServer = 5, kSyncTypeClientInitiatedRefreshFromServer = 6, kSyncTypeServerInitiatedTwoWayFast = 7, kSyncTypeServerInitiated = 7, kSyncTypeServerInitiatedOneWayFromClient = 8, kSyncTypeServerInitiatedRefreshFromClient = 9, kSyncTypeServerInitiatedOneWayFromServer = 10, kSyncTypeServerInitiatedRefreshFromServer = 11, kSyncTypeLast = 11 } |
Functions | |
| alp_status_t | alp_hs_pedigree_add_clock (AlpHsChangeMgrHandle hChgMgr, AlpHsPedigreePtr pPedigree, AlpHsClockIdPtr pNodeId, uint32_t clockVal) |
| Adds a clock to the input transient pedigree. | |
| alp_status_t | alp_hs_pedigree_add_pedigree (AlpHsChangeMgrHandle hChgMgr, AlpHsPedigreePtr pSrcPedigree, AlpHsPedigreePtr pTgtPedigree) |
| Adds the target pedigree to the source pedigree. | |
| alp_status_t | alp_hs_pedigree_copy (AlpHsChangeMgrHandle hChgMgr, AlpHsPedigreePtr pSrcPedigree, AlpHsPedigreePtr *ppTgtPedigree) |
| Copies the input transient pedigree. | |
| alp_status_t | alp_hs_pedigree_create (AlpHsChangeMgrHandle hChgMgr, AlpHsPedigreePtr *ppPedigree) |
| Create a new, initially empty, transient pedigree. | |
| alp_status_t | alp_hs_pedigree_delete (AlpHsChangeMgrHandle hChgMgr, AlpHsPedigreePtr pPedigree) |
| Deletes the input pedigree. | |
| alp_status_t | alp_hs_pedigree_get_clock (AlpHsChangeMgrHandle h, AlpHsPedigreePtr pPedigree, uint32_t index, AlpHsClockIdPtr *pNodeId, uint32_t *pClockVal) |
| Provides indexed access to clocks in a transient pedigree. | |
| alp_status_t | alp_hs_pedigree_get_clock_count (AlpHsChangeMgrHandle hChgMgr, AlpHsPedigreePtr pPedigree, uint32_t *pCount) |
| Returns the number of clocks in the input pedigree. | |
| alp_status_t | alp_hs_pedigree_get_clock_value (AlpHsChangeMgrHandle h, AlpHsPedigreePtr pPedigree, AlpHsClockIdPtr pNodeId, uint32_t *pClockVal) |
| Retrieves the clock counter value for a node in a transient pedigree. | |
| alp_status_t | alp_hs_pedigree_is_less_or_equal (AlpHsChangeMgrHandle h, AlpHsPedigreePtr pPedigree1, AlpHsPedigreePtr pPedigree2, bool *pResult) |
| Compares two transient pedigrees and returns true if the first is less than or equal to the second. | |
| alp_status_t | alp_hs_pedigree_make_persistent (AlpHsChangeMgrHandle hChgMgr, AlpHsPedigreePtr pInPedigree, AlpHsPedigreePtr *ppOutPedigree) |
| Creates a persistent pedigree from a transient pedigree. | |
| alp_status_t | alp_hs_pedigree_make_transient (AlpHsChangeMgrHandle hChgMgr, AlpHsPedigreePtr pInPedigree, AlpHsPedigreePtr *ppOutPedigree) |
| Creates a transient pedigree from a persistent pedigree. | |
| alp_status_t | alp_hscm_add_datastore_to_snapshot (AlpHsSnapshotHandle hSnapshot, _TCHAR *locURI, AlpHsPedigreePtr botCover) |
| Add a datastore to the input snapshot. | |
| alp_status_t | alp_hscm_close_datastore (AlpHsChangeMgrHandle hChgMgr) |
| Closes a datastore without closing the ChangeMgr. | |
| alp_status_t | alp_hscm_close_snapshot (AlpHsSnapshotHandle hSnapshot) |
| Close the input snapshot. | |
| alp_status_t | alp_hscm_create_snapshot (AlpHsChangeMgrHandle hChgMgr, AlpHsSnapshotHandle *phSnapshot) |
| Create a new snapshot. | |
| alp_status_t | alp_hscm_delete_snapshot_handle (AlpHsSnapshotHandle hSnapshot) |
| Deletes the input snapshot. | |
| alp_status_t | alp_hscm_get_change_coverage (AlpHsChangeMgrHandle hChgMgr, AlpHsPedigreePtr *ppCoverage) |
| Retrieve an open datastore's change coverage. | |
| alp_status_t | alp_hscm_get_last_anchors (AlpHsChangeMgrHandle hChgMgr, AlpHsAnchorPtr pLocalAnchor, AlpHsServerAnchor serverAnchor, AlpHsPedigreePtr *ppCoverage) |
| Retrieves the coverage, last local anchor and last server anchor values for an open datastore. | |
| alp_status_t | alp_hscm_get_next_anchor (AlpHsChangeMgrHandle hChgMgr, AlpHsAnchorPtr pNextAnchor) |
| Retrieves the local next anchor value for the current server. | |
| alp_status_t | alp_hscm_get_next_id_mapping (AlpHsIdMapIteratorPtr pIter, AlpHsServerId externalId, AlpLuidPtr pLuid) |
| Gets the next id mapping from an id map iterator. | |
| alp_status_t | alp_hscm_get_next_registered_datastore (AlpHsDataStoreIteratorPtr pIter, AlpHsDataStoreRegistrationPtr *ppReg) |
| Retrieves the next datastore registration from a datastore iterator. | |
| alp_status_t | alp_hscm_get_purge_coverage (AlpHsChangeMgrHandle hChgMgr, AlpHsPedigreePtr *ppCoverage) |
| Retrieves an open datastore's purge coverage. | |
| alp_status_t | alp_hscm_is_data_store_registered (AlpHsChangeMgrHandle hChgMgr, const _TCHAR *locURI, bool *pIsRegistered) |
| Determines whether a specified datastore is registered with the ChangeMgr. | |
| alp_status_t | alp_hscm_is_datastore_modified (AlpHsSnapshotHandle hSnapshot, const _TCHAR *locURI, bool *pIsModified) |
| Returns true if any objects from the specified datastore are included in the input snapshot. | |
| alp_status_t | alp_hscm_is_refresh_required (AlpHsChangeMgrHandle hChgMgr, bool *pIsRequired) |
| alp_status_t | alp_hscm_is_version_current (AlpHsChangeMgrHandle hChgMgr, AlpHsDataStoreVersionType type, uint32_t version, bool *pIsCurrent) |
| Determine whether the input content type capabilities or string table version is current for an open datastore. | |
| alp_status_t | alp_hscm_open_datastore (AlpHsChangeMgrHandle hChgMgr, const _TCHAR *locURI) |
| Opens a datastore. | |
| alp_status_t | alp_hscm_open_for_server_sync (const _TCHAR *syncMgrLocURI, const _TCHAR *nodeId, const _TCHAR *serverId, uint32_t userId, void *pContext, AlpHsObjectComparatorFnPtr cmpObjs, AlpHsChangeMgrHandle *phChgMgr) |
| Open the ChangeMgr for synchronization with a standard SyncML server. | |
| alp_status_t | alp_hscm_open_for_sync (const _TCHAR *nodeName, const _TCHAR *syncMgrLocURI, uint32_t userId, void *pContext, AlpHsObjectComparatorFnPtr cmpObjs, AlpHsChangeMgrHandle *phChgMgr) |
| Opens the ChangeMgr for synchronization operations. | |
| alp_status_t | alp_hscm_open_snapshot (AlpHsSnapshotHandle hSnapshot) |
| Open the input snapshot. | |
| alp_status_t | alp_hscm_prepare_for_sync (AlpHsChangeMgrHandle hChgMgr) |
| Prepares a datastore for synchronization operations. | |
| alp_status_t | alp_hscm_purge_all (AlpHsChangeMgrHandle hChgMgr, AlpHsSnapshotHandle hSnapshot) |
| alp_status_t | alp_hscm_query_agent_datastores (AlpHsChangeMgrHandle hChgMgr, const _TCHAR *agentId, AlpHsDataStoreIteratorPtr *ppIter) |
| Retrieve an iterator over the set of registered datastores belonging to a particular agent. | |
| alp_status_t | alp_hscm_query_object_guids (AlpHsChangeMgrHandle hChgMgr, AlpHsSnapshotHandle hSnapshot, uint32_t *pGuidCount, AlpGuidPtr *pGuidArray) |
| Retrieve the GUIDs for objects in an open datastore that are present in the input snapshot. | |
| alp_status_t | alp_hscm_query_registered_datastores (AlpHsChangeMgrHandle hChgMgr, AlpHsDataStoreIteratorPtr *ppIter) |
| Retrieve an iterator over the set of all registered datastores. | |
| alp_status_t | alp_hscm_query_server_id_map (AlpHsChangeMgrHandle hChgMgr, const _TCHAR *locURI, AlpHsIdMapIteratorPtr *ppIter) |
| Retrieve an iterator over the current server's id map for the specified datastore. | |
| alp_status_t | alp_hscm_query_snapshot_top (AlpHsSnapshotHandle hSnapshot, AlpHsPedigreePtr *pTopCover) |
| Retreives the current datastore's top cover. | |
| alp_status_t | alp_hscm_query_snapshot_top_local (AlpHsSnapshotHandle hSnapshot, _TCHAR *locURI, AlpHsPedigreePtr *pTopCover) |
| Retrieve's the specified datastore's top cover. | |
| alp_status_t | alp_hscm_read_capabilities (AlpHsChangeMgrHandle hChgMgr, uint32_t *pCurrentVersion, size_t *pSize, _TCHAR *pBuf) |
| Read content type capabilities from an open datastore. | |
| alp_status_t | alp_hscm_read_modified_object_content (AlpHsObjectReadHandle hRead, AlpHsObjectPtr pObj, AlpHsObjectTypePtr pTgtType, bool *pMoreData, size_t *pSize, _TCHAR *buffer) |
| Read the input object's modified content. | |
| alp_status_t | alp_hscm_read_modified_object_size (AlpHsObjectReadHandle hRead, AlpHsObjectPtr pObj, AlpHsObjectTypePtr pTgtType, size_t *pSize) |
| Retrieve the size of the input object's content when formatted according to the input MIME type. | |
| alp_status_t | alp_hscm_read_modified_objects_begin (AlpHsChangeMgrHandle hChgMgr, AlpHsSnapshotHandle hSnapshot, AlpHsObjectReadHandle *phRead) |
| Begin reading modified objects from an open datastore. | |
| alp_status_t | alp_hscm_read_modified_objects_end (AlpHsObjectReadHandle hRead) |
| End reading modified objects from an open datastore. | |
| alp_status_t | alp_hscm_read_next_modified_object (AlpHsObjectReadHandle hRead, AlpHsObjectPtr *pObj) |
| Read the next modified object from an open datastore. | |
| alp_status_t | alp_hscm_read_string_table (AlpHsChangeMgrHandle hChgMgr, AlpHsObjectTypePtr pObjType, uint32_t *pCurrentVersion, size_t *pSize, _TCHAR *pBuf) |
| Read an open datastore's WBXML string table for the input object type. | |
| alp_status_t | alp_hscm_register_server (AlpHsServerRegistrationPtr pReg) |
| Register a new server. | |
| alp_status_t | alp_hscm_reset_by_node (const _TCHAR *nodeName, uint32_t userId) |
| Resets a node to its initial state. | |
| alp_status_t | alp_hscm_reset_last_anchors (AlpHsChangeMgrHandle hChgMgr) |
| Resets the last anchor values for the current server and datastore. | |
| alp_status_t | alp_hscm_set_change_coverage (AlpHsChangeMgrHandle hChgMgr, AlpHsPedigreePtr pCoverage) |
| Sets an open datastore's change coverage. | |
| alp_status_t | alp_hscm_set_last_anchors (AlpHsSnapshotHandle hSnapshot, bool delMapEntries) |
| Updates coverage and anchor values for an open datastore and server. | |
| alp_status_t | alp_hscm_set_next_server_anchor (AlpHsSnapshotHandle hSnapshot, const _TCHAR *locURI, AlpHsSyncType syncType, AlpHsServerAnchor nextServerAnchor) |
| Records the server's next anchor value for the specified datastore in the input snapshot. | |
| alp_status_t | alp_hscm_write_modified_object_content (AlpHsObjectWriteHandle hWrite, AlpHsObjectPtr pObj, AlpHsObjectTypePtr pSrcType, bool moreData, size_t size, const _TCHAR *buffer) |
| Write a modified object's content to an open datastore. | |
| alp_status_t | alp_hscm_write_modified_objects_begin (AlpHsChangeMgrHandle hChgMgr, AlpHsSnapshotHandle hSnapshot, AlpHsObjectWriteHandle *phWrite) |
| Begin writing modified objects to an open datastore. | |
| alp_status_t | alp_hscm_write_modified_objects_end (AlpHsObjectWriteHandle hWrite) |
| End writing modified objects to an open datastore and commit all prior writes. | |
| alp_status_t | alp_hscm_write_modified_objects_rollback (AlpHsObjectWriteHandle hWrite) |
| End writing modified objects to an open datastore and rollback all prior writes. | |
| alp_status_t | alp_hscm_write_next_modified_object (AlpHsObjectWriteHandle hWrite, AlpHsObjectPtr pObject) |
| Write a modified object to an open datastore. | |
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.