conn.h

   1 /* conn.h - network connection state */
   2
   3 /* Copyright (C) 2007 Keith Rarick and Philotic Inc.
   4
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef conn_h
  20 #define conn_h
  21
  22 #include <sys/types.h>
  23 #include <event.h>
  24 #include "ms.h"
  25 #include "tube.h"
  26 #include "job.h"
  27
  28 /* A command can be at most LINE_BUF_SIZE chars, including "\r\n". This value
  29  * MUST be enough to hold the longest possible command or reply line, which is
  30  * currently "USING a{200}\r\n". */
  31 #define LINE_BUF_SIZE 208
  32
  33 /* CONN_TYPE_* are bit masks */
  34 #define CONN_TYPE_PRODUCER 1
  35 #define CONN_TYPE_WORKER 2
  36 #define CONN_TYPE_WAITING 4
  37
  38 #define conn_waiting(c) ((c)->type & CONN_TYPE_WAITING)
  39
  40 typedef struct conn *conn;
  41
  42 struct conn {
  43     conn prev, next; /* linked list of connections */
  44     int fd;
  45     char state;
  46     char type;
  47     struct event evq;
  48     int pending_timeout;
  49
  50     /* we cannot share this buffer with the reply line because we might read in
  51      * command line data for a subsequent command, and we need to store it
  52      * here. */
  53     char cmd[LINE_BUF_SIZE]; /* this string is NOT NUL-terminated */
  54     int cmd_len;
  55     int cmd_read;
  56     const char *reply;
  57     int reply_len;
  58     int reply_sent;
  59     char reply_buf[LINE_BUF_SIZE]; /* this string IS NUL-terminated */
  60
  61     /* A job to be read from the client. */
  62     job in_job;
  63
  64     /* Memoization of the soonest job */
  65     job soonest_job;
  66
  67     /* How many bytes of in_job->body have been read so far. If in_job is NULL
  68      * while in_job_read is nonzero, we are in bit bucket mode and
  69      * in_job_read's meaning is inverted -- then it counts the bytes that
  70      * remain to be thrown away. */
  71     int in_job_read;
  72
  73     job out_job;
  74     int out_job_sent;
  75     struct job reserved_jobs; /* doubly-linked list header */
  76     tube use;
  77     struct ms watch;
  78 };
  79
  80 conn make_conn(int fd, char start_state, tube use, tube watch);
  81
  82 int conn_set_evq(conn c, const int events, evh handler);
  83 int conn_update_evq(conn c, const int flags);
  84
  85 void conn_close(conn c);
  86
  87 conn conn_remove(conn c);
  88 void conn_insert(conn head, conn c);
  89
  90 int count_cur_conns();
  91 unsigned int count_tot_conns();
  92 int count_cur_producers();
  93 int count_cur_workers();
  94
  95 void conn_set_producer(conn c);
  96 void conn_set_worker(conn c);
  97
  98 job soonest_job(conn c);
  99 int has_reserved_this_job(conn c, job j);
 100 int conn_has_close_deadline(conn c);
 101 int conn_ready(conn c);
 102
 103 #endif /*conn_h*/