|
|
@ -36,10 +36,12 @@ typedef enum _base_protocol_type { |
|
|
|
/** |
|
|
|
* <!-- base_decorate_message() --> |
|
|
|
* |
|
|
|
* @brief Decorate a message with payload |
|
|
|
* @brief Given the data payload for an administrative message, add the appropriate |
|
|
|
* information for the payload based on type and insert the payload into the |
|
|
|
* message |
|
|
|
* |
|
|
|
* @param[in] session session handle |
|
|
|
* @param[in,out] msg message to decorate (contains return result on success) |
|
|
|
* @param[in,out] msg message to decorate |
|
|
|
* @param[in] type base protocol type |
|
|
|
* @param[in] payload payload to send |
|
|
|
* @param[in] size size of payload |
|
|
@ -67,7 +69,8 @@ PEP_STATUS base_decorate_message( |
|
|
|
/** |
|
|
|
* <!-- base_prepare_message() --> |
|
|
|
* |
|
|
|
* @brief Prepare a sync message with payload |
|
|
|
* @brief Given a protocol data payload and a message type, prepare an administrative |
|
|
|
* protocol message for encryption and/or delivery |
|
|
|
* |
|
|
|
* @param[in] session session handle |
|
|
|
* @param[in] me identity to use for the sender |
|
|
@ -104,7 +107,7 @@ PEP_STATUS base_prepare_message( |
|
|
|
/** |
|
|
|
* <!-- base_extract_message() --> |
|
|
|
* |
|
|
|
* @brief Extract a sync message from a pEp message |
|
|
|
* @brief Extract protocol data from a pEp administrative message |
|
|
|
* |
|
|
|
* @param[in] session session handle |
|
|
|
* @param[in] msg message to analyze |
|
|
@ -115,7 +118,7 @@ PEP_STATUS base_prepare_message( |
|
|
|
* @param[out] fpr if message was correctly signed then fpr of signature's |
|
|
|
* key, otherwise NULL |
|
|
|
* |
|
|
|
* @retval PEP_STATUS_OK jif no error occurred, whether or not sync message was found |
|
|
|
* @retval PEP_STATUS_OK if no error occurred, whether or not sync message was found |
|
|
|
* @retval PEP_OUT_OF_MEMORY out of memory |
|
|
|
* @retval PEP_ILLEGAL_VALUE illegal parameter values |
|
|
|
* @retval error_status any other value on error |
|
|
@ -141,10 +144,10 @@ PEP_STATUS base_extract_message( |
|
|
|
/** |
|
|
|
* <!-- try_base_prepare_message() --> |
|
|
|
* |
|
|
|
* @brief Prepare a sync message with payload. This is the internal function to be used by |
|
|
|
* asynchronous network protocol implementations. This function differs from |
|
|
|
* base_prepare_message in that it calls messageToSend(NULL) in case there is a missing |
|
|
|
* or wrong passphrase, but more explanation is required here. |
|
|
|
* @brief Prepare an administrative message with payload. This is the internal function to be used by |
|
|
|
* asynchronous network protocol implementations. This function differs from |
|
|
|
* base_prepare_message in that it calls messageToSend(NULL) in case there is a missing |
|
|
|
* or wrong passphrase, but more explanation is required here. |
|
|
|
* |
|
|
|
* @param[in] session session handle |
|
|
|
* @param[in] me identity to use for the sender |
|
|
|