Older/MediaServer/Http/HttpRequestSplitter.h

/*
 * Copyright (c) 2016-present The ZLMediaKit project authors. All Rights Reserved.
 *
 * This file is part of ZLMediaKit(https://github.com/ZLMediaKit/ZLMediaKit).
 *
 * Use of this source code is governed by MIT-like license that can be found in the
 * LICENSE file in the root of the source tree. All contributing project authors
 * may be found in the AUTHORS file in the root of the source tree.
 */

#ifndef ZLMEDIAKIT_HTTPREQUESTSPLITTER_H
#define ZLMEDIAKIT_HTTPREQUESTSPLITTER_H

#include <string>
#include "Network/Buffer.h"

namespace mediakit {

class HttpRequestSplitter {
public:
    HttpRequestSplitter();
    virtual ~HttpRequestSplitter() = default;

    /**
     * 添加数据
     * @param data 需要添加的数据
     * @param len 数据长度
     * @warning 实际内存需保证不小于 len + 1, 内部使用 strstr 进行查找, 为防止查找越界, 会在 @p len + 1 的位置设置 '\0' 结束符.
     * Add data
     * @param data Data to be added
     * @param len Data length
     * @warning Actual memory must be no less than len + 1. strstr is used internally for searching. To prevent out-of-bounds search, a '\0' terminator is set at the @p len + 1 position.
     
     * [AUTO-TRANSLATED:3bbfc2ab]
     */
    virtual void input(const char *data, size_t len);

    /**
     * 恢复初始设置
     * Restore initial settings
     
     * [AUTO-TRANSLATED:f797ec5a]
     */
    void reset();

    /**
     * 剩余数据大小
     * Remaining data size
     
     * [AUTO-TRANSLATED:808a9399]
     */
    size_t remainDataSize();

    /**
     * 获取剩余数据指针
     * Get remaining data pointer
     
     * [AUTO-TRANSLATED:e419f28a]
     */
    const char *remainData() const;

    /**
     * 设置最大缓存大小
     * Set maximum cache size
     
     * [AUTO-TRANSLATED:19333c32]
     */
    void setMaxCacheSize(size_t max_cache_size);

protected:
    /**
     * 收到请求头
     * @param data 请求头数据
     * @param len 请求头长度
     *
     * @return 请求头后的content长度,
     *  <0 : 代表后面所有数据都是content，此时后面的content将分段通过onRecvContent函数回调出去
     *  0 : 代表为后面数据还是请求头,
     *  >0 : 代表后面数据为固定长度content,此时将缓存content并等到所有content接收完毕一次性通过onRecvContent函数回调出去
     * Receive request header
     * @param data Request header data
     * @param len Request header length
     *
     * @return Content length after request header,
     *  <0 : Represents that all subsequent data is content, in which case the subsequent content will be called back in segments through the onRecvContent function
     *  0 : Represents that the subsequent data is still the request header,
     *  >0 : Represents that the subsequent data is fixed-length content, in which case the content will be cached and called back through the onRecvContent function once all content is received
     
     * [AUTO-TRANSLATED:f185e6c5]
     */
    virtual ssize_t onRecvHeader(const char *data,size_t len) = 0;

    /**
     * 收到content分片或全部数据
     * onRecvHeader函数返回>0,则为全部数据
     * @param data content分片或全部数据
     * @param len 数据长度
     * Receive content fragments or all data
     * onRecvHeader function returns >0, then it is all data
     * @param data Content fragments or all data
     * @param len Data length
     
     * [AUTO-TRANSLATED:2ef280fb]
     */
    virtual void onRecvContent(const char *data,size_t len) {};

    /**
     * 判断数据中是否有包尾
     * @param data 数据指针
     * @param len 数据长度
     * @return nullptr代表未找到包位，否则返回包尾指针
     * Determine if there is a packet tail in the data
     * @param data Data pointer
     * @param len Data length
     * @return nullptr represents that the packet position is not found, otherwise returns the packet tail pointer
     
     * [AUTO-TRANSLATED:f7190dec]
     */
    virtual const char *onSearchPacketTail(const char *data, size_t len);

    /**
     * 设置content len
     * Set content len
     
     
     * [AUTO-TRANSLATED:6dce48f8]
     */
    void setContentLen(ssize_t content_len);

private:
    ssize_t _content_len = 0;
    size_t _max_cache_size = 0;
    size_t _remain_data_size = 0;
    toolkit::BufferLikeString _remain_data;
};

} /* namespace mediakit */

#endif //ZLMEDIAKIT_HTTPREQUESTSPLITTER_H