src/fde.h

   1
   2 /*
   3  * $Id: fde.h,v 1.15 2008/02/12 23:22:13 rousskov Exp $
   4  *
   5  *
   6  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   7  * ----------------------------------------------------------
   8  *
   9  *  Squid is the result of efforts by numerous individuals from
  10  *  the Internet community; see the CONTRIBUTORS file for full
  11  *  details.   Many organizations have provided support for Squid's
  12  *  development; see the SPONSORS file for full details.  Squid is
  13  *  Copyrighted (C) 2001 by the Regents of the University of
  14  *  California; see the COPYRIGHT file for full details.  Squid
  15  *  incorporates software developed and/or copyrighted by other
  16  *  sources; see the CREDITS file for full details.
  17  *
  18  *  This program is free software; you can redistribute it and/or modify
  19  *  it under the terms of the GNU General Public License as published by
  20  *  the Free Software Foundation; either version 2 of the License, or
  21  *  (at your option) any later version.
  22  *
  23  *  This program is distributed in the hope that it will be useful,
  24  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  *  GNU General Public License for more details.
  27  *
  28  *  You should have received a copy of the GNU General Public License
  29  *  along with this program; if not, write to the Free Software
  30  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  31  *
  32  */
  33
  34 #ifndef SQUID_FDE_H
  35 #define SQUID_FDE_H
  36
  37 #include "comm.h"
  38 #include "IPAddress.h"
  39
  40 class PconnPool;
  41
  42 class fde
  43 {
  44
  45 public:
  46     fde() { clear(); };
  47     /** Clear the fde class properly back to NULL equivalent. */
  48     inline void clear() {
  49         memset(this, 0, sizeof(fde));
  50         local_addr.SetEmpty(); // IPAddress likes to be setup nicely.
  51     }
  52
  53     /* NOTE: memset is used on fdes today. 20030715 RBC */
  54     static void DumpStats (StoreEntry *);
  55
  56     char const *remoteAddr() const;
  57     void dumpStats (StoreEntry &, int);
  58     bool readPending(int);
  59     void noteUse(PconnPool *);
  60
  61     unsigned int type;
  62     u_short remote_port;
  63
  64     IPAddress local_addr;
  65     unsigned char tos;
  66     int sock_family;
  67     char ipaddr[MAX_IPSTRLEN];            /* dotted decimal address of peer */
  68     char desc[FD_DESC_SZ];
  69
  70     struct
  71     {
  72         unsigned int open:1;
  73         unsigned int close_request:1;
  74         unsigned int write_daemon:1;
  75         unsigned int closing:1;
  76         unsigned int socket_eof:1;
  77         unsigned int nolinger:1;
  78         unsigned int nonblocking:1;
  79         unsigned int ipc:1;
  80         unsigned int called_connect:1;
  81         unsigned int nodelay:1;
  82         unsigned int close_on_exec:1;
  83         unsigned int read_pending:1;
  84         unsigned int write_pending:1;
  85         unsigned int transparent:1;
  86     } flags;
  87
  88     int64_t bytes_read;
  89     int64_t bytes_written;
  90
  91     struct {
  92         int uses;                   /* ie # req's over persistent conn */
  93         PconnPool *pool;
  94     } pconn;
  95
  96     unsigned epoll_state;
  97
  98     struct _fde_disk disk;
  99     PF *read_handler;
 100     void *read_data;
 101     PF *write_handler;
 102     void *write_data;
 103     AsyncCall::Pointer timeoutHandler;
 104     time_t timeout;
 105     void *lifetime_data;
 106     AsyncCall::Pointer closeHandler;
 107     CommWriteStateData *wstate;         /* State data for comm_write */
 108     READ_HANDLER *read_method;
 109     WRITE_HANDLER *write_method;
 110 #if USE_SSL
 111     SSL *ssl;
 112 #endif
 113 #ifdef _SQUID_MSWIN_
 114     struct {
 115         long handle;
 116     } win32;
 117 #endif
 118 #if USE_ZPH_QOS
 119     unsigned char upstreamTOS;                  /* see FwdState::dispatch()  */
 120 #endif
 121
 122 };
 123
 124 #endif /* SQUID_FDE_H */