Reply.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2025 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
#ifndef SQUID_SRC_HELPER_REPLY_H
#define SQUID_SRC_HELPER_REPLY_H
 
#include "base/CbcPointer.h"
#include "helper/forward.h"
#include "helper/ReservationId.h"
#include "helper/ResultCode.h"
#include "MemBuf.h"
#include "Notes.h"
 
#include <ostream>
 
namespace Helper
{
 
class Reply
{
private:
    // copy are prohibited for now
    Reply(const Helper::Reply &r);
    Reply &operator =(const Helper::Reply &r);
 
public:
    explicit Reply(Helper::ResultCode res) : result(res), notes() {}
 
    Reply();
 
    const MemBuf &other() const {return other_.isNull() ? emptyBuf() : other_;};
 
    // XXX: buf should be const but we may need strwordtok() and rfc1738_unescape()
    //void parse(char *buf, size_t len);
    void finalize();
 
    bool accumulate(const char *buf, size_t len);
 
public:
    Helper::ResultCode result;
 
    // list of key=value pairs the helper produced
    NotePairs notes;
 
    Helper::ReservationId reservationId;
private:
    static void CheckReceivedKey(const SBuf &, const SBuf &);
 
    void parseResponseKeys();
 
    const MemBuf &emptyBuf() const;
 
    MemBuf other_;
};
 
std::ostream &operator <<(std::ostream &, const Reply &);
 
} // namespace Helper
 
#endif /* SQUID_SRC_HELPER_REPLY_H */