Io.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_SECURITY_IO_H
#define SQUID_SRC_SECURITY_IO_H
 
#include "comm/forward.h"
#include "security/ErrorDetail.h"
#include "security/forward.h"
 
namespace Security {
 
class IoResult: public RefCountable {
public:
    typedef RefCount<IoResult> Pointer;
 
    typedef enum { ioSuccess, ioWantRead, ioWantWrite, ioError } Category;
 
    explicit IoResult(const Category aCategory): category(aCategory) {}
    explicit IoResult(const ErrorDetailPointer &anErrorDetail): errorDetail(anErrorDetail) {}
    IoResult(const IoResult &aRes) = default;
 
    bool successful() const { return category == ioSuccess; }
 
    bool wantsIo() const { return category == ioWantRead || category == ioWantWrite; }
 
    void printGist(std::ostream &) const;
 
    void printWithExtras(std::ostream &) const;
 
    ErrorDetailPointer errorDetail; 
 
    Category category = ioError; 
 
    /* the data members below facilitate human-friendly debugging */
    const char *errorDescription = nullptr; 
    bool important = false; 
 
private:
    void printDescription(std::ostream &) const;
};
 
inline std::ostream &
operator <<(std::ostream &os, const IoResult &result)
{
    result.printGist(os);
    return os;
}
 
IoResult Accept(Comm::Connection &transport);
 
IoResult Connect(Comm::Connection &transport);
 
void ForgetErrors();
 
void PrepForIo();
 
} // namespace Security
 
#endif /* SQUID_SRC_SECURITY_IO_H */