Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 1 | /* |
| 2 | include/types/stream_interface.h |
| 3 | This file describes the stream_interface struct and associated constants. |
| 4 | |
| 5 | Copyright (C) 2000-2008 Willy Tarreau - w@1wt.eu |
| 6 | |
| 7 | This library is free software; you can redistribute it and/or |
| 8 | modify it under the terms of the GNU Lesser General Public |
| 9 | License as published by the Free Software Foundation, version 2.1 |
| 10 | exclusively. |
| 11 | |
| 12 | This library is distributed in the hope that it will be useful, |
| 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 15 | Lesser General Public License for more details. |
| 16 | |
| 17 | You should have received a copy of the GNU Lesser General Public |
| 18 | License along with this library; if not, write to the Free Software |
| 19 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 20 | */ |
| 21 | |
| 22 | #ifndef _TYPES_STREAM_INTERFACE_H |
| 23 | #define _TYPES_STREAM_INTERFACE_H |
| 24 | |
| 25 | #include <stdlib.h> |
| 26 | |
Willy Tarreau | 48adac5 | 2008-08-30 04:58:38 +0200 | [diff] [blame] | 27 | #include <types/buffers.h> |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 28 | #include <common/config.h> |
| 29 | |
| 30 | /* A stream interface must have its own errors independantly of the buffer's, |
| 31 | * so that applications can rely on what the buffer reports while the stream |
Willy Tarreau | 74ab2ac | 2008-11-23 17:23:07 +0100 | [diff] [blame] | 32 | * interface is performing some retries (eg: connection error). Some states are |
| 33 | * transient and do not last beyond process_session(). |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 34 | */ |
| 35 | enum { |
Willy Tarreau | efb453c | 2008-10-26 20:49:47 +0100 | [diff] [blame] | 36 | SI_ST_INI = 0, /* interface not sollicitated yet */ |
Willy Tarreau | 74ab2ac | 2008-11-23 17:23:07 +0100 | [diff] [blame] | 37 | SI_ST_REQ, /* [transient] connection initiation desired and not started yet */ |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 38 | SI_ST_QUE, /* interface waiting in queue */ |
| 39 | SI_ST_TAR, /* interface in turn-around state after failed connect attempt */ |
| 40 | SI_ST_ASS, /* server just assigned to this interface */ |
| 41 | SI_ST_CON, /* initiated connection request (resource exists) */ |
Willy Tarreau | 74ab2ac | 2008-11-23 17:23:07 +0100 | [diff] [blame] | 42 | SI_ST_CER, /* [transient] previous connection attempt failed (resource released) */ |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 43 | SI_ST_EST, /* connection established (resource exists) */ |
Willy Tarreau | 74ab2ac | 2008-11-23 17:23:07 +0100 | [diff] [blame] | 44 | SI_ST_DIS, /* [transient] disconnected from other side, but cleanup not done yet */ |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 45 | SI_ST_CLO, /* stream intf closed, might not existing anymore. Buffers shut. */ |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 46 | }; |
| 47 | |
| 48 | /* error types reported on the streams interface for more accurate reporting */ |
| 49 | enum { |
Willy Tarreau | e5ed406 | 2008-08-30 03:17:31 +0200 | [diff] [blame] | 50 | SI_ET_NONE = 0x0000, /* no error yet, leave it to zero */ |
| 51 | SI_ET_QUEUE_TO = 0x0001, /* queue timeout */ |
| 52 | SI_ET_QUEUE_ERR = 0x0002, /* queue error (eg: full) */ |
| 53 | SI_ET_QUEUE_ABRT = 0x0004, /* aborted in queue by external cause */ |
| 54 | SI_ET_CONN_TO = 0x0008, /* connection timeout */ |
| 55 | SI_ET_CONN_ERR = 0x0010, /* connection error (eg: no server available) */ |
| 56 | SI_ET_CONN_ABRT = 0x0020, /* connection aborted by external cause (eg: abort) */ |
| 57 | SI_ET_CONN_OTHER = 0x0040, /* connection aborted for other reason (eg: 500) */ |
| 58 | SI_ET_DATA_TO = 0x0080, /* timeout during data phase */ |
| 59 | SI_ET_DATA_ERR = 0x0100, /* error during data phase */ |
| 60 | SI_ET_DATA_ABRT = 0x0200, /* data phase aborted by external cause */ |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 61 | }; |
| 62 | |
Willy Tarreau | d7704b5 | 2008-09-04 11:51:16 +0200 | [diff] [blame] | 63 | /* flags set after I/O */ |
| 64 | enum { |
| 65 | SI_FL_NONE = 0x0000, /* nothing */ |
| 66 | SI_FL_EXP = 0x0001, /* timeout has expired */ |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 67 | SI_FL_ERR = 0x0002, /* a non-recoverable error has occurred */ |
Willy Tarreau | d7704b5 | 2008-09-04 11:51:16 +0200 | [diff] [blame] | 68 | }; |
| 69 | |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 70 | struct stream_interface { |
| 71 | unsigned int state; /* SI_ST* */ |
Willy Tarreau | e5ed406 | 2008-08-30 03:17:31 +0200 | [diff] [blame] | 72 | unsigned int prev_state;/* SI_ST*, copy of previous state */ |
| 73 | void *owner; /* generally a (struct task*) */ |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 74 | int fd; /* file descriptor for a stream driver when known */ |
Willy Tarreau | d7704b5 | 2008-09-04 11:51:16 +0200 | [diff] [blame] | 75 | unsigned int flags; /* SI_FL_*, must be cleared before I/O */ |
Willy Tarreau | 3537467 | 2008-09-03 18:11:02 +0200 | [diff] [blame] | 76 | unsigned int exp; /* wake up time for connect, queue, turn-around, ... */ |
Willy Tarreau | 0a5d5dd | 2008-11-23 19:31:35 +0100 | [diff] [blame] | 77 | void (*shutr)(struct stream_interface *); /* shutr function */ |
| 78 | void (*shutw)(struct stream_interface *); /* shutw function */ |
Willy Tarreau | 48adac5 | 2008-08-30 04:58:38 +0200 | [diff] [blame] | 79 | struct buffer *ib, *ob; /* input and output buffers */ |
Willy Tarreau | e5ed406 | 2008-08-30 03:17:31 +0200 | [diff] [blame] | 80 | unsigned int err_type; /* first error detected, one of SI_ET_* */ |
| 81 | void *err_loc; /* commonly the server, NULL when SI_ET_NONE */ |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 82 | }; |
| 83 | |
| 84 | |
| 85 | #endif /* _TYPES_STREAM_INTERFACE_H */ |
| 86 | |
| 87 | /* |
| 88 | * Local variables: |
| 89 | * c-indent-level: 8 |
| 90 | * c-basic-offset: 8 |
| 91 | * End: |
| 92 | */ |