blob: 5446786bebe370d8ae23b5e7a0e7ba760ee01363 [file] [log] [blame]
Willy Tarreaucff64112008-11-03 06:26:53 +01001/*
Willy Tarreau8e89b842009-10-18 23:56:35 +02002 * include/proto/stream_interface.h
3 * This file contains stream_interface function prototypes
4 *
Willy Tarreaub24281b2011-02-13 13:16:36 +01005 * Copyright (C) 2000-2011 Willy Tarreau - w@1wt.eu
Willy Tarreau8e89b842009-10-18 23:56:35 +02006 *
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 */
Willy Tarreaucff64112008-11-03 06:26:53 +010021
22#ifndef _PROTO_STREAM_INTERFACE_H
23#define _PROTO_STREAM_INTERFACE_H
24
25#include <stdlib.h>
26
27#include <common/config.h>
28#include <types/stream_interface.h>
29
30
31/* main event functions used to move data between sockets and buffers */
Willy Tarreau269358d2009-09-20 20:14:49 +020032int stream_int_check_timeouts(struct stream_interface *si);
Willy Tarreaucff64112008-11-03 06:26:53 +010033void stream_int_report_error(struct stream_interface *si);
Willy Tarreaudded32d2008-11-30 19:48:07 +010034void stream_int_retnclose(struct stream_interface *si, const struct chunk *msg);
Willy Tarreaucff64112008-11-03 06:26:53 +010035
Willy Tarreaufb90d942009-09-05 20:57:35 +020036/* functions used when running a stream interface as a task */
37void stream_int_update(struct stream_interface *si);
38void stream_int_update_embedded(struct stream_interface *si);
39void stream_int_shutr(struct stream_interface *si);
40void stream_int_shutw(struct stream_interface *si);
41void stream_int_chk_rcv(struct stream_interface *si);
42void stream_int_chk_snd(struct stream_interface *si);
43
Willy Tarreau5c979a92012-05-07 17:15:39 +020044extern struct sock_ops stream_int_embedded;
45extern struct sock_ops stream_int_task;
46
Willy Tarreaufb90d942009-09-05 20:57:35 +020047struct task *stream_int_register_handler(struct stream_interface *si,
Willy Tarreaub24281b2011-02-13 13:16:36 +010048 struct si_applet *app);
Willy Tarreaufb90d942009-09-05 20:57:35 +020049struct task *stream_int_register_handler_task(struct stream_interface *si,
50 struct task *(*fct)(struct task *));
51void stream_int_unregister_handler(struct stream_interface *si);
52
Willy Tarreau9e000c62011-03-10 14:03:36 +010053static inline void clear_target(struct target *dest)
54{
55 dest->type = TARG_TYPE_NONE;
56 dest->ptr.v = NULL;
57}
58
Willy Tarreau1539a012012-05-11 14:47:34 +020059static inline void set_target_client(struct target *dest)
60{
61 dest->type = TARG_TYPE_CLIENT;
62 dest->ptr.v = NULL;
63}
64
Willy Tarreau9e000c62011-03-10 14:03:36 +010065static inline void set_target_server(struct target *dest, struct server *s)
66{
67 dest->type = TARG_TYPE_SERVER;
68 dest->ptr.s = s;
69}
70
71static inline void set_target_proxy(struct target *dest, struct proxy *p)
72{
73 dest->type = TARG_TYPE_PROXY;
74 dest->ptr.p = p;
75}
76
77static inline void set_target_applet(struct target *dest, struct si_applet *a)
78{
79 dest->type = TARG_TYPE_APPLET;
80 dest->ptr.a = a;
81}
82
83static inline void set_target_task(struct target *dest, struct task *t)
84{
85 dest->type = TARG_TYPE_TASK;
86 dest->ptr.t = t;
87}
88
89static inline struct target *copy_target(struct target *dest, struct target *src)
90{
91 *dest = *src;
92 return dest;
93}
94
95static inline int target_match(struct target *a, struct target *b)
96{
97 return a->type == b->type && a->ptr.v == b->ptr.v;
98}
99
Willy Tarreau827aee92011-03-10 16:55:02 +0100100static inline struct server *target_srv(struct target *t)
101{
102 if (!t || t->type != TARG_TYPE_SERVER)
103 return NULL;
104 return t->ptr.s;
105}
106
Willy Tarreau5c979a92012-05-07 17:15:39 +0200107static inline void stream_interface_prepare(struct stream_interface *si, const struct sock_ops *ops)
108{
109 memcpy(&si->sock, ops, sizeof(si->sock));
110}
111
Willy Tarreau59b94792012-05-11 16:16:40 +0200112
113/* Retrieves the source address for the stream interface. */
114static inline void si_get_from_addr(struct stream_interface *si)
115{
116 if (si->flags & SI_FL_FROM_SET)
117 return;
118
119 if (!si->proto || !si->proto->get_src)
120 return;
121
122 if (si->proto->get_src(si->fd, (struct sockaddr *)&si->addr.from,
123 sizeof(si->addr.from),
124 si->target.type != TARG_TYPE_CLIENT) == -1)
125 return;
126 si->flags |= SI_FL_FROM_SET;
127}
128
129/* Retrieves the original destination address for the stream interface. */
130static inline void si_get_to_addr(struct stream_interface *si)
131{
132 if (si->flags & SI_FL_TO_SET)
133 return;
134
135 if (!si->proto || !si->proto->get_dst)
136 return;
137
138 if (si->proto->get_dst(si->fd, (struct sockaddr *)&si->addr.to,
139 sizeof(si->addr.to),
140 si->target.type != TARG_TYPE_CLIENT) == -1)
141 return;
142 si->flags |= SI_FL_TO_SET;
143}
144
145
Willy Tarreaucff64112008-11-03 06:26:53 +0100146#endif /* _PROTO_STREAM_INTERFACE_H */
147
148/*
149 * Local variables:
150 * c-indent-level: 8
151 * c-basic-offset: 8
152 * End:
153 */