UdsOp.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.
 */
 
/* DEBUG: section 54    Interprocess Communication */
 
#ifndef SQUID_SRC_IPC_UDSOP_H
#define SQUID_SRC_IPC_UDSOP_H
 
#include "base/AsyncJob.h"
#include "base/forward.h"
#include "cbdata.h"
#include "comm/forward.h"
#include "ipc/FdNotes.h"
#include "ipc/TypedMsgHdr.h"
#include "SquidString.h"
 
class CommTimeoutCbParams;
class CommIoCbParams;
 
namespace Ipc
{
 
class UdsOp: public AsyncJob
{
public:
    UdsOp(const String &pathAddr);
    ~UdsOp() override;
 
public:
    struct sockaddr_un address; 
 
protected:
    virtual void timedout() {} 
 
    Comm::ConnectionPointer &conn(); 
 
    void setTimeout(time_t seconds, const char *handlerName);
    void clearTimeout(); 
 
    void setOptions(int newOptions); 
 
private:
    void noteTimeout(const CommTimeoutCbParams &p);
 
private:
    int options; 
    Comm::ConnectionPointer conn_; 
 
private:
    UdsOp(const UdsOp &); // not implemented
    UdsOp &operator= (const UdsOp &); // not implemented
};
 
struct sockaddr_un PathToAddress(const String &pathAddr);
 
// XXX: move UdsSender code to UdsSender.{cc,h}
class UdsSender: public UdsOp
{
    CBDATA_CHILD(UdsSender);
 
public:
    UdsSender(const String& pathAddr, const TypedMsgHdr& aMessage);
 
    CodeContextPointer codeContext;
 
protected:
    void swanSong() override; // UdsOp (AsyncJob) API
    void start() override; // UdsOp (AsyncJob) API
    bool doneAll() const override; // UdsOp (AsyncJob) API
    void timedout() override; // UdsOp API
 
private:
    void startSleep();
    void cancelSleep();
    static void DelayedRetry(void *data);
    void delayedRetry();
 
    void write(); 
    void wrote(const CommIoCbParams& params); 
 
private:
    TypedMsgHdr message; 
    int retries; 
    time_t timeout; 
    bool sleeping; 
    bool writing; 
 
private:
    UdsSender(const UdsSender&); // not implemented
    UdsSender& operator= (const UdsSender&); // not implemented
};
 
void SendMessage(const String& toAddress, const TypedMsgHdr& message);
const Comm::ConnectionPointer & ImportFdIntoComm(const Comm::ConnectionPointer &conn, int socktype, int protocol, FdNoteId noteId);
 
}
 
#endif /* SQUID_SRC_IPC_UDSOP_H */