aapimms.h

彩信MMS的全部代码

 *****************************************************************************/
void MMSa_setConfigIntResponse(MmsResult result, MmsConfigInt key);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_setConfigStr
 *
 * The operation ordered in the connector function #MMSc_setConfigStr is 
 * finished. This adapter indicates the outcome of that operation and returns 
 * additional data that is needed or requested.
 *
 * \param result The result of the #MMSc_setConfigStr operation. 
 * \param key The variable whose value that was changed.
 *****************************************************************************/
void MMSa_setConfigStrResponse(MmsResult result, MmsConfigStr key);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_setMessageBody
 *
 * The operation ordered in the connector function #MMSc_setMessageBody is 
 * finished. This adapter indicates the outcome of that operation and returns 
 * additional data that is needed or requested.
 *
 * \param result The result of the #MMSc_setMessageBody operation. 
 *****************************************************************************/
void MMSa_setMessageBodyResponse(MmsResult result);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_setMessageDate
 *
 * The operation ordered in the connector function #MMSc_setMessageDate is 
 * finished. This adapter indicates the outcome of that operation and returns 
 * additional data that is needed or requested.
 *
 * \param result The result of the #MMSc_setMessageDate operation. 
 *****************************************************************************/
void MMSa_setMessageDateResponse(MmsResult result);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_setMessageHeader
 *
 * The operation ordered in the connector function #MMSc_setMessageHeader is 
 * finished. This adapter indicates the outcome of that operation and returns 
 * additional data that is needed or requested.
 *
 * \param result The result of the #MMSc_setMessageHeader operation. 
 *****************************************************************************/
void MMSa_setMessageHeaderResponse(MmsResult result);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_setMessageMetadata
 *
 * The operation ordered in the connector function 
 * #MMSc_setMessageMetadata is finished. This adapter indicates the 
 * outcome of that operation and returns additional data that is needed or 
 * requested.
 *
 * \param result The result of the #MMSc_setMessageMetadata operation. 
 *****************************************************************************/
void MMSa_setMessageMetadataResponse(MmsResult result);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_setMessageProtected
 *
 * The operation ordered in the connector function #MMSc_setMessageProtected is 
 * finished. This adapter indicates the outcome of that operation and returns 
 * additional data that is needed or requested.
 *
 * \param result The result of the #MMSc_setMessageProtected operation. 
 *****************************************************************************/
void MMSa_setMessageProtectedResponse(MmsResult result);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_setMessageRead
 *
 * The operation ordered in the connector function #MMSc_setMessageRead is 
 * finished. This adapter indicates the outcome of that operation and returns 
 * additional data that is needed or requested.
 *
 * \param result The result of the #MMSc_setMessageRead operation. 
 *****************************************************************************/
void MMSa_setMessageReadResponse(MmsResult result);

/*!
 * Type: Service Adapter
 *
 * Related Connector: #MMSc_timerExpired
 *
 * This function is used by the MMS client to set a timer. Note that only one
 * timer is used.
 *
 * \param timeInterval 10th of seconds until the timer shall expire, e.g.
 *      a value of 10 is equal to 1 second.
 *****************************************************************************/
void MMSa_setTimer(UINT32 timeInterval);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_start
 *
 * The operation ordered in the connector function #MMSc_start is 
 * finished. This adapter indicates the outcome of that operation and returns 
 * additional data that is needed or requested.
 *
 * \param result The result of the #MMSc_start operation. 
 *****************************************************************************/
void MMSa_startResponse(MmsResult result);

/*!
 * Type: Service Adapter
 *
 * The MMS Client uses this general adapter to inform the MMS Application 
 * about different status events, e.g. start of an immediate retrieval.
 *
 * \param event     The event to inform the MMS Application about
 * \param msgId     The ID of the message (if any) related to the event.
 * \param data      Data specific to the event
 *****************************************************************************/
void MMSa_status(MmsClientStatus event, MmsMsgId msgId, 
    MmsClientStatusData data);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_terminate
 *
 * The operation ordered in the connector function #MMSc_terminate is 
 * finished. This adapter indicates the outcome of that operation and returns 
 * additional data that is needed or requested.
 *
 * \param result The result of the #MMSc_terminate operation. 
 *****************************************************************************/
void MMSa_terminateResponse(MmsResult result);

#ifdef MMS_EXTERNAL_DRM_ID_GENERATION
/*!
 * Type: Answer Adapter
 *
 * Related Connector: #MMSc_setDrmId
 *                      
 * The operation ordered in the connector function #MMSc_setDrmId is 
 * finished. This adapter indicates the outcome of that operation.
 *
 * This function is only available if #MMS_EXTERNAL_DRM_ID_GENERATION is defined.
 *
 * \param result The result of the #MMSc_setDrmId operation. 
 * \param msgId The message id that is updated
 *
 *****************************************************************************/
void MMSa_setDrmIdResponse( MmsResult result, MmsMsgId msgId);
#endif /* MMS_EXTERNAL_DRM_ID_GENERATION */

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #SMILc_createCancel
 *
 * The operation ordered in the connector function #SMILc_createCancel is 
 * finished. This adapter indicates the outcome of that operation.
 *
 * The result parameter contains the status of the operation. 
 *
 * \param result The result of the #SMILc_createCancel operation. If the 
 *               operation fails, the parameter result will hold the error 
 *               code. Otherwise it will hold the value
 *               #SMIL_RESULT_CANCELLED_BY_USER.
 *****************************************************************************/
void SMILa_createCancelResponse(SmilResult result);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #SMILc_createEnd
 *
 * The operation ordered in the connector function #SMILc_createEnd is 
 * finished. This adapter indicates the outcome of that operation.
 *
 * NOTE that the buffer *must* be in UTF-8 format when 
 * passed on to another terminal/PC.
 *
 * \param result The result of the operation. If it is 
 *               #SMIL_RESULT_OK either the buf or fileId will contain the
 *               built SMIL message.If the operation fail the other 
 *               parameters are not valid and should not be used.
 * \param buf    Contains the SMIL message, in a null terminated string, 
 *               if the created SMIL message is smaller than 
 *               #SMIL_CREATE_BUFFER_SIZE bytes. Otherwise set to NULL.
 *               This data must be copied if needed after the adapter function
 *               returns.
 * \param fileId The file containing the result of the operation if the 
 *               generated SMIL message is equal or greater than 
 *               #SMIL_CREATE_BUFFER_SIZE. Otherwise set to zero.
 *****************************************************************************/
void SMILa_createEndResponse(SmilResult result, char *buf, UINT32 fileId);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #SMILc_createHead
 *
 * The operation ordered in the connector function #SMILc_createHead is 
 * finished. This adapter indicates the outcome of that operation.
 *
 * This answer adapter must checked before any call to #SMILc_createPar can 
 * be done.
 *
 * \param result The result of the #SMILc_createHead operation. At a successful 
 *               create of the head the return value will be #SMIL_RESULT_OK.
 *              If the operation fail it will hold the error code.
 *****************************************************************************/
void SMILa_createHeadResponse(SmilResult result);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #SMILc_createPar 
 *
 * The operation ordered in the connector function #SMILc_createPar is 
 * finished. This adapter indicates the outcome of that operation. This 
 * adapter must be checked before any call to #SMILc_createEnd or any 
 * aditional call to #SMILc_createPar can be done.
 *
 * \param result The result of the #SMILc_createPar operation. At a successful 
 *      create of a par element the return value will be #SMIL_RESULT_OK.
 *      If the operation fail it will hold the error code.
 *****************************************************************************/
void SMILa_createParResponse(SmilResult result);

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #SMILc_parsedHeadResponse
 *
 * The SMIL Parser Handler have parsed the head of the message
 * and it is returned in the parameter head..
 *                      
 * \param head  The head for the SMIL message. This data must be copied if 
 *              needed after the adapter function returns. The parameter is 
 *              set to NULL if no head exists.
 *****************************************************************************/
void SMILa_parsedHead(SmilHead *head);

/*!
 * Type: Answer Adapter
 * 
 * Related Connector: #SMILc_ParsedParResponse
 *                      
 * The SMIL Parser Handler have parsed an element 'par' (a
 * frame) and it is returned in the parameter par. Included in the 
 * return value are any media object element (text, img, src, ref) 
 * contained in the 'par' element.
 *
 * If this is the last 'par' element the SMIL Parser Handler will 
 * call #SMILa_parserHandlerResponse after receiving a call from
 * SMILc_ParsedParResponse. If not, the SMIL Parser Handler 
 * will wait until a call to #SMILc_ParsedParResponse has been received
 * before returning next 'par' element.
 * 
 * \param par   The head for the SMIL message. NULL if no head exists.
                This data must be copied if needed after the adapter function 
 *              returns.
 *****************************************************************************/
void SMILa_parsedPar(SmilPar *par);

/*!
 * Type: Service Adapter
 *
 * Related Connector: None.
 *                      
 * The SMIL Parser Handler requests the parser to start parsing the SMIL 
 * content passed as a parameter in this function.
 *
 * \param data      The data to be parsed. This data must be copied if needed 
 *                  after the adapter function returns.
 * \param dataLen   Length of the data buffer. 
 * \param moreData  True if more data exists and will be sent through
 *                  this function. 
 *****************************************************************************/
void SMILa_parserData(void *data, int dataLen, CMN_BOOL moreData); 

/*!
 * Type: Answer Adapter
 *
 * Related Connector: #SMILa_parserHandler
 *
 * This function returns the result of the #SMILa_parseHandler operation. 
 * This function can be called at any time if the SMIL Parser Handler fails. 
 * After the function has returned, the parsing of the SMIL document has 
 * stopped.
 *
 * If the parsing is successful, this function is called as the last of all 
 * SMIL Parser Handler functions.
 *
 * \param result The result of the #SMILa_parserHandler operation. If it is 
 *      #SMIL_RESULT_OK the parsing is successful. If any 
 *      operation in the SMIL Parser Handler fails this function will
 *      report the reason of failure and no more function calls
 *      to the API will be made by the SMIL Parser Handler.
 *****************************************************************************/
void SMILa_parserHandlerResponse(SmilResult result);

/*!
 * Type: Service Adapter
 *
 * Related Connector: None.
 *                      
 * The SMIL Parser Handler requests the parser to stop the previously started 
 * parsing. Any parse result must be ignored.
 *
 *****************************************************************************/
void SMILa_parserStop(void);

#endif /* _AAPIMMS_H */