Menu
▾
▴
[Syncml-ctoolkit-cvs] toolkit/src/sml/mgr/all mgr.c,1.4,1.5 mgrcmdbuilder.c,1.5,1.6 mgrcmddispatcher.c,1.3,1.4 mgrinstancelist.c,1.2,1.3 mgrinstancemgr.c,1.2,1.3 mgrutil.c,1.3,1.4
|
From: Kidong L. <bri...@us...> - 2004-05-24 01:34:18
|
Update of /cvsroot/syncml-ctoolkit/toolkit/src/sml/mgr/all In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv10631/src/sml/mgr/all Modified Files: mgr.c mgrcmdbuilder.c mgrcmddispatcher.c mgrinstancelist.c mgrinstancemgr.c mgrutil.c Log Message: Modified comments to doxygen-readable Removed duplicated comments Index: mgrutil.c =================================================================== RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/sml/mgr/all/mgrutil.c,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** mgrutil.c 14 Aug 2003 12:48:42 -0000 1.3 --- mgrutil.c 24 May 2004 01:33:36 -0000 1.4 *************** *** 1,11 **** ! /*************************************************************************/ ! /* module: some helper functions */ ! /* */ ! /* file: mgrutil.c */ ! /* target system: all */ ! /* target OS: all */ ! /* */ ! /* Description: */ ! /*************************************************************************/ /* --- 1,10 ---- ! /** ! * @file ! * some helper functions ! * ! * @target_system all ! * @target_os all ! * @description ! */ /* *************** *** 70,82 **** /** ! * FUNCTION: smlFreeProtoElement ! * ! * frees all allocated memory of a smlProtoElement ! * ! * IN: VoidPtr_t ! * Element to free * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlFreeProtoElement(VoidPtr_t pProtoElement) --- 69,77 ---- /** ! * Frees all allocated memory of a smlProtoElement * ! * @param pProtoElement (IN) ! * Element to free ! * @return Return Code */ SML_API Ret_t smlFreeProtoElement(VoidPtr_t pProtoElement) *************** *** 151,163 **** /** ! * FUNCTION: smlFreePcdata ! * ! * frees the Memory of an allocated Pcdata memory object ! * ! * IN: SmlPcdataPtr_t ! * A Pointer to a PcData structure, which should be freed ! * ! * RETURN: --- * */ SML_API void smlFreePcdata(SmlPcdataPtr_t pPcdata) --- 146,153 ---- /** ! * Frees the Memory of an allocated Pcdata memory object * + * @param pPcdata (IN) + * A Pointer to a PcData structure, which should be freed */ SML_API void smlFreePcdata(SmlPcdataPtr_t pPcdata) *************** *** 200,204 **** #ifdef __USE_METINF__ ! /** Subfunctions to smlFreePcdata, to freeup MetaInf DTD structures **/ SML_API void smlFreeMetinfMetinf(SmlMetInfMetInfPtr_t data) { if (!data) return; --- 190,194 ---- #ifdef __USE_METINF__ ! /** Subfunctions to smlFreePcdata, to freeup MetaInf DTD structures */ SML_API void smlFreeMetinfMetinf(SmlMetInfMetInfPtr_t data) { if (!data) return; *************** *** 236,240 **** #ifdef __USE_DEVINF__ ! /** Subfunctions to smlFreePcdata, to freeup DevInf DTD structures **/ SML_API void smlFreeDevInfDevInf(SmlDevInfDevInfPtr_t data) { if (!data) return; --- 226,230 ---- #ifdef __USE_DEVINF__ ! /** Subfunctions to smlFreePcdata, to freeup DevInf DTD structures */ SML_API void smlFreeDevInfDevInf(SmlDevInfDevInfPtr_t data) { if (!data) return; *************** *** 364,374 **** /** - * FUNCTION: smlGetFreeBuffer - * * Return amount of unused Workspace memory * ! * RETURN: MemSize_t ! * Amount of unused Workspace memory ! * */ SML_API MemSize_t smlGetFreeBuffer(InstanceID_t id) --- 354,361 ---- /** * Return amount of unused Workspace memory * ! * @param id instance ID ! * @return Amount of unused Workspace memory */ SML_API MemSize_t smlGetFreeBuffer(InstanceID_t id) *************** *** 395,408 **** /** ! * FUNCTION: smlString2Pcdata ! * ! * copy a string into a Pcdata structure ! * ! * IN: String_t ! * Input String ! * ! * RETURN: SmlPcdataPtr_t ! * A Pointer to a PcData structure * */ SML_API SmlPcdataPtr_t smlString2Pcdata(String_t str) --- 382,390 ---- /** ! * Copy a string into a Pcdata structure * + * @param str (IN) + * Input String + * @return A Pointer to a PcData structure */ SML_API SmlPcdataPtr_t smlString2Pcdata(String_t str) *************** *** 431,443 **** /** ! * FUNCTION: smlPcdata2String ! * ! * copy a Pcdata structure into a string ! * ! * IN: SmlPcdataPtr_t ! * A Pointer to a PcData structure ! * RETURN: String_t ! * Input String * */ SML_API String_t smlPcdata2String(SmlPcdataPtr_t pcdata) --- 413,421 ---- /** ! * Copy a Pcdata structure into a string * + * @param pcdata (IN) + * A Pointer to a PcData structure + * @return Input String */ SML_API String_t smlPcdata2String(SmlPcdataPtr_t pcdata) *************** *** 464,477 **** /** - * FUNCTION: smlPcdataDup - * * Duplicates a Pcdata memory object * ! * IN: SmlPcdataPtr_t ! * A Pointer to the original PcData structure ! * ! * RETURN: SmlPcdataPtr_t ! * A Pointer to the copy of the PcData structure ! * */ SML_API SmlPcdataPtr_t smlPcdataDup(SmlPcdataPtr_t pcdata) --- 442,450 ---- /** * Duplicates a Pcdata memory object * ! * @param pcdata (IN) ! * A Pointer to the original PcData structure ! * @return A Pointer to the copy of the PcData structure */ SML_API SmlPcdataPtr_t smlPcdataDup(SmlPcdataPtr_t pcdata) Index: mgrcmdbuilder.c =================================================================== RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/sml/mgr/all/mgrcmdbuilder.c,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -d -r1.5 -r1.6 *** mgrcmdbuilder.c 14 Nov 2003 09:43:26 -0000 1.5 --- mgrcmdbuilder.c 24 May 2004 01:33:36 -0000 1.6 *************** *** 1,12 **** ! /*************************************************************************/ ! /* module: SyncML Command Builder */ ! /* */ ! /* file: mgrcmdbuilder.c */ ! /* target system: all */ ! /* target OS: all */ ! /* */ ! /* Description: */ ! /* Core Module for assembling SyncML compliant documents */ ! /*************************************************************************/ --- 1,10 ---- ! /** ! * @file ! * SyncML Command Builder ! * ! * @target_system all ! * @target_os all ! * @description Core Module for assembling SyncML compliant documents ! */ *************** *** 127,146 **** /** - * FUNCTION: smlStartMessage - * * Start a SyncML Message * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * IN: SmlSyncHdrPtr_t ! * Data to pass along with that SyncML command ! * ! * RETURN: Ret_t ! * Return Code ! * ! * NOTE: (%%% luz 2003-08-06) this entry point is for compatibilty reasons only ! * and works for SyncML 1.0 only ! * please use smlStartMessageExt() instead in new projects. */ SML_API Ret_t smlStartMessage(InstanceID_t id, SmlSyncHdrPtr_t pContent) --- 125,138 ---- /** * Start a SyncML Message * ! * @param id (IN) ! * ID of the used instance ! * @param pContent (IN) ! * Data to pass along with that SyncML command ! * @return Return Code ! * @note (%%% luz 2003-08-06) this entry point is for compatibilty ! * reasons only and works for SyncML 1.0 only\n ! * please use smlStartMessageExt() instead in new projects. */ SML_API Ret_t smlStartMessage(InstanceID_t id, SmlSyncHdrPtr_t pContent) *************** *** 152,170 **** /** - * FUNCTION: smlStartMessageExt - * (%%% added by luz 2003-08-06 to support SyncML versions other than - * 1.0 with new vers parameter) - * * Start a SyncML Message * ! * IN: InstanceID_t ! * ID of the used instance ! * SyncML version ! * ! * IN: SmlSyncHdrPtr_t ! * Data to pass along with that SyncML command ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlStartMessageExt(InstanceID_t id, SmlSyncHdrPtr_t pContent, SmlVersion_t vers) --- 144,158 ---- /** * Start a SyncML Message * ! * @param id (IN) ! * ID of the used instance ! * @param pContent (IN) ! * Data to pass along with that SyncML command ! * @param vers (IN) ! * SyncML version ! * @return Return Code ! * @note (%%% added by luz 2003-08-06 to support SyncML versions other than ! * 1.0 with new vers parameter) */ SML_API Ret_t smlStartMessageExt(InstanceID_t id, SmlSyncHdrPtr_t pContent, SmlVersion_t vers) *************** *** 234,249 **** /** - * FUNCTION: smlEndMessage - * * End a SyncML Message * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * IN: Boolean_t ! * Final Flag indicates last message within a package ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlEndMessage(InstanceID_t id, Boolean_t final) --- 222,232 ---- /** * End a SyncML Message * ! * @param id (IN) ! * ID of the used instance ! * @param final (IN) ! * Final Flag indicates last message within a package ! * @return Return Code */ SML_API Ret_t smlEndMessage(InstanceID_t id, Boolean_t final) *************** *** 318,333 **** /** - * FUNCTION: smlStartSync - * * Start synchronizing * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * IN: SyncPtr_t ! * Data to pass along with that SyncML command ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlStartSync(InstanceID_t id, SmlSyncPtr_t pContent) --- 301,310 ---- /** * Start synchronizing * ! * @param id (IN) ! * ID of the used instance ! * @param pContent (IN) Data to pass along with that SyncML command ! * @return Return Code */ SML_API Ret_t smlStartSync(InstanceID_t id, SmlSyncPtr_t pContent) *************** *** 339,350 **** /** - * FUNCTION: smlEndSync - * * End synchronizing * ! * IN: InstanceID_t ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlEndSync(InstanceID_t id) --- 316,324 ---- /** * End synchronizing * ! * @param id (IN) ! * ID of the used instance ! * @return Return Code */ SML_API Ret_t smlEndSync(InstanceID_t id) *************** *** 357,372 **** /** - * FUNCTION: smlStartAtomic - * * Start an atomic sequence * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * IN: SmlAtomicPtr_t ! * Data to pass along with that SyncML command ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlStartAtomic(InstanceID_t id, SmlAtomicPtr_t pContent) --- 331,341 ---- /** * Start an atomic sequence * ! * @param id (IN) ! * ID of the used instance ! * @param pContent (IN) ! * Data to pass along with that SyncML command ! * @return Return Code */ SML_API Ret_t smlStartAtomic(InstanceID_t id, SmlAtomicPtr_t pContent) *************** *** 377,389 **** /** - * FUNCTION: smlEndAtomic - * * End an atomic sequence * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlEndAtomic(InstanceID_t id) --- 346,354 ---- /** * End an atomic sequence * ! * @param id (IN) ! * ID of the used instance ! * @return Return Code */ SML_API Ret_t smlEndAtomic(InstanceID_t id) *************** *** 397,412 **** /** - * FUNCTION: smlStartSequence - * * Start a sequence * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * IN: SequencePtr_t ! * Data to pass along with that SyncML command ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlStartSequence(InstanceID_t id, SmlSequencePtr_t pContent) --- 362,372 ---- /** * Start a sequence * ! * @param id (IN) ! * ID of the used instance ! * @param pContent (IN) ! * Data to pass along with that SyncML command ! * @return Return Code */ SML_API Ret_t smlStartSequence(InstanceID_t id, SmlSequencePtr_t pContent) *************** *** 418,430 **** /** - * FUNCTION: smlEndSequence - * * End a sequence * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlEndSequence(InstanceID_t id) --- 378,386 ---- /** * End a sequence * ! * @param id (IN) ! * ID of the used instance ! * @return Return Code */ SML_API Ret_t smlEndSequence(InstanceID_t id) *************** *** 438,453 **** #ifdef ADD_SEND /** - * FUNCTION: smlAddCmd - * * Create a Add Command ! * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * IN: SmlAddPtr_t ! * Data to pass along with that SyncML command ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlAddCmd(InstanceID_t id, SmlAddPtr_t pContent) --- 394,404 ---- #ifdef ADD_SEND /** * Create a Add Command ! * ! * @param id (IN) ! * ID of the used instance ! * @param pContent (IN) ! * Data to pass along with that SyncML command ! * @return Return Code */ SML_API Ret_t smlAddCmd(InstanceID_t id, SmlAddPtr_t pContent) *************** *** 459,474 **** /** - * FUNCTION: smlAlertCmd - * * Create a Alert Command * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * IN: SmlAlertPtr_t ! * Data to pass along with that SyncML command ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlAlertCmd(InstanceID_t id, SmlAlertPtr_t pContent) --- 410,420 ---- /** * Create a Alert Command * ! * @param id (IN) ! * ID of the used instance ! * @param pContent (IN) ! * Data to pass along with that SyncML command ! * @return Return Code */ SML_API Ret_t smlAlertCmd(InstanceID_t id, SmlAlertPtr_t pContent) *************** *** 481,496 **** /** - * FUNCTION: smlDeleteCmd - * * Create a Start Message Command * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * IN: DeletePtr_t ! * Data to pass along with that SyncML command ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlDeleteCmd(InstanceID_t id, SmlDeletePtr_t pContent) --- 427,437 ---- /** * Create a Start Message Command * ! * @param id (IN) ! * ID of the used instance ! * @param pContent (IN) ! * Data to pass along with that SyncML command ! * @return Return Code */ SML_API Ret_t smlDeleteCmd(InstanceID_t id, SmlDeletePtr_t pContent) *************** *** 505,520 **** /** - * FUNCTION: smlGetCmd - * * Create a Get Command * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * IN: GetPtr_t ! * Data to pass along with that SyncML command ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlGetCmd(InstanceID_t id, SmlGetPtr_t pContent) --- 446,456 ---- /** * Create a Get Command * ! * @param id (IN) ! * ID of the used instance ! * @param pContent (IN) ! * Data to pass along with that SyncML command ! * @return Return Code */ SML_API Ret_t smlGetCmd(InstanceID_t id, SmlGetPtr_t pContent) *************** *** 527,542 **** /** - * FUNCTION: smlPutCmd - * * Create a Put Command * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * IN: PutPtr_t ! * Data to pass along with that SyncML command ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlPutCmd(InstanceID_t id, SmlPutPtr_t pContent) --- 463,473 ---- /** * Create a Put Command * ! * @param id (IN) ! * ID of the used instance ! * @param pContent (IN) ! * Data to pass along with that SyncML command ! * @return Return Code */ SML_API Ret_t smlPutCmd(InstanceID_t id, SmlPutPtr_t pContent) *************** *** 548,563 **** /** - * FUNCTION: smlMapCmd - * * Create a Map Command * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * IN: MapPtr_t ! * Data to pass along with that SyncML command ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlMapCmd(InstanceID_t id, SmlMapPtr_t pContent) --- 479,489 ---- /** * Create a Map Command * ! * @param id (IN) ! * ID of the used instance ! * @param pContent (IN) ! * Data to pass along with that SyncML command ! * @return Return Code */ SML_API Ret_t smlMapCmd(InstanceID_t id, SmlMapPtr_t pContent) *************** *** 569,584 **** /** - * FUNCTION: smlResultsCmd - * * Create a Results Command * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * IN: ResultsPtr_t ! * Data to pass along with that SyncML command ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlResultsCmd(InstanceID_t id, SmlResultsPtr_t pContent) --- 495,505 ---- /** * Create a Results Command * ! * @param id (IN) ! * ID of the used instance ! * @param pContent (IN) ! * Data to pass along with that SyncML command ! * @return Return Code */ SML_API Ret_t smlResultsCmd(InstanceID_t id, SmlResultsPtr_t pContent) *************** *** 592,607 **** /** - * FUNCTION: smlStatusCmd - * * Create a Status Command * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * IN: StatusPtr_t ! * Data to pass along with that SyncML command ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlStatusCmd(InstanceID_t id, SmlStatusPtr_t pContent) --- 513,523 ---- /** * Create a Status Command * ! * @param id (IN) ! * ID of the used instance ! * @param pContent (IN) ! * Data to pass along with that SyncML command ! * @return Return Code */ SML_API Ret_t smlStatusCmd(InstanceID_t id, SmlStatusPtr_t pContent) *************** *** 613,628 **** /** - * FUNCTION: smlReplaceCmd - * * Create a Replace Command * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * IN: SmlReplacePtr_t ! * Data to pass along with that SyncML command ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlReplaceCmd(InstanceID_t id, SmlReplacePtr_t pContent) --- 529,539 ---- /** * Create a Replace Command * ! * @param id (IN) ! * ID of the used instance ! * @param pContent (IN) ! * Data to pass along with that SyncML command ! * @return Return Code */ SML_API Ret_t smlReplaceCmd(InstanceID_t id, SmlReplacePtr_t pContent) *************** *** 637,652 **** /** - * FUNCTION: smlCopyCmd - * * Create a Copy Command * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * IN: CopyPtr_t ! * Data to pass along with that SyncML command ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlCopyCmd(InstanceID_t id, SmlCopyPtr_t pContent) --- 548,558 ---- /** * Create a Copy Command * ! * @param id (IN) ! * ID of the used instance ! * @param pContent (IN) ! * Data to pass along with that SyncML command ! * @return Return Code */ SML_API Ret_t smlCopyCmd(InstanceID_t id, SmlCopyPtr_t pContent) *************** *** 660,675 **** /** - * FUNCTION: smlExecCmd - * * Create a Exec Command * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * IN: ExecPtr_t ! * Data to pass along with that SyncML command ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlExecCmd(InstanceID_t id, SmlExecPtr_t pContent) --- 566,576 ---- /** * Create a Exec Command * ! * @param id (IN) ! * ID of the used instance ! * @param pContent (IN) ! * Data to pass along with that SyncML command ! * @return Return Code */ SML_API Ret_t smlExecCmd(InstanceID_t id, SmlExecPtr_t pContent) *************** *** 683,698 **** /** - * FUNCTION: smlSearchCmd - * * Create a Search Command * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * IN: SearchPtr_t ! * Data to pass along with that SyncML command ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlSearchCmd(InstanceID_t id, SmlSearchPtr_t pContent) --- 584,594 ---- /** * Create a Search Command * ! * @param id (IN) ! * ID of the used instance ! * @param pContent (IN) ! * Data to pass along with that SyncML command ! * @return Return Code */ SML_API Ret_t smlSearchCmd(InstanceID_t id, SmlSearchPtr_t pContent) *************** *** 711,725 **** #ifndef __SML_LITE__ /* these API calls are NOT included in the Toolkit lite version */ /** - * FUNCTION: smlStartEvaluation - * * Starts an evaluation run which prevents further API-Calls to write tags - * just the tag-sizes are calculated. Must be sopped via smlEndEvaluation * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlStartEvaluation(InstanceID_t id) --- 607,616 ---- #ifndef __SML_LITE__ /* these API calls are NOT included in the Toolkit lite version */ /** * Starts an evaluation run which prevents further API-Calls to write tags - * just the tag-sizes are calculated. Must be sopped via smlEndEvaluation * ! * @param id (IN) ! * ID of the used instance ! * @return Return Code */ SML_API Ret_t smlStartEvaluation(InstanceID_t id) *************** *** 751,767 **** /** - * FUNCTION: smlEndEvaluation - * * Stops an evaluation run which prevents further API-Calls to write tags - * the remaining free buffer size after all Tags are written is returned * ! * IN: InstanceID_t ! * ID of the used instance ! * ! * IN/OUT: MemSize_t ! * Size of free buffer for data after all tags are written ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlEndEvaluation(InstanceID_t id, MemSize_t *freemem) --- 642,653 ---- /** * Stops an evaluation run which prevents further API-Calls to write tags - * the remaining free buffer size after all Tags are written is returned * ! * @param id (IN) ! * ID of the used instance ! * @param freemem (IN/OUT) ! * Size of free buffer for data after all tags are written ! * @return Return Code */ SML_API Ret_t smlEndEvaluation(InstanceID_t id, MemSize_t *freemem) *************** *** 800,819 **** /** - * FUNCTION: * Calls the encoding routines of the Encoder Module for a given Command Type * and Command Content * ! * ! * IN: InstanceID_t ! * ID of the Instance ! * ! * IN: ProtoElement_t ! * Type of the command (defined by the Proto Element Enumeration) ! * ! * IN: VoidPtr_t ! * Content of the command to encode ! * ! * RETURN: Return value, ! * SML_ERR_OK if command has been encoded successfully */ static Ret_t mgrCreateNextCommand(InstanceID_t id, SmlProtoElement_t cmdType, VoidPtr_t pContent) --- 686,700 ---- /** * Calls the encoding routines of the Encoder Module for a given Command Type * and Command Content * ! * @param id (IN) ! * ID of the Instance ! * @param cmdType (IN) ! * Type of the command (defined by the Proto Element Enumeration) ! * @param pContent (IN) ! * Content of the command to encode ! * @return Return value,\n ! * SML_ERR_OK if command has been encoded successfully */ static Ret_t mgrCreateNextCommand(InstanceID_t id, SmlProtoElement_t cmdType, VoidPtr_t pContent) Index: mgrcmddispatcher.c =================================================================== RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/sml/mgr/all/mgrcmddispatcher.c,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** mgrcmddispatcher.c 14 Nov 2003 09:43:26 -0000 1.3 --- mgrcmddispatcher.c 24 May 2004 01:33:36 -0000 1.4 *************** *** 1,13 **** ! /*************************************************************************/ ! /* module: SyncML Command Dispatcher */ ! /* */ ! /* file: mgrcmddispatcher.c */ ! /* target system: all */ ! /* target OS: all */ ! /* */ ! /* Description: */ ! /* Core module for dispatching parsed commands and invoking callback */ ! /* functions of the application */ ! /*************************************************************************/ --- 1,11 ---- ! /** ! * @file ! * SyncML Command Dispatcher ! * ! * @target_system all ! * @target_os all ! * @description Core module for dispatching parsed commands and invoking ! * callback functions of the application ! */ *************** *** 96,117 **** /** - * FUNCTION: smlProcessData - * * Start the parsing of the XML code in the workspace buffer, * dispatches the interpreted command and calls the corresponding callback * functions provided by the application. * ! * IN: InstanceID_t ! * The SyncML instance id is used for referencing the ! * workspace buffer from the XML content is parsed ! * ! * IN: ProcessMode_t ! * Mode of processing, Defines, if only the first or next ! * XML command is parsed or if all commands are processed ! * subsequently until the end of the entire workspace buffer ! * is reached. The NEXT_COMMAND flag defines the blocking mode, ! * the ALL_COMMANDS tag defines the non-blocking mode. ! * ! * RETURN: Ret_t */ SML_API Ret_t smlProcessData(InstanceID_t id, SmlProcessMode_t mode) --- 94,111 ---- /** * Start the parsing of the XML code in the workspace buffer, * dispatches the interpreted command and calls the corresponding callback * functions provided by the application. * ! * @param id (IN) ! * The SyncML instance id is used for referencing the ! * workspace buffer from the XML content is parsed ! * @param mode (IN) ! * Mode of processing, Defines, if only the first or next ! * XML command is parsed or if all commands are processed ! * subsequently until the end of the entire workspace buffer ! * is reached. The NEXT_COMMAND flag defines the blocking mode, ! * the ALL_COMMANDS tag defines the non-blocking mode. ! * @return Return Code */ SML_API Ret_t smlProcessData(InstanceID_t id, SmlProcessMode_t mode) *************** *** 183,197 **** /** - * FUNCTION: * Parses the header information at the beginning of an SyncML document. * ! * IN: InstanceID ! * current InstanceID to pass to callback functions ! * ! * IN/OUT: InstanceInfo ! * state information of the given InstanceID (decoder state will be changed) ! * ! * RETURN: Return value of the Parser, ! * SML_ERR_OK if next command was handled successfully */ static Ret_t mgrProcessStartMessage(InstanceID_t id, InstanceInfoPtr_t pInstanceInfo) --- 177,189 ---- /** * Parses the header information at the beginning of an SyncML document. * ! * @param id (IN) ! * current InstanceID to pass to callback functions ! * @param pInstanceInfo (IN/OUT) ! * state information of the given InstanceID ! * (decoder state will be changed) ! * @return Return value of the Parser,\n ! * SML_ERR_OK if next command was handled successfully */ static Ret_t mgrProcessStartMessage(InstanceID_t id, InstanceInfoPtr_t pInstanceInfo) *************** *** 262,276 **** /** - * FUNCTION: * Parses the next Sync Command in the sync document. * ! * IN: InstanceID ! * current InstanceID to pass to callback functions ! * ! * IN: InstanceInfo ! * state information of the given InstanceID ! * ! * RETURN: Return value of the Parser of the called application callback, ! * SML_ERR_OK if next command was handled successfully */ static Ret_t mgrProcessNextCommand(InstanceID_t id, InstanceInfoPtr_t pInstanceInfo) --- 254,265 ---- /** * Parses the next Sync Command in the sync document. * ! * @param id (IN) ! * current InstanceID to pass to callback functions ! * @param pInstanceInfo (IN) ! * state information of the given InstanceID ! * @return Return value of the Parser of the called application callback,\n ! * SML_ERR_OK if next command was handled successfully */ static Ret_t mgrProcessNextCommand(InstanceID_t id, InstanceInfoPtr_t pInstanceInfo) Index: mgrinstancelist.c =================================================================== RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/sml/mgr/all/mgrinstancelist.c,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** mgrinstancelist.c 2 May 2003 22:05:07 -0000 1.2 --- mgrinstancelist.c 24 May 2004 01:33:36 -0000 1.3 *************** *** 1,17 **** ! /*************************************************************************/ ! /* module: List of SyncML Instances */ ! /* */ ! /* file: mgrinstancelist.c */ ! /* target system: all */ ! /* target OS: all */ ! /* */ ! /* Description: */ ! /* This module handles an element list of type InstanceInfo. Each */ ! /* element is identified by the InstanceID. There are functions provided */ ! /* to add, find and remove InstanceInfo elements. */ ! /* This file is private to the core module. The InstanceInfo list is */ ! /* used by the Modules MGR, MGRCmdDispatcher, MGRCmdBuilder */ ! /* and MGRInstanceMgr. */ ! /*************************************************************************/ /* --- 1,15 ---- ! /** ! * @file ! * List of SyncML Instances ! * ! * @target_system all ! * @target_os all ! * @description This module handles an element list of type InstanceInfo. Each ! * element is identified by the InstanceID. There are functions provided ! * to add, find and remove InstanceInfo elements. ! * This file is private to the core module. The InstanceInfo list is ! * used by the Modules MGR, MGRCmdDispatcher, MGRCmdBuilder ! * and MGRInstanceMgr. ! */ /* *************** *** 97,108 **** /** - * FUNCTION: * Adds a new element to the list * ! * IN: InstanceInfoPtr_t ! * pointer to the structure to be be added to list ! * ! * RETURN: Return value, ! * SML_ERR_OK if element was added successfully */ Ret_t addInfo(InstanceInfoPtr_t pInfo) --- 95,104 ---- /** * Adds a new element to the list * ! * @param pInfo (IN) ! * pointer to the structure to be be added to list ! * @return Return value,\n ! * SML_ERR_OK if element was added successfully */ Ret_t addInfo(InstanceInfoPtr_t pInfo) *************** *** 135,147 **** /** - * FUNCTION: * Searches an element with the given InstanceID in the list * ! * IN: InstanceID_t ! * ID of the InstanceInfo structure to be retrieved ! * ! * RETURN: InstanceInfoPtr_t ! * Pointer to the InstanceInfo structure with the given ID ! * NULL, if no InstanceInfo with the given ID has been found */ InstanceInfoPtr_t findInfo(InstanceID_t id) --- 131,140 ---- /** * Searches an element with the given InstanceID in the list * ! * @param id (IN) ! * ID of the InstanceInfo structure to be retrieved ! * @return Pointer to the InstanceInfo structure with the given ID\n ! * NULL, if no InstanceInfo with the given ID has been found */ InstanceInfoPtr_t findInfo(InstanceID_t id) *************** *** 169,180 **** /** - * FUNCTION: * Removes an element with the given InstanceID from the list * ! * IN: InstanceID_t ! * ID of the InstanceInfo structure to be removed ! * ! * RETURN: Return value, ! * SML_ERR_OK if element was removed successfully */ Ret_t removeInfo(InstanceID_t id) --- 162,171 ---- /** * Removes an element with the given InstanceID from the list * ! * @param id (IN) ! * ID of the InstanceInfo structure to be removed ! * @return Return value,\n ! * SML_ERR_OK if element was removed successfully */ Ret_t removeInfo(InstanceID_t id) Index: mgr.c =================================================================== RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/sml/mgr/all/mgr.c,v retrieving revision 1.4 retrieving revision 1.5 diff -C2 -d -r1.4 -r1.5 *** mgr.c 15 Apr 2004 12:06:15 -0000 1.4 --- mgr.c 24 May 2004 01:33:36 -0000 1.5 *************** *** 1,12 **** ! /*************************************************************************/ ! /* module: Managing SyncML */ ! /* */ ! /* file: mgr.c */ ! /* target system: all */ ! /* target OS: all */ ! /* */ ! /* Description: */ ! /* Core Module managing the life-cycle of a syncML Process itself */ ! /*************************************************************************/ --- 1,10 ---- ! /** ! * @file ! * Managing SyncML ! * ! * @target_system all ! * @target_os all ! * @description Core Module managing the life-cycle of a syncML Process itself ! */ *************** *** 109,122 **** /** - * FUNCTION: smlInit - * * Initializes the SyncML Reference Tookit. This is required, before any * other function can be used. * ! * IN: SyncMLOptionsPtr_t ! * options to be applied for the toolkit ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlInit(SmlOptionsPtr_t pCoreOptions) --- 107,116 ---- /** * Initializes the SyncML Reference Tookit. This is required, before any * other function can be used. * ! * @param pCoreOptions (IN) ! * options to be applied for the toolkit ! * @return Return Code */ SML_API Ret_t smlInit(SmlOptionsPtr_t pCoreOptions) *************** *** 189,201 **** /** - * FUNCTION: smlTerminate - * * Terminate SyncML. Frees all memory and other ressources used by * SyncML. This function must be called when terminating SyncML * ! * PRE-Condition: All instances must have been terminated ! * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlTerminate(void) { --- 183,191 ---- /** * Terminate SyncML. Frees all memory and other ressources used by * SyncML. This function must be called when terminating SyncML * ! * @pre All instances must have been terminated ! * @return Return Code */ SML_API Ret_t smlTerminate(void) { *************** *** 226,238 **** /** ! * FUNCTION: smlSetSyncMLOptions ! * ! * change the option settings for syncML ! * ! * IN: SyncMLOptionsPtr_t ! * options to be applied for the toolkit * ! * RETURN: Ret_t ! * Return Code */ SML_API Ret_t smlSetSyncMLOptions(SmlOptionsPtr_t pCoreOptions) { --- 216,224 ---- /** ! * Change the option settings for syncML * ! * @param pCoreOptions (IN) ! * options to be applied for the toolkit ! * @return Return Code */ SML_API Ret_t smlSetSyncMLOptions(SmlOptionsPtr_t pCoreOptions) { *************** *** 268,276 **** *************************************************************************/ /** ! * FUNCTION: mgrGetSyncMLInfo ! * Retrieves a pointer to the structure holding all global informations within SyncML * ! * RETURN: SyncMLInfoPtr_t ! * Pointer to the pGlobalAnchor */ SyncMLInfoPtr_t mgrGetSyncMLAnchor(void) --- 254,261 ---- *************************************************************************/ /** ! * Retrieves a pointer to the structure holding all global informations ! * within SyncML * ! * @return Pointer to the pGlobalAnchor */ SyncMLInfoPtr_t mgrGetSyncMLAnchor(void) *************** *** 280,288 **** /** - * FUNCTION: mgrGetInstanceListAnchor * Retrieves a pointer to the list holding all instance informations * ! * RETURN: InstanceInfoPtr_t ! * Pointer to the pInstanceListAnchor */ InstanceInfoPtr_t mgrGetInstanceListAnchor(void) --- 265,271 ---- /** * Retrieves a pointer to the list holding all instance informations * ! * @return Pointer to the pInstanceListAnchor */ InstanceInfoPtr_t mgrGetInstanceListAnchor(void) *************** *** 292,300 **** /** - * FUNCTION: mgrSetInstanceListAnchor * Set the pointer to the list holding all instance informations * ! * IN: InstanceInfoPtr_t ! * Pointer to the pInstanceListAnchor */ void mgrSetInstanceListAnchor(InstanceInfoPtr_t newListAnchor) --- 275,282 ---- /** * Set the pointer to the list holding all instance informations * ! * @param newListAnchor (IN) ! * pointer to the pInstanceListAnchor */ void mgrSetInstanceListAnchor(InstanceInfoPtr_t newListAnchor) Index: mgrinstancemgr.c =================================================================== RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/sml/mgr/all/mgrinstancemgr.c,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** mgrinstancemgr.c 2 May 2003 22:05:07 -0000 1.2 --- mgrinstancemgr.c 24 May 2004 01:33:36 -0000 1.3 *************** *** 1,12 **** ! /*************************************************************************/ ! /* module: Managing SyncML Instances */ ! /* */ ! /* file: mgrinstancemgr.c */ ! /* target system: all */ ! /* target OS: all */ ! /* */ ! /* Description: */ ! /* Core module for managing creation and usage of instances */ ! /*************************************************************************/ /* --- 1,11 ---- ! /** ! * @file ! * Managing SyncML Instances ! * ! * @target_system all ! * @target_os all ! * @description Core module for managing creation and usage of instances ! */ ! /* *************** *** 110,115 **** /** - * FUNCTION: smlInitInstance - * * Creates a SyncML instance and assigns a corresponding workspace buffer in * which XML documents are assembled or parsed. --- 109,112 ---- *************** *** 122,147 **** * is called. * ! * IN: SmlCallbacks_t ! * A structure holding references to the callback functions ! * implemented by the application ! * ! * IN: SmlInstanceOptionsPtr_t ! * Option settings of a particular SyncML instance ! * ! * IN: VoidPtr_t ! * UserData is a pointer to a void structure the application ! * can pass into the SyncML Toolkit instance info. ! * It will be returned to the application with every called ! * callback function call! ! * NOTE: This is only a pointer, the memory object itself ! * remains within the responsibility of the calling application. ! * The memory object will not be copied, moved or freed by the ! * Toolkit. ! * ! * OUT: InstanceID_t ! * Instance ID assigned to the initialized instance ! * ! * RETURN: Ret_t ! * Error Code */ SML_API Ret_t smlInitInstance(SmlCallbacksPtr_t pCallbacks, SmlInstanceOptionsPtr_t pOptions, VoidPtr_t pUserData, InstanceID_t *pInstanceID) --- 119,138 ---- * is called. * ! * @param pCallbacks (IN) ! * A structure holding references to the callback functions ! * implemented by the application ! * @param pOptions (IN) ! * Option settings of a particular SyncML instance ! * @param pUserData (IN) ! * UserData is a pointer to a void structure the application ! * can pass into the SyncML Toolkit instance info. It will ! * be returned to the application with every called callback ! * function call!\n ! * NOTE: This is only a pointer, the memory object itself ! * remains within the responsibility of the calling application. ! * The memory object will not be copied, moved or freed by the Toolkit. ! * @param pInstanceID (OUT) ! * Instance ID assigned to the initialized instance ! * @return Error Code */ SML_API Ret_t smlInitInstance(SmlCallbacksPtr_t pCallbacks, SmlInstanceOptionsPtr_t pOptions, VoidPtr_t pUserData, InstanceID_t *pInstanceID) *************** *** 274,287 **** /** - * FUNCTION: smlTerminateInstance - * * Terminates a SyncML instance. The instance info is removed from the instances ! * list. Allmemory allocated for the workspace and the options variables is freed. ! * ! * IN: InstanceID_t ! * ID of the instance to be terminated * ! * RETURN: Ret_t ! * Error Code */ SML_API Ret_t smlTerminateInstance (InstanceID_t id) --- 265,275 ---- /** * Terminates a SyncML instance. The instance info is removed from the instances ! * list. Allmemory allocated for the workspace and the options variables is ! * freed. * ! * @param id (IN) ! * ID of the instance to be terminated ! * @return Error Code */ SML_API Ret_t smlTerminateInstance (InstanceID_t id) *************** *** 334,350 **** /** - * FUNCTION: smlSetCallbacks - * * Sets new callback functions to an instance * ! * IN: InstanceID_t ! * ID of the Instance ! * ! * IN: SmlCallbacksPtr_t ! * A structure holding references to the callback functions ! * implemented by the application ! * ! * RETURN: Return value, ! * SML_ERR_OK if successful */ SML_API Ret_t smlSetCallbacks(InstanceID_t id, SmlCallbacksPtr_t pCallbacks) --- 322,334 ---- /** * Sets new callback functions to an instance * ! * @param id (IN) ! * ID of the Instance ! * @param pCallbacks (IN) ! * A structure holding references to the callback functions ! * implemented by the application ! * @return Return value,\n ! * SML_ERR_OK if successful */ SML_API Ret_t smlSetCallbacks(InstanceID_t id, SmlCallbacksPtr_t pCallbacks) *************** *** 392,415 **** /** - * FUNCTION: smlSetUserData - * * Sets a new Pointer to application specific user data, * which is passed to all invoked callback functions * ! * IN: InstanceID_t ! * ID of the Instance ! * ! * IN: VoidPtr_t ! * UserData is a pointer to a void structure the application ! * can pass into the SyncML Toolkit instance info. ! * It will be returned to the application with every called ! * callback function call! ! * NOTE: This is only a pointer, the memory object itself ! * remains within the responsibility of the calling application. ! * The memory object will not be copied, moved or freed by the ! * Toolkit. ! * ! * RETURN: Return value, ! * SML_ERR_OK if successful */ SML_API Ret_t smlSetUserData(InstanceID_t id, VoidPtr_t pUserData) --- 376,394 ---- /** * Sets a new Pointer to application specific user data, * which is passed to all invoked callback functions * ! * @param id (IN) ! * ID of the Instance ! * @param pUserData (IN) ! * UserData is a pointer to a void structure the application ! * can pass into the SyncML Toolkit instance info. It will ! * be returned to the application with every called callback ! * function call!\n ! * NOTE: This is only a pointer, the memory object itself ! * remains within the responsibility of the calling application. ! * The memory object will not be copied, moved or freed by the Toolkit. ! * @return Return value,\n ! * SML_ERR_OK if successful */ SML_API Ret_t smlSetUserData(InstanceID_t id, VoidPtr_t pUserData) *************** *** 442,458 **** /** - * FUNCTION: smlGetUserData (added by luz %%%) - * * Returns Pointer to application specific user data, * which is passed to all invoked callback functions * ! * IN: InstanceID_t ! * ID of the Instance ! * ! * IN: *VoidPtr_t ! * Receives current Userdata pointer ! * ! * RETURN: Return value, ! * SML_ERR_OK if successful */ SML_API Ret_t smlGetUserData(InstanceID_t id, VoidPtr_t *ppUserData) --- 421,434 ---- /** * Returns Pointer to application specific user data, * which is passed to all invoked callback functions * ! * @param id (IN) ! * ID of the Instance ! * @param ppUserData (OUT) ! * Receives current Userdata pointer ! * @return Return value,\n ! * SML_ERR_OK if successful ! * @note (added by luz %%%) */ SML_API Ret_t smlGetUserData(InstanceID_t id, VoidPtr_t *ppUserData) *************** *** 484,499 **** /** - * FUNCTION: smlGetEncoding (added by luz %%%) - * * Returns Currently set encoding type * ! * IN: InstanceID_t ! * ID of the Instance ! * ! * IN: *SmlEncoding_t ! * Receives current encoding ! * ! * RETURN: Return value, ! * SML_ERR_OK if successful */ SML_API Ret_t smlGetEncoding(InstanceID_t id, SmlEncoding_t *pEncoding) --- 460,472 ---- /** * Returns Currently set encoding type * ! * @param id (IN) ! * ID of the Instance ! * @param pEncoding (OUT) ! * Receives current encoding ! * @return Return value,\n ! * SML_ERR_OK if successful ! * @note (added by luz %%%) */ SML_API Ret_t smlGetEncoding(InstanceID_t id, SmlEncoding_t *pEncoding) *************** *** 524,539 **** /** - * FUNCTION: smlSetEncoding - * * Sets new encoding type for this Instance * ! * IN: InstanceID_t ! * ID of the Instance ! * ! * IN: SmlEncoding_t ! * Type of Encoding to be used within this Instance ! * ! * RETURN: Return value, ! * SML_ERR_OK if successful */ #ifndef __SML_LITE__ /* these API calls are NOT included in the Toolkit lite version */ --- 497,508 ---- /** * Sets new encoding type for this Instance * ! * @param id (IN) ! * ID of the Instance ! * @param encoding (IN) ! * Type of Encoding to be used within this Instance ! * @return Return value,\n ! * SML_ERR_OK if successful */ #ifndef __SML_LITE__ /* these API calls are NOT included in the Toolkit lite version */ *************** *** 574,603 **** /** - * FUNCTION: smlLockReadBuffer - * * Locks the workspace buffer, which is assigned to the given instance * for reading. After this function is called, the application has * access to the workspace buffer, beginning at the address pReadPosition which * is returned by this function. SyncML will not change the workspace ! * buffer until smlUnlockReadBuffer is called. * pReadPosition returns a pointer to a valid position in the SyncML workspace * buffer. The pointer can be used by the application for copying outgoing * synchronization data from the buffer into some transport layer. usedSize * retrieves the size of synchronization data currently stored in the ! * workspace buffer beginning from the address to which pReadPosition points to. * This information is needed by the application when copying XML code out * of the buffer (while sending synchronization data) * ! * IN: InstanceID_t ! * ID of the Instance ! * ! * OUT: MemPtr_t ! * Workspace Pointer from which data can be read ! * ! * OUT: MemSize_t ! * Size of used data in workspace which may be read ! * ! * RETURN: Return value, ! * SML_ERR_OK if successful */ SML_API Ret_t smlLockReadBuffer(InstanceID_t id, MemPtr_t *pReadPosition, MemSize_t *usedSize) --- 543,568 ---- /** * Locks the workspace buffer, which is assigned to the given instance * for reading. After this function is called, the application has * access to the workspace buffer, beginning at the address pReadPosition which * is returned by this function. SyncML will not change the workspace ! * buffer until smlUnlockReadBuffer is called.\n * pReadPosition returns a pointer to a valid position in the SyncML workspace * buffer. The pointer can be used by the application for copying outgoing * synchronization data from the buffer into some transport layer. usedSize * retrieves the size of synchronization data currently stored in the ! * workspace buffer beginning from the address to which pReadPosition points ! * to.\n * This information is needed by the application when copying XML code out * of the buffer (while sending synchronization data) * ! * @param id (IN) ! * ID of the Instance ! * @param pReadPosition (OUT) ! * Workspace Pointer from which data can be read ! * @param usedSize (OUT) ! * Size of used data in workspace which may be read ! * @return Return value,\n ! * SML_ERR_OK if successful */ SML_API Ret_t smlLockReadBuffer(InstanceID_t id, MemPtr_t *pReadPosition, MemSize_t *usedSize) *************** *** 640,660 **** /** - * FUNCTION: smlUnlockReadBuffer - * * End the read access of the application to the workspace buffer. ! * SyncML is now owner of the buffer again and is able to manipulate its contents. * processedBytes passes the number of bytes, which the application has * successfully read and processed (e.g. when the application has copied ! * outgoing synchronization data from the workspace into a communication module). * SyncML removes the given number of bytes from the workspace! * ! * IN: InstanceID_t ! * ID of the Instance ! * ! * IN: MemSize_t ! * Actually read and processed bytes ! * ! * RETURN: Return value, ! * SML_ERR_OK if successful */ SML_API Ret_t smlUnlockReadBuffer(InstanceID_t id, MemSize_t processedBytes) --- 605,623 ---- /** * End the read access of the application to the workspace buffer. ! * SyncML is now owner of the buffer again and is able to manipulate its ! * contents.\n * processedBytes passes the number of bytes, which the application has * successfully read and processed (e.g. when the application has copied ! * outgoing synchronization data from the workspace into a communication ! * module).\n * SyncML removes the given number of bytes from the workspace! * ! * @param id (IN) ! * ID of the Instance ! * @param processedBytes (IN) ! * Actually read and processed bytes ! * @return Return value,\n ! * SML_ERR_OK if successful */ SML_API Ret_t smlUnlockReadBuffer(InstanceID_t id, MemSize_t processedBytes) *************** *** 703,719 **** /** ! * FUNCTION: smlSetMaxOutgoingSize ! * ! * marks the current write pointer position as beginning of a new outgoing * message. This is used to track outgoing message size while writing it * ! * IN: InstanceID_t ! * ID of the Instance ! * ! * IN: MemSize_t ! * maximum size of outgoing message (0=no limit except buffer size) ! * ! * RETURN: Return value, ! * SML_ERR_OK if successful */ SML_API Ret_t smlSetMaxOutgoingSize(InstanceID_t id, MemSize_t maxOutgoingSize) --- 666,679 ---- /** ! * Marks the current write pointer position as beginning of a new outgoing * message. This is used to track outgoing message size while writing it * ! * @param id (IN) ! * ID of the Instance ! * @param maxOutgoingSize (IN) ! * maximum size of outgoing message ! * (0=no limit except buffer size) ! * @return Return value,\n ! * SML_ERR_OK if successful */ SML_API Ret_t smlSetMaxOutgoingSize(InstanceID_t id, MemSize_t maxOutgoingSize) *************** *** 732,745 **** /** ! * FUNCTION: smlSetOutgoingBegin ! * ! * marks the current write pointer position as beginning of a new outgoing * message. This is used to track outgoing message size while writing it * ! * IN: InstanceID_t ! * ID of the Instance ! * ! * RETURN: Return value, ! * SML_ERR_OK if successful */ SML_API Ret_t smlSetOutgoingBegin(InstanceID_t id) --- 692,702 ---- /** ! * Marks the current write pointer position as beginning of a new outgoing * message. This is used to track outgoing message size while writing it * ! * @param id (IN) ! * ID of the Instance ! * @return Return value,\n ! * SML_ERR_OK if successful */ SML_API Ret_t smlSetOutgoingBegin(InstanceID_t id) *************** *** 759,764 **** /** - * FUNCTION: smlLockWriteBuffer - * * Locks the workspace buffer, which is assigned to the given * instance for writing. After this function is called, the --- 716,719 ---- *************** *** 776,790 **** * receiving synchronization data) * ! * IN: InstanceID_t ! * ID of the Instance ! * ! * OUT: MemPtr_t ! * Workspace Pointer to which data can be written ! * ! * OUT: MemSize_t ! * Max free Size of available space for data ! * ! * RETURN: Return value, ! * SML_ERR_OK if successful */ SML_API Ret_t smlLockWriteBuffer(InstanceID_t id, MemPtr_t *pWritePosition, MemSize_t *freeSize) --- 731,742 ---- * receiving synchronization data) * ! * @param id (IN) ! * ID of the Instance ! * @param pWritePosition (OUT) ! * Workspace Pointer to which data can be written ! * @param freeSize (OUT) ! * Max free Size of available space for data ! * @return Return value,\n ! * SML_ERR_OK if successful */ SML_API Ret_t smlLockWriteBuffer(InstanceID_t id, MemPtr_t *pWritePosition, MemSize_t *freeSize) *************** *** 848,852 **** /** - * FUNCTION: smlUnlockWriteBuffer * * End the write access of the application to the workspace buffer. --- 800,803 ---- *************** *** 858,869 **** * synchronization data. * ! * IN: InstanceID_t ! * ID of the Instance ! * ! * IN: MemSize_t ! * Actually written bytes ! * ! * RETURN: Return value, ! * SML_ERR_OK if successful */ SML_API Ret_t smlUnlockWriteBuffer(InstanceID_t id, MemSize_t writtenBytes) --- 809,818 ---- * synchronization data. * ! * @param id (IN) ! * ID of the Instance ! * @param writtenBytes (IN) ! * Actually written bytes ! * @return Return value,\n ! * SML_ERR_OK if successful */ SML_API Ret_t smlUnlockWriteBuffer(InstanceID_t id, MemSize_t writtenBytes) *************** *** 916,927 **** /** - * FUNCTION: mgrResetWorkspace * Reset the Workspace Buffer position to the beginning of the workspace * (clears all data in the buffer) * ! * IN: InstanceID_t ! * ID of the Instance ! * RETURN: Return value, ! * SML_ERR_OK if successful */ Ret_t mgrResetWorkspace (InstanceID_t id) { --- 865,875 ---- /** * Reset the Workspace Buffer position to the beginning of the workspace * (clears all data in the buffer) * ! * @param id (IN) ! * ID of the Instance ! * @return Return value,\n ! * SML_ERR_OK if successful */ Ret_t mgrResetWorkspace (InstanceID_t id) { *************** *** 948,967 **** /** ! * FUNCTION: setInstanceOptions ! * ! * the options settings of an instance are set to a new value ! * ! * IN: InstanceID_t ! * Instance ID assigned to the instance ! * ! * IN: SmlInstanceOptionsPtr_t ! * New option settings of that particular SyncML ins... [truncated message content] |
