capimms.h

彩信MMS的全部代码

 * \param date Date to store for the message
 *****************************************************************************/
void MMSc_setMessageDate( MmsMsgId msgId, MmsTimeSec date);

/*!
 * Type: Request Connector
 *
 * Related Adapter: #MMSa_setMessageHeaderResponse
 *
 * The header information is set in the message with the specified message ID.
 *
 * \param msgId A unique identity for a multimedia message.
 * \param numOfBodyParts The number of body parts that belongs to this message.
 * \param header The header information for the message.
 *****************************************************************************/
void MMSc_setMessageHeader( MmsMsgId msgId, UINT32 numOfBodyParts, 
    const MmsHeader *header);

/*!
 * Type: Request Connector
 *
 * Related Adapter: #MMSa_setMessageMetadataResponse
 *
 * Set the application metadata (four bits) of the message.
 *
 * \param msgId A unique identity for a multimedia message.
 * \param metadata Data to set for a message. Only the four low bits can be set.
 *****************************************************************************/
void MMSc_setMessageMetadata( MmsMsgId msgId, UINT8 metadata);

/*!
 * Type: Request Connector
 *
 * Related Adapter: #MMSa_setMessageProtectedResponse
 *
 * Set the protected status of the message.
 *
 * \param msgId A unique identity for a multimedia message.
 * \param isProtected TRUE if message is protected, FALSE otherwise.
 *****************************************************************************/
void MMSc_setMessageProtected( MmsMsgId msgId, CMN_BOOL isProtected);

/*!
 * Type: Request Connector
 *
 * Related Adapter: #MMSa_setMessageReadResponse
 *
 * Set the read/unread status of the message.
 *
 * \param msgId A unique identity for a multimedia message.
 * \param isRead TRUE if message is read, FALSE if message is unread.
 *****************************************************************************/
void MMSc_setMessageRead( MmsMsgId msgId, CMN_BOOL isRead);

/*!
 * Type: Request Connector
 *
 * Related Adapter: #MMSa_startResponse
 *
 * This function prepares the MMS client for running. The MMS Client 
 * initialises internal memory structures, timers and data. It also reads
 * configuration data and sets default values.
 *
 *****************************************************************************/
void MMSc_start(void);

/*!
 * Type: Request Connector
 *
 * Related Adapter: #MMSa_terminateResponse
 *
 * This function stops the MMS Client and clean up resources. Allocated 
 * memory and other resources are freed. Running tasks will be terminated.
 *
 * \param condition indicates if any special condition exists, e.g. no memory
 *
 *****************************************************************************/
void MMSc_terminate( MmsShutdown condition);

/*!
 * Type: Answer Connector
 *
 * Related Adapter: #MMSa_resetTimer, #MMSa_setTimer
 *
 * Whenever a timer has expired, this connector function must be called.
 *
 *****************************************************************************/
void MMSc_timerExpired(void);

#ifdef MMS_EXTERNAL_DRM_ID_GENERATION
/*!
 * Type: Request Connector.
 *
 * Related Adapter: #MMSa_setDrmIdResponse
 *                      
 * This function updates the unique drmId in the message information file. 
 *
 * This function is only available if #MMS_EXTERNAL_DRM_ID_GENERATION is defined.
 * 
 * \param msgId Message id to update.
 * \param bodyPartId Body part in the message to update.
 * \param drmId DRM ID to be stored in the information file.
 *
 *****************************************************************************/
void MMSc_setDrmId( MmsMsgId msgId, INT32 bodyPartId, UINT32 drmId);
#endif  /* MMS_EXTERNAL_DRM_ID_GENERATION */

/*!
 * Type: Request Connector
 *
 * Related Adapter: None.
 *
 * Check if MMS wants to run. 
 *
 * This connector function checks if the MMS client has any signals in its 
 * signal queue. If so, the MMSc_run() function must be called.
 *
 * \return TRUE if MMS Client has work to do, FALSE otherwise
 *****************************************************************************/
CMN_BOOL MMSc_wantsToRun(void);

/*!
 * Type: Request Connector.
 *
 * Related Adapter: None.
 *                      
 * This function orders a cancellation of a previously initiated parsing 
 * operation and indicates that any parsing result is to be ignored.
 *
 *****************************************************************************/
void SMILc_cancelParserHandler(void);

/*!
 * Type: Request Connector
 *
 * Related Adapter: #SMILa_createCancelResponse
 *
 * This function stops the creation of a SMIL message.
 *
 *****************************************************************************/
void SMILc_createCancel(void);

/*!
 * Type: Request Connector
 *
 * Related Adapter: #SMILa_createEndResponse
 *
 * This function is called when the creation of the SMIL message is finished.
 * The connectors #SMILc_createHead and at least one call to 
 * #SMILc_createPar must be called before calling this function.
 *
 *****************************************************************************/
void SMILc_createEnd(void);

/*!
 * Type: Request Connector
 *
 * Related Adapter: #SMILa_createHeadResponse
 *
 * This is the first function to be called when creating a SMIL message. It 
 * initialises the creation of the SMIL message and creates the SMIL head.
 *
 * \param head All data needed to build a SMIL message's head (meta 
 *        information, root-layout, regions...).
 *****************************************************************************/
void SMILc_createHead(const SmilHead *head);

/*!
 * Type: Request Connector
 *
 * Related Adapter: #SMILa_createParResponse
 *
 * This function adds a 'par' and it's media object to the SMIL message.
 *
 * The connector #SMILc_createHead must be called before calling this function.
 * When the last 'par' element has been created, call #SMILc_createEnd to 
 * inform the SMIL Parser Handler that the creation of the SMIL message is
 * finished.
 *
 * \param par   All data needed to create a par including duration ('dur' 
 *              attribute and all media objects contained by this 'par').
 *****************************************************************************/
void SMILc_createPar(const SmilPar *par);

/*!
 * Type: Answer Connector.
 *
 * Related Adapter: #SMILa_parsedHead
 *
 * When the MMS Application has received a call to #SMILa_parsedHead, it must 
 * call this function to receive the next "par" element.
 *
 *****************************************************************************/
void SMILc_parsedHeadResponse(void);

/*!
 * Type: Answer Connector.
 *
 * Related Adapter: #SMILa_parsedPar
 *
 * When the MMS Application has received a call to #SMILa_parsedPar, it must 
 * call this function to receive the next 'par' element.
 *
 *****************************************************************************/
void SMILc_parsedParResponse(void);

/*!
 * Type: Request Connector.
 *
 * Connector Name: #SMILa_parserData 
 *                      
 * The parser calls this function when it wants to receive more
 * SMIL data to parse.
 *
 *****************************************************************************/
void SMILc_parserAcknowledgeData(void);

/*!
 * Type: Answer Connector.
 *
 * Related Adapter: None.
 *                      
 * The parser calls this function when the character data for an 
 * element has been parsed. This function is a part of the SMIL Parser 
 * Handler's SAX API towards the parser.
 *
 * \param charData The collection of character data that has been parsed.
 * \param len      The length of the collection.
 * \param mode     This parameter identifies if the text has type 
 *                 XML preserved (value zero of the parameter) or 
 *                 normalised (any other value).
 *****************************************************************************/
void SMILc_parserCharacterData(const char *charData, int len, int mode);

/*! 
 * Type: Answer Connector.
 *
 * Related Adapter: #SMILa_smilParserHandlerResponse
 *
 * The MMS Application calls this function to inform the SMIL Parser Handler 
 * that the parsing has finished.
 *                      
 * \param result The result of the operation, SMIL_RESULT_CMMN_OK at success or
 *               SMIL_RESULT_PARSE_FAILED.
 *****************************************************************************/
void SMILc_parserDone(SmilResult result);

/*!
 * Type: Request Connector
 *
 * Related Adapter: None.
 *
 * The parser calls this function when the end for an element has been parsed.
 * This function is a part of the SMIL Parser Handler's SAX api towards the 
 * parser.
 * 
 *****************************************************************************/
void SMILc_parserEndElement(void);

/*! 
 * Type: Request Connector.
 *
 * Related Adapter: #SMILa_parseHandlerResponse
 *
 * This function parses the SMIL message sent as a parameter. If the SMIL 
 * message is in a file, no file operations are allowed until the 
 * SMIL Parser Handler has finished the parsing of the message.
 *
 * \param msg   A reference to the SMIL message to be parsed. This data is 
 *      copied by the MMS Client if needed after the connector function returns.
 *****************************************************************************/
void SMILc_parserHandler(SmilMsg *msg);

/*!
 * Type: Request Connector.
 *
 * Related Adapter: None.
 *                      
 * This function sends the parsed element and its attributes to the SMIL
 * Parser Handler. This function is a part of the SMIL Parser Handler's SAX 
 * API towards the parser.
 * 
 * \param element   The identity of the parsed element.
 * \param attrs     A dynamic array of attributes. Null if no attributes 
 *                  exists.
 * \param numAttrs  The number of attributes. 
 *****************************************************************************/
void SMILc_parserStartElement(int element, SlphAttribute *attrs, int numAttrs);

#endif  /* _CAPIMMS_H */