wireshark/epan/geoip_db.h

95 lines
2.7 KiB
C

/* geoip_db.h
* GeoIP database support
*
* $Id$
*
* Copyright 2008, Gerald Combs <gerald@wireshark.org>
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef __GEOIP_DB_H__
#define __GEOIP_DB_H__
#include <epan/ipv6-utils.h>
#include <epan/prefs.h>
/* Fake databases to make lat/lon values available */
/* XXX - find a better way to interface */
#define WS_LAT_FAKE_EDITION (NUM_DB_TYPES+1)
#define WS_LON_FAKE_EDITION (NUM_DB_TYPES+2)
/**
* Init function called from epan.h
*/
extern void geoip_db_pref_init(module_t *nameres);
/**
* Number of databases we have loaded
*
* @return The number GeoIP databases successfully loaded
*/
extern guint geoip_db_num_dbs(void);
/**
* Fetch the name of a database
*
* @param dbnum Database index
* @return The database name or "Invalid database"
*/
extern const gchar *geoip_db_name(guint dbnum);
/**
* Fetch the database type. Types are enumerated in GeoIPDBTypes in GeoIP.h.
*
* @param dbnum Database index
* @return The database type or -1
*/
extern int geoip_db_type(guint dbnum);
/**
* Look up an IPv4 address in a database
*
* @param dbnum Database index
* @param addr IPv4 address to look up
* @param not_found The string to return if the lookup fails. May be NULL.
* @return The database entry if found, else not_found
*/
extern const char *geoip_db_lookup_ipv4(guint dbnum, guint32 addr, const char *not_found);
/**
* Look up an IPv6 address in a database
*
* @param dbnum Database index
* @param addr IPv6 address to look up
* @param not_found The string to return if the lookup fails. May be NULL.
* @return The database entry if found, else not_found
*/
extern const char *geoip_db_lookup_ipv6(guint dbnum, struct e_in6_addr addr, const char *not_found);
/**
* Get all configured paths
*
* @return String with all paths separated by a path separator
*/
extern gchar *geoip_db_get_paths(void);
#endif /* __GEOIP_DB_H__ */