squid : Optimising Web Delivery

Go to the documentation of this file.

 /*
  * Copyright (C) 1996-2023 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.
  */
  
 #include "squid.h"
 #include "base/AsyncJob.h"
  
 #define STUB_API "comm/libcomm.la"
 #include "tests/STUB.h"
  
 #include "comm/AcceptLimiter.h"
 Comm::AcceptLimiter dummy;
 Comm::AcceptLimiter & Comm::AcceptLimiter::Instance() STUB_RETVAL(dummy)
 void Comm::AcceptLimiter::defer(const Comm::TcpAcceptor::Pointer &) STUB
 void Comm::AcceptLimiter::removeDead(const Comm::TcpAcceptor::Pointer &) STUB
 void Comm::AcceptLimiter::kick() STUB
  
 #include "comm/Connection.h"
 Comm::Connection::Connection() STUB
 Comm::Connection::~Connection() STUB
 Comm::ConnectionPointer Comm::Connection::cloneProfile() const STUB_RETVAL(nullptr)
 void Comm::Connection::close() STUB
 void Comm::Connection::noteClosure() STUB
 CachePeer * Comm::Connection::getPeer() const STUB_RETVAL(nullptr)
 void Comm::Connection::setPeer(CachePeer *) STUB
 ScopedId Comm::Connection::codeContextGist() const STUB_RETVAL(id.detach())
 std::ostream &Comm::Connection::detailCodeContext(std::ostream &os) const STUB_RETVAL(os)
 InstanceIdDefinitions(Comm::Connection, "conn", uint64_t);
  
 #include "comm/ConnOpener.h"
 CBDATA_NAMESPACED_CLASS_INIT(Comm, ConnOpener);
 bool Comm::ConnOpener::doneAll() const STUB_RETVAL(false)
 void Comm::ConnOpener::start() STUB
 void Comm::ConnOpener::swanSong() STUB
 Comm::ConnOpener::ConnOpener(const Comm::ConnectionPointer &, const AsyncCall::Pointer &, time_t) : AsyncJob("STUB Comm::ConnOpener") STUB
     Comm::ConnOpener::~ConnOpener() STUB
     void Comm::ConnOpener::setHost(const char *) STUB
     const char * Comm::ConnOpener::getHost() const STUB_RETVAL(nullptr)
  
 #include "comm/forward.h"
     bool Comm::IsConnOpen(const Comm::ConnectionPointer &) STUB_RETVAL(false)
  
 #include "comm/IoCallback.h"
     void Comm::IoCallback::setCallback(iocb_type, AsyncCall::Pointer &, char *, FREE *, int) STUB
     void Comm::IoCallback::selectOrQueueWrite() STUB
     void Comm::IoCallback::cancel(const char *) STUB
     void Comm::IoCallback::finish(Comm::Flag, int) STUB
     Comm::CbEntry *Comm::iocb_table = nullptr;
 void Comm::CallbackTableInit() STUB
 void Comm::CallbackTableDestruct() STUB
  
 #include "comm/Loops.h"
 void Comm::SelectLoopInit(void) STUB
 void Comm::SetSelect(int, unsigned int, PF *, void *, time_t) STUB
 Comm::Flag Comm::DoSelect(int) STUB_RETVAL(Comm::COMM_ERROR)
 void Comm::QuickPollRequired(void) STUB
  
 #include "comm/Read.h"
 void Comm::Read(const Comm::ConnectionPointer &, AsyncCall::Pointer &) STUB
 bool Comm::MonitorsRead(int) STUB_RETVAL(false)
 Comm::Flag Comm::ReadNow(CommIoCbParams &, SBuf &) STUB_RETVAL(Comm::COMM_ERROR)
 void Comm::ReadCancel(int, AsyncCall::Pointer &) STUB
 //void Comm::HandleRead(int, void*) STUB
  
 void comm_read_base(const Comm::ConnectionPointer &, char *, int, AsyncCall::Pointer &) STUB
 void comm_read_cancel(int, IOCB *, void *) STUB
  
 #include "comm/TcpAcceptor.h"
 //Comm::TcpAcceptor(const Comm::ConnectionPointer &, const char *, const Subscription::Pointer &) STUB
 void Comm::TcpAcceptor::subscribe(const Subscription::Pointer &) STUB
 void Comm::TcpAcceptor::unsubscribe(const char *) STUB
 void Comm::TcpAcceptor::acceptNext() STUB
 void Comm::TcpAcceptor::notify(const Comm::Flag, const Comm::ConnectionPointer &) const STUB
  
 #include "comm/Tcp.h"
 void Comm::ApplyTcpKeepAlive(int, const TcpKeepAlive &) STUB
  
 #include "comm/Write.h"
 void Comm::Write(const Comm::ConnectionPointer &, const char *, int, AsyncCall::Pointer &, FREE *) STUB
 void Comm::Write(const Comm::ConnectionPointer &, MemBuf *, AsyncCall::Pointer &) STUB
 void Comm::WriteCancel(const Comm::ConnectionPointer &, const char *) STUB
 /*PF*/ void Comm::HandleWrite(int, void*) STUB
  
 std::ostream &Comm::operator <<(std::ostream &os, const Connection &) STUB_RETVAL(os << "[Connection object]")
  

Comm::Read

void Read(const Comm::ConnectionPointer &conn, AsyncCall::Pointer &callback)

Definition: Read.cc:40

Write.h

AsyncJob

Definition: AsyncJob.h:31

Comm::AcceptLimiter

Definition: AcceptLimiter.h:29

AsyncJob.h

FREE

void FREE(void *)

Definition: forward.h:37

Comm::MonitorsRead

bool MonitorsRead(int fd)

whether the FD socket is being monitored for read

Definition: Read.cc:29

STUB_RETVAL

#define STUB_RETVAL(x)

Definition: STUB.h:42

Comm::ReadNow

Comm::Flag ReadNow(CommIoCbParams &params, SBuf &buf)

Definition: Read.cc:81

Comm::WriteCancel

void WriteCancel(const Comm::ConnectionPointer &conn, const char *reason)

Cancel the write pending on FD. No action if none pending.

CachePeer

Definition: CachePeer.h:28

Comm::DoSelect

Comm::Flag DoSelect(int)

Do poll and trigger callback functions as appropriate.

Definition: ModDevPoll.cc:308

SBuf

Definition: SBuf.h:93

Comm

Abstraction layer for TCP, UDP, TLS, UDS and filedescriptor sockets.

Definition: AcceptLimiter.h:16

InstanceIdDefinitions

#define InstanceIdDefinitions(...)

convenience macro to instantiate Class-specific stuff in .cc files

Definition: InstanceId.h:90

Comm::IoCallback::setCallback

void setCallback(iocb_type type, AsyncCall::Pointer &cb, char *buf, FREE *func, int sz)

Definition: IoCallback.cc:55

Comm::IsConnOpen

bool IsConnOpen(const Comm::ConnectionPointer &conn)

Definition: Connection.cc:27

ScopedId

Definition: InstanceId.h:18

Comm::operator<<

std::ostream & operator<<(std::ostream &, const Connection &)

Definition: Connection.cc:192

Comm::ConnOpener::doneAll

bool doneAll() const override

whether positive goal has been reached

Definition: ConnOpener.cc:59

Comm::ReadCancel

void ReadCancel(int fd, AsyncCall::Pointer &callback)

Cancel the read pending on FD. No action if none pending.

Definition: Read.cc:219

Comm::TcpAcceptor::acceptNext

void acceptNext()

Definition: TcpAcceptor.cc:312

Comm::Connection::Connection

Connection()

Definition: Connection.cc:32

MemBuf

Definition: MemBuf.h:23

CommIoCbParams

Definition: CommCalls.h:113

IOCB

void IOCB(const Comm::ConnectionPointer &conn, char *, size_t size, Comm::Flag flag, int xerrno, void *data)

Definition: CommCalls.h:34

Security::Connection

SSL Connection

Definition: Session.h:49

Comm::TcpAcceptor::unsubscribe

void unsubscribe(const char *reason)

Definition: TcpAcceptor.cc:68

Comm::ApplyTcpKeepAlive

void ApplyTcpKeepAlive(int fd, const TcpKeepAlive &)

apply configured TCP keep-alive settings to the given FD socket

Definition: Tcp.cc:51

Comm::COMM_ERROR

@ COMM_ERROR

Definition: Flag.h:17

Comm::iocb_type

iocb_type

Type of IO callbacks the Comm layer deals with.

Definition: IoCallback.h:22

Comm::IoCallback::selectOrQueueWrite

void selectOrQueueWrite()

called when fd needs to write but may need to wait in line for its quota

Definition: IoCallback.cc:69

STUB

#define STUB

macro to stub a void function.

Definition: STUB.h:34

Comm::Write

void Write(const Comm::ConnectionPointer &conn, const char *buf, int size, AsyncCall::Pointer &callback, FREE *free_func)

Definition: Write.cc:33

comm_read_base

void comm_read_base(const Comm::ConnectionPointer &conn, char *buf, int size, AsyncCall::Pointer &callback)

Definition: Read.cc:56

RefCount< Comm::Connection >

Comm::AcceptLimiter::Instance

static AcceptLimiter & Instance()

Definition: AcceptLimiter.cc:17

Comm::SelectLoopInit

void SelectLoopInit(void)

Initialize the module on Squid startup.

Definition: ModDevPoll.cc:170

Comm::Flag

Flag

Definition: Flag.h:15

Comm::ConnectionPointer

RefCount< Comm::Connection > ConnectionPointer

Definition: forward.h:26

CBDATA_NAMESPACED_CLASS_INIT

Comm::AcceptLimiter &Comm::AcceptLimiter::Instance() STUB_RETVAL(dummy) void Comm CBDATA_NAMESPACED_CLASS_INIT(Comm, ConnOpener)

dummy

Comm::AcceptLimiter dummy

Definition: stub_libcomm.cc:16

STUB.h

AcceptLimiter.h

Comm::SetSelect

void SetSelect(int, unsigned int, PF *, void *, time_t)

Mark an FD to be watched for its IO status.

Definition: ModDevPoll.cc:220

Read.h

Comm::CallbackTableDestruct

void CallbackTableDestruct()

Definition: IoCallback.cc:34

Comm::HandleWrite

PF HandleWrite

Definition: forward.h:33

comm_read_cancel

void comm_read_cancel(int fd, IOCB *callback, void *data)

Definition: Read.cc:181

squid.h

AsyncCall

Definition: AsyncCall.h:40

Comm::CallbackTableInit

void CallbackTableInit()

Definition: IoCallback.cc:22

Comm::TcpAcceptor::subscribe

void subscribe(const Subscription::Pointer &aSub)

Definition: TcpAcceptor.cc:60

Comm::iocb_table

CbEntry * iocb_table

Definition: IoCallback.cc:19

Comm::QuickPollRequired

void QuickPollRequired(void)

Definition: ModDevPoll.cc:414

void PF(int, void *)

Definition: forward.h:18

squid-cache.org

Optimising Web Delivery

Introduction

Documentation

Support

Miscellaneous