SharedListen.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_SHAREDLISTEN_H
#define SQUID_SRC_IPC_SHAREDLISTEN_H
 
#include "base/AsyncCall.h"
#include "base/Subscription.h"
#include "ip/Address.h"
#include "ipc/QuestionerId.h"
#include "ipc/RequestId.h"
#include "ipc/StartListening.h"
 
namespace Ipc
{
 
 
class OpenListenerParams
{
public:
    bool operator <(const OpenListenerParams &p) const; 
 
    // bits to re-create the fde entry
    int sock_type = 0;
    int proto = 0;
    int fdNote = 0; 
 
    // bits to re-create the listener Comm::Connection descriptor
    Ip::Address addr; 
    int flags = 0;
};
 
class TypedMsgHdr;
 
class SharedListenRequest
{
public:
    SharedListenRequest(const OpenListenerParams &, RequestId aMapId); 
    explicit SharedListenRequest(const TypedMsgHdr &hdrMsg); 
    void pack(TypedMsgHdr &hdrMsg) const; 
 
public:
    int requestorId; 
 
    OpenListenerParams params; 
 
    RequestId mapId; 
};
 
class SharedListenResponse
{
public:
    SharedListenResponse(int fd, int errNo, RequestId aMapId); 
    explicit SharedListenResponse(const TypedMsgHdr &hdrMsg); 
    void pack(TypedMsgHdr &hdrMsg) const; 
 
    QuestionerId intendedRecepient() const { return mapId.questioner(); }
 
public:
    int fd; 
    int errNo; 
    RequestId mapId; 
};
 
void JoinSharedListen(const OpenListenerParams &, StartListeningCallback &);
 
void SharedListenJoined(const SharedListenResponse &response);
 
} // namespace Ipc;
 
#endif /* SQUID_SRC_IPC_SHAREDLISTEN_H */