Home | History | Annotate | Download | only in hdr 
      1 /*************************************************************************/
      2 /* module:          SyncML API for freeing SyncML C structures           */
      3 /*                                                                       */
      4 /* file:            mgrutil.h                                            */
      5 /* target system:   all                                                  */
      6 /* target OS:       all                                                  */
      7 /*                                                                       */
      8 /* Description:                                                          */
      9 /* Definitions for internal use within the SyncML implementation         */
     10 /*************************************************************************/
     11 
     12 
     13 
     14 /*
     15  * Copyright Notice
     16  * Copyright (c) Ericsson, IBM, Lotus, Matsushita Communication
     17  * Industrial Co., Ltd., Motorola, Nokia, Openwave Systems, Inc.,
     18  * Palm, Inc., Psion, Starfish Software, Symbian, Ltd. (2001).
     19  * All Rights Reserved.
     20  * Implementation of all or part of any Specification may require
     21  * licenses under third party intellectual property rights,
     22  * including without limitation, patent rights (such a third party
     23  * may or may not be a Supporter). The Sponsors of the Specification
     24  * are not responsible and shall not be held responsible in any
     25  * manner for identifying or failing to identify any or all such
     26  * third party intellectual property rights.
     27  *
     28  * THIS DOCUMENT AND THE INFORMATION CONTAINED HEREIN ARE PROVIDED
     29  * ON AN "AS IS" BASIS WITHOUT WARRANTY OF ANY KIND AND ERICSSON, IBM,
     30  * LOTUS, MATSUSHITA COMMUNICATION INDUSTRIAL CO. LTD, MOTOROLA,
     31  * NOKIA, PALM INC., PSION, STARFISH SOFTWARE AND ALL OTHER SYNCML
     32  * SPONSORS DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
     33  * BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
     34  * HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
     35  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
     36  * SHALL ERICSSON, IBM, LOTUS, MATSUSHITA COMMUNICATION INDUSTRIAL CO.,
     37  * LTD, MOTOROLA, NOKIA, PALM INC., PSION, STARFISH SOFTWARE OR ANY
     38  * OTHER SYNCML SPONSOR BE LIABLE TO ANY PARTY FOR ANY LOSS OF
     39  * PROFITS, LOSS OF BUSINESS, LOSS OF USE OF DATA, INTERRUPTION OF
     40  * BUSINESS, OR FOR DIRECT, INDIRECT, SPECIAL OR EXEMPLARY, INCIDENTAL,
     41  * PUNITIVE OR CONSEQUENTIAL DAMAGES OF ANY KIND IN CONNECTION WITH
     42  * THIS DOCUMENT OR THE INFORMATION CONTAINED HEREIN, EVEN IF ADVISED
     43  * OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
     44  *
     45  * The above notice and this paragraph must be included on all copies
     46  * of this document that are made.
     47  *
     48  */
     49 
     50 
     51 
     52 #ifndef _MGR_UTIL_H
     53   #define _MGR_UTIL_H
     54 
     55 
     56 /* Prototypes of exported SyncML API functions */
     57 SML_API Ret_t smlFreeProtoElement(VoidPtr_t pProtoElement);
     58 SML_API void smlFreePcdata(SmlPcdataPtr_t pPcdata);
     59 SML_API void smlFreePcdataList(SmlPcdataListPtr_t list);
     60 
     61 SML_API void smlFreeSyncHdr(SmlSyncHdrPtr_t pSyncHdr);
     62 SML_API void smlFreeSync(SmlSyncPtr_t pSync);
     63 SML_API void smlFreeGeneric(SmlGenericCmdPtr_t pGenericCmd);
     64 SML_API void smlFreeAlert(SmlAlertPtr_t pAlert);
     65 SML_API void smlFreeAtomic(SmlAtomicPtr_t pAtomic);
     66 #if (defined EXEC_SEND || defined EXEC_RECEIVE)
     67   SML_API void smlFreeExec(SmlExecPtr_t pExec);
     68 #endif
     69 SML_API void smlFreeGetPut(SmlPutPtr_t pGetPut);
     70 SML_API void smlFreeMap(SmlMapPtr_t pMap);
     71 SML_API void smlFreeResults(SmlResultsPtr_t pResults);
     72 #if (defined SEARCH_SEND || defined SEARCH_RECEIVE)
     73   SML_API void smlFreeSearch(SmlSearchPtr_t pSearch);
     74 #endif
     75 SML_API void smlFreeStatus(SmlStatusPtr_t pStatus);
     76 SML_API void smlFreeCredPtr(SmlCredPtr_t pCred);
     77 SML_API void smlFreeChalPtr(SmlChalPtr_t pChal);
     78 SML_API void smlFreeSourceTargetPtr(SmlSourcePtr_t pSourceTarget);
     79 SML_API void smlFreeSourceList(SmlSourceListPtr_t pSourceList);
     80 SML_API void smlFreeSourceRefList(SmlSourceRefListPtr_t pSourceRefList);
     81 SML_API void smlFreeTargetRefList(SmlTargetRefListPtr_t pTargetRefList);
     82 SML_API void smlFreeItemPtr(SmlItemPtr_t pItem);
     83 SML_API void smlFreeItemList(SmlItemListPtr_t pItemList);
     84 SML_API void smlFreeMapItemPtr(SmlMapItemPtr_t pMapItem);
     85 SML_API void smlFreeMapItemList(SmlMapItemListPtr_t pMapItemList);
     86 
     87 #ifdef __USE_METINF__
     88 SML_API void smlFreeMetinfAnchor(SmlMetInfAnchorPtr_t data);
     89 SML_API void smlFreeMetinfMem(SmlMetInfMemPtr_t data);
     90 SML_API void smlFreeMetinfMetinf(SmlMetInfMetInfPtr_t data);
     91 #endif
     92 #ifdef __USE_DEVINF__
     93 SML_API void smlFreeDevInfDatastore(SmlDevInfDatastorePtr_t data);
     94 SML_API void smlFreeDevInfDatastoreList(SmlDevInfDatastoreListPtr_t data);
     95 SML_API void smlFreeDevInfXmitList(SmlDevInfXmitListPtr_t data);
     96 SML_API void smlFreeDevInfXmit(SmlDevInfXmitPtr_t data);
     97 SML_API void smlFreeDevInfDSMem(SmlDevInfDSMemPtr_t data);
     98 SML_API void smlFreeDevInfSynccap(SmlDevInfSyncCapPtr_t data);
     99 SML_API void smlFreeDevInfExt(SmlDevInfExtPtr_t data);
    100 SML_API void smlFreeDevInfExtList(SmlDevInfExtListPtr_t data);
    101 SML_API void smlFreeDevInfCTData(SmlDevInfCTDataPtr_t data);
    102 SML_API void smlFreeDevInfCTDataList(SmlDevInfCTDataListPtr_t data);
    103 SML_API void smlFreeDevInfCTDataProp(SmlDevInfCTDataPropPtr_t data);
    104 SML_API void smlFreeDevInfCTDataPropList(SmlDevInfCTDataPropListPtr_t data);
    105 SML_API void smlFreeDevInfCTCap(SmlDevInfCTCapPtr_t data);
    106 SML_API void smlFreeDevInfCtcapList(SmlDevInfCtcapListPtr_t data);
    107 SML_API void smlFreeDevInfDevInf(SmlDevInfDevInfPtr_t data);
    108 #endif
    109 
    110 #ifdef __USE_DMTND__
    111 SML_API void smlFreeDmTnd(SmlDmTndPtr_t data);
    112 #endif
    113 
    114 #ifndef __SML_LITE__  /* these API calls are NOT included in the Toolkit lite version */
    115 SML_API String_t smlPcdata2String( SmlPcdataPtr_t pcdata );
    116 SML_API SmlPcdataPtr_t smlString2Pcdata( String_t str );
    117 SML_API SmlPcdataPtr_t smlPcdataDup(SmlPcdataPtr_t pcdata);
    118 SML_API MemSize_t smlGetFreeBuffer(InstanceID_t id);
    119 #endif
    120 
    121 #ifdef __USE_ALLOCFUNCS__
    122 SML_API SmlPcdataPtr_t smlAllocPcdata();
    123 SML_API SmlPcdataListPtr_t smlAllocPcdataList();
    124 SML_API SmlChalPtr_t smlAllocChal();
    125 SML_API SmlCredPtr_t smlAllocCred();
    126 SML_API SmlSourcePtr_t smlAllocSource();
    127 SML_API SmlTargetPtr_t smlAllocTarget();
    128 SML_API SmlSourceListPtr_t smlAllocSourceList();
    129 SML_API SmlSyncHdrPtr_t smlAllocSyncHdr();
    130 SML_API SmlItemPtr_t smlAllocItem();
    131 SML_API SmlItemListPtr_t smlAllocItemList();
    132 SML_API SmlGenericCmdPtr_t smlAllocGeneric();
    133 SML_API SmlAddPtr_t smlAllocAdd();
    134 SML_API SmlCopyPtr_t smlAllocCopy();
    135 SML_API SmlReplacePtr_t smlAllocReplace();
    136 SML_API SmlDeletePtr_t smlAllocDelete();
    137 SML_API SmlAlertPtr_t smlAllocAlert();
    138 SML_API SmlAtomicPtr_t smlAllocAtomic();
    139 SML_API SmlSequencePtr_t smlAllocSequence();
    140 SML_API SmlSyncPtr_t smlAllocSync();
    141 SML_API SmlExecPtr_t smlAllocExec();
    142 SML_API SmlGetPtr_t smlAllocGet();
    143 SML_API SmlPutPtr_t smlAllocPut();
    144 SML_API SmlMapItemPtr_t smlAllocMapItem();
    145 SML_API SmlMapItemListPtr_t smlAllocMapItemList();
    146 SML_API SmlMapPtr_t smlAllocMap();
    147 SML_API SmlResultsPtr_t smlAllocResults();
    148 SML_API SmlSearchPtr_t smlAllocSearch();
    149 SML_API SmlTargetRefListPtr_t smlAllocTargetRefList();
    150 SML_API SmlSourceRefListPtr_t smlAllocSourceRefList();
    151 SML_API SmlStatusPtr_t smlAllocStatus();
    152 SML_API SmlUnknownProtoElementPtr_t smlAllocUnknownProtoElement();
    153 #ifdef __USE_METINF__
    154 SML_API SmlMetInfMetInfPtr_t smlAllocMetInfMetInf();
    155 SML_API SmlMetInfAnchorPtr_t smlAllocMetInfAnchor();
    156 SML_API SmlMetInfMemPtr_t smlAllocMetInfMem();
    157 #endif // MetInf
    158 
    159 #ifdef __USE_DEVINF__
    160 SML_API SmlDevInfExtPtr_t smlAllocDevInfExt();
    161 SML_API SmlDevInfExtListPtr_t smlAllocDevInfExtList();
    162 SML_API SmlDevInfSyncCapPtr_t smlAllocDevInfSyncCap();
    163 SML_API SmlDevInfCTDataPtr_t smlAllocDevInfCTData();
    164 SML_API SmlDevInfCTDataListPtr_t smlAllocDevInfCTDataList();
    165 SML_API SmlDevInfCTDataPropPtr_t smlAllocDevInfCTDataProp();
    166 SML_API SmlDevInfCTDataPropListPtr_t smlAllocDevInfCTDataPropList();
    167 SML_API SmlDevInfCTCapPtr_t smlAllocDevInfCTCap();
    168 SML_API SmlDevInfCtcapListPtr_t smlAllocDevInfCtcapList();
    169 SML_API SmlDevInfDSMemPtr_t smlAllocDevInfDSMem();
    170 SML_API SmlDevInfXmitPtr_t smlAllocDevInfXmit();
    171 SML_API SmlDevInfXmitListPtr_t smlAllocDevInfXmitList();
    172 SML_API SmlDevInfDatastorePtr_t smlAllocDevInfDatastore();
    173 SML_API SmlDevInfDatastoreListPtr_t smlAllocDevInfDatastoreList();
    174 SML_API SmlDevInfDevInfPtr_t smlAllocDevInfDevInf();
    175 #endif // DevInf
    176 
    177 #ifdef __USE_DMTND__
    178 SML_API SmlDmTndPtr_t smlAllocDmTnd();
    179 SML_API SmlDmTndNodeListPtr_t smlAllocDmTndNodeList();
    180 SML_API SmlDmTndNodePtr_t smlAllocDmTndNode();
    181 SML_API SmlDmTndRTPropsPtr_t smlAllocDmTndRTProps();
    182 SML_API SmlDmTndFormatPtr_t smlAllocDmTndFormat();
    183 SML_API SmlDmTndTypePtr_t smlAllocDmTndType();
    184 #endif // DmTnd
    185 #endif // AllocFuncs
    186 #endif // MgrUtil.h
    187