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 "event.h"
  23 #include "ms.h"
  24 #include "tube.h"
  25 #include "job.h"
  26
  27 #define STATE_WANTCOMMAND 0
  28 #define STATE_WANTDATA 1
  29 #define STATE_SENDJOB 2
  30 #define STATE_SENDWORD 3
  31 #define STATE_WAIT 4
  32
  33 /* A command can be at most LINE_BUF_SIZE chars, including "\r\n". This value
  34  * MUST be enough to hold the longest possible command or reply line, which is
  35  * currently "USING a{200}\r\n". */
  36 #define LINE_BUF_SIZE 208
  37
  38 #define OP_UNKNOWN 0
  39 #define OP_PUT 1
  40 #define OP_PEEKJOB 2
  41 #define OP_RESERVE 3
  42 #define OP_DELETE 4
  43 #define OP_RELEASE 5
  44 #define OP_BURY 6
  45 #define OP_KICK 7
  46 #define OP_STATS 8
  47 #define OP_JOBSTATS 9
  48 #define OP_PEEK 10
  49 #define OP_USE 11
  50 #define OP_WATCH 12
  51 #define OP_IGNORE 13
  52 #define OP_LIST_TUBES 14
  53 #define OP_LIST_TUBE_USED 15
  54 #define OP_LIST_TUBES_WATCHED 16
  55 #define OP_STATS_TUBE 17
  56
  57 /* CONN_TYPE_* are bit masks */
  58 #define CONN_TYPE_PRODUCER 1
  59 #define CONN_TYPE_WORKER 2
  60 #define CONN_TYPE_WAITING 4
  61
  62 #define conn_waiting(c) ((c)->type & CONN_TYPE_WAITING)
  63
  64 typedef struct conn *conn;
  65
  66 struct conn {
  67     conn prev, next; /* linked list of connections */
  68     int fd;
  69     char state;
  70     char type;
  71     struct event evq;
  72
  73     /* we cannot share this buffer with the reply line because we might read in
  74      * command line data for a subsequent command, and we need to store it
  75      * here. */
  76     char cmd[LINE_BUF_SIZE]; /* this string is NOT NUL-terminated */
  77     int cmd_len;
  78     int cmd_read;
  79     const char *reply;
  80     int reply_len;
  81     int reply_sent;
  82     char reply_buf[LINE_BUF_SIZE]; /* this string IS NUL-terminated */
  83     job in_job;
  84     int in_job_read;
  85     job out_job;
  86     int out_job_sent;
  87     struct job reserved_jobs; /* doubly-linked list header */
  88     tube use;
  89     struct ms watch;
  90 };
  91
  92 conn make_conn(int fd, char start_state, tube use, tube watch);
  93
  94 int conn_set_evq(conn c, const int events, evh handler);
  95 int conn_update_evq(conn c, const int flags);
  96
  97 void conn_close(conn c);
  98
  99 conn conn_remove(conn c);
 100 void conn_insert(conn head, conn c);
 101
 102 int count_cur_conns();
 103 unsigned int count_tot_conns();
 104 int count_cur_producers();
 105 int count_cur_workers();
 106
 107 void conn_set_producer(conn c);
 108 void conn_set_worker(conn c);
 109
 110 job soonest_job(conn c);
 111 int has_reserved_this_job(conn c, job j);
 112 int conn_has_close_deadline(conn c);
 113 int conn_ready(conn c);
 114
 115 #endif /*conn_h*/