IoCallback.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_COMM_IOCALLBACK_H
#define SQUID_SRC_COMM_IOCALLBACK_H
 
#include "base/AsyncCall.h"
#include "comm/Flag.h"
#include "comm/forward.h"
#include "mem/forward.h"
#include "sbuf/forward.h"
 
namespace Comm
{
 
typedef enum {
    IOCB_NONE,
    IOCB_READ,
    IOCB_WRITE
} iocb_type;
 
class IoCallback
{
public:
    iocb_type type;
    Comm::ConnectionPointer conn;
    AsyncCall::Pointer callback;
    char *buf;
    FREE *freefunc;
    int size;
    int offset;
    Comm::Flag errcode;
    int xerrno;
#if USE_DELAY_POOLS
    unsigned int quotaQueueReserv; 
#endif
 
    bool active() const { return callback != nullptr; }
    void setCallback(iocb_type type, AsyncCall::Pointer &cb, char *buf, FREE *func, int sz);
 
    void selectOrQueueWrite();
 
    void cancel(const char *reason);
 
    void finish(Comm::Flag code, int xerrn);
 
private:
    void reset();
};
 
class CbEntry
{
public:
    int fd;
    IoCallback  readcb;
    IoCallback  writecb;
};
 
CbEntry &ioCallbacks(int fd);
 
#define COMMIO_FD_READCB(fd) (&(Comm::ioCallbacks(fd).readcb))
#define COMMIO_FD_WRITECB(fd) (&(Comm::ioCallbacks(fd).writecb))
 
} // namespace Comm
 
#endif /* SQUID_SRC_COMM_IOCALLBACK_H */