2013-11-22 11:40:18 -05:00
|
|
|
/*
|
|
|
|
|
* include/types/map.h
|
|
|
|
|
* This file provides structures and types for MAPs.
|
|
|
|
|
*
|
|
|
|
|
* Copyright (C) 2000-2012 Willy Tarreau - w@1wt.eu
|
|
|
|
|
*
|
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
|
|
|
* License as published by the Free Software Foundation, version 2.1
|
|
|
|
|
* exclusively.
|
|
|
|
|
*
|
|
|
|
|
* This library is distributed in the hope that it will be useful,
|
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
|
* Lesser General Public License for more details.
|
|
|
|
|
*
|
|
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
|
|
|
* License along with this library; if not, write to the Free Software
|
|
|
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef _TYPES_MAP_H
|
|
|
|
|
#define _TYPES_MAP_H
|
|
|
|
|
|
2014-02-11 05:31:40 -05:00
|
|
|
#include <types/pattern.h>
|
|
|
|
|
#include <types/sample.h>
|
2013-11-22 11:40:18 -05:00
|
|
|
|
|
|
|
|
struct map_descriptor {
|
MEDIUM: sample: add the "map" converter
Add a new converter with the following prototype :
map(<map_file>[,<default_value>])
map_<match_type>(<map_file>[,<default_value>])
map_<match_type>_<output_type>(<map_file>[,<default_value>])
It searches the for input value from <map_file> using the <match_type>
matching method, and return the associated value converted to the type
<output_type>. If the input value cannot be found in the <map_file>,
the converter returns the <default_value>. If the <default_value> is
not set, the converter fails and acts as if no input value could be
fetched. If the <match_type> is not set, it defaults to "str".
Likewise, if the <output_type> is not set, it defaults to "str". For
convenience, the "map" keyword is an alias for "map_str" and maps a
string to another string. The following array contains contains the
list of all the map* converters.
+----+----------+---------+-------------+------------+
| `-_ out | | | |
| input `-_ | str | int | ip |
| / match `-_ | | | |
+---------------+---------+-------------+------------+
| str / str | map_str | map_str_int | map_str_ip |
| str / sub | map_sub | map_sub_int | map_sub_ip |
| str / dir | map_dir | map_dir_int | map_dir_ip |
| str / dom | map_dom | map_dom_int | map_dom_ip |
| str / end | map_end | map_end_int | map_end_ip |
| str / reg | map_reg | map_reg_int | map_reg_ip |
| int / int | map_int | map_int_int | map_int_ip |
| ip / ip | map_ip | map_ip_int | map_ip_ip |
+---------------+---------+-------------+------------+
The names are intentionally chosen to reflect the same match methods
as ACLs use.
2013-11-26 05:52:33 -05:00
|
|
|
struct sample_conv *conv; /* original converter descriptor */
|
2014-02-11 05:31:40 -05:00
|
|
|
struct pattern_head pat; /* the pattern matching associated to the map */
|
2013-12-05 08:40:25 -05:00
|
|
|
int do_free; /* set if <pat> is the orignal pat and must be freed */
|
2013-11-22 11:40:18 -05:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
#endif /* _TYPES_MAP_H */
|