/*
 * This file is part of the openHiTLS project.
 *
 * openHiTLS is licensed under the Mulan PSL v2.
 * You can use this software according to the terms and conditions of the Mulan PSL v2.
 * You may obtain a copy of Mulan PSL v2 at:
 *
 *     http://license.coscl.org.cn/MulanPSL2
 *
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
 * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
 * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 * See the Mulan PSL v2 for more details.
 */

#ifndef REC_READ_H
#define REC_READ_H

#include <stdint.h>
#include "rec.h"
#include "rec_buf.h"

#ifdef __cplusplus
extern "C" {
#endif

#ifdef HITLS_TLS_PROTO_DTLS12

/**
 * @brief   Read a record in the DTLS protocol
 *
 * @param   ctx [IN] TLS context
 * @param   recordType [IN] Record type
 * @param   data [OUT] Read data
 * @param   len [OUT] Read data length
 * @param   bufSize [IN] buffer length
 *
 * @retval  HITLS_SUCCESS
 * @retval  HITLS_REC_NORMAL_RECV_BUF_EMPTY needs to be read again
 * @retval  HITLS_REC_ERR_IO_EXCEPTION I/O error
 * @retval  HITLS_REC_NORMAL_RECV_UNEXPECT_MSG Unexpected message received
 * @retval  HITLS_REC_NORMAL_RECV_DISORDER_MSG Receives out-of-order messages
 *
 */
int32_t DtlsRecordRead(TLS_Ctx *ctx, REC_Type recordType, uint8_t *data, uint32_t *len, uint32_t bufSize);

#endif

/**
 * @brief   Read a record in the TLS protocol
 *
 * @param   ctx [IN] TLS context
 * @param   recordType [IN] Record type
 * @param   data [OUT] Read data
 * @param   readLen [OUT] Length of the read data
 * @param   num [IN] The read buffer has num bytes
 *
 * @retval  HITLS_SUCCESS
 * @retval  HITLS_REC_NORMAL_RECV_BUF_EMPTY needs to be read again
 * @retval  HITLS_REC_ERR_IO_EXCEPTION I/O error
 * @retval  HITLS_REC_ERR_SN_WRAPPING Sequence number wrap
 * @retval  HITLS_REC_NORMAL_RECV_UNEXPECT_MSG Unexpected message received
 *
 */
int32_t TlsRecordRead(TLS_Ctx *ctx, REC_Type recordType, uint8_t *data, uint32_t *readLen, uint32_t num);

/**
 * @brief   Read data from the UIO of the TLS context to the inBuf
 *
 * @param   ctx [IN] TLS context
 * @param   inBuf [IN]
 * @param   len [IN] len Length to be read
 *
 * @retval  HITLS_SUCCESS
 * @retval  HITLS_REC_ERR_IO_EXCEPTION I/O error
 * @retval  HITLS_REC_NORMAL_RECV_BUF_EMPTY needs to be read again
 */
int32_t StreamRead(TLS_Ctx *ctx, RecBuf *inBuf, uint32_t len);

#ifdef __cplusplus
}
#endif

#endif