*
* Laurent Deniel <laurent.deniel@free.fr>
*
- * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@ethereal.com>
+ * 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
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
+/* The buffers returned by these functions are all allocated with a
+ * packet lifetime and does not have have to be freed.
+ * However, take into account that when the packet dissection
+ * completes, these buffers will be automatically reclaimed/freed.
+ * If you need the buffer to remain for a longer scope than packet lifetime
+ * you must copy the content to an se_alloc() buffer.
+ */
#ifndef __RESOLV_H__
#define __RESOLV_H__
#include <epan/address.h>
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
#ifndef MAXNAMELEN
#define MAXNAMELEN 64 /* max name length (hostname and port name) */
#endif
/*
* Flag controlling what names to resolve.
*/
-ETH_VAR_IMPORT guint32 g_resolv_flags;
+WS_VAR_IMPORT guint32 gbl_resolv_flags;
/* 32 types are sufficient (as are 640k of RAM) */
/* FIXME: Maybe MANUF/m, IP/i, IP6/6, IPX/x, UDP+TCP/t etc would be
*/
extern gchar *get_tcp_port(guint port);
+/*
+ * get_dccp_port() returns the port name corresponding to that DCCP port,
+ * or the port number as a string if not found.
+ */
+extern gchar *get_dccp_port(guint port);
+
/*
* get_sctp_port() returns the port name corresponding to that SCTP port,
* or the port number as a string if not found.
/* - if the address is of a type that can be translated into a name, and the user */
/* has activated name resolution, the translated name */
/* - if the address is of type AT_NONE, a pointer to the string "NONE" */
-/* - if the address is of any other type, the result of address_to_str on the argument, */
+/* - if the address is of any other type, the result of ep_address_to_str on the argument, */
/* which should be a string representation for the answer -e.g. "10.10.10.10" for IPv4 */
/* address 10.10.10.10 */
-/* take into account that get_addr_name might eventually call address_to_str and return */
-/* its result; this means that the returned pointer is only guaranteed to point to a valid */
-/* string immediately after return, because address_to_str overwrites its previous results */
-/* and it must not be g_free'd */
-const gchar *get_addr_name(address *addr);
+const gchar *get_addr_name(const address *addr);
+const gchar *se_get_addr_name(const address *addr);
/* get_addr_name_buf solves an address in the same way as get_addr_name above */
-/* The difference is that get_addr_name_buf takes as input a buffer, in which it puts */
-/* the result, and a maximum string length -size-. the buffer should be large enough to */
-/* contain size characters plus the terminator */
+/* The difference is that get_addr_name_buf takes as input a buffer, into which it puts */
+/* the result which is always NUL ('\0') terminated. The buffer should be large enough to */
+/* contain size characters including the terminator */
-void get_addr_name_buf(address *addr, gchar *buf, guint size);
+void get_addr_name_buf(const address *addr, gchar *buf, gsize size);
/*
/* host_name_lookup_init fires up an ADNS socket if we're using ADNS */
extern void host_name_lookup_init(void);
-/* host_name_lookup_process does ADNS processing in GTK+ timeouts in Ethereal,
- and before processing each packet in Tethereal, if we're using ADNS */
-extern gint host_name_lookup_process(gpointer data);
+/** If we're using c-ares or ADNS, process outstanding host name lookups.
+ * This is called from a GLIB timeout in Wireshark and before processing
+ * each packet in TShark.
+ *
+ * @param data Ignored.
+ * @return True if any new objects have been resolved since the previous
+ * call. This can be used to trigger a display update, e.g. in Wireshark.
+ */
+extern gboolean host_name_lookup_process(gpointer data);
/* host_name_lookup_cleanup cleans up an ADNS socket if we're using ADNS */
extern void host_name_lookup_cleanup(void);
/* get_hostname returns the host name or "%d.%d.%d.%d" if not found */
-extern gchar *get_hostname(guint addr);
+extern const gchar *get_hostname(const guint addr);
/* get_hostname6 returns the host name, or numeric addr if not found */
struct e_in6_addr;
-const gchar* get_hostname6(struct e_in6_addr *ad);
+extern const gchar* get_hostname6(const struct e_in6_addr *ad);
/* get_ether_name returns the logical name if found in ethers files else
"<vendor>_%02x:%02x:%02x" if the vendor code is known else
/* get_manuf_name returns the vendor name or "%02x:%02x:%02x" if not known */
extern const gchar *get_manuf_name(const guint8 *addr);
+/* get_manuf_name returns the vendor name or NULL if not known */
+extern const gchar *get_manuf_name_if_known(const guint8 *addr);
+
/* get_ipxnet_name returns the logical name if found in an ipxnets file,
* or a string formatted with "%X" if not */
extern const gchar *get_ipxnet_name(const guint32 addr);
guint32 get_ipxnet_addr(const gchar *name, gboolean *known);
/* adds a hostname/IPv4 in the hash table */
-extern void add_ipv4_name(guint addr, const gchar *name);
+extern void add_ipv4_name(const guint addr, const gchar *name);
/* adds a hostname/IPv6 in the hash table */
-extern void add_ipv6_name(struct e_in6_addr *addr, const gchar *name);
+extern void add_ipv6_name(const struct e_in6_addr *addr, const gchar *name);
-/* add ethernet address / name corresponding to IP address */
-extern void add_ether_byip(guint ip, const guint8 *eth);
+/* adds a hostname in the hash table */
+extern gboolean add_ip_name_from_string (const char *addr, const char *name);
-/* Translates a string representing the hostname or dotted-decimal IP address
- * into a numeric IP address value, returning TRUE if it succeeds and
- * FALSE if it fails. */
+/* add ethernet address / name corresponding to IP address */
+extern void add_ether_byip(const guint ip, const guint8 *eth);
+
+/** Translates a string representing a hostname or dotted-decimal IPv4 address
+ * into a numeric IPv4 address value in network byte order. If compiled with
+ * c-ares, the request will wait a maximum of 250ms for the request to finish.
+ * Otherwise the wait time will be system-dependent, ususally much longer.
+ * Immediately returns FALSE for hostnames if network name resolution is
+ * disabled.
+ *
+ * @param[in] host The hostname.
+ * @param[out] addrp The numeric IPv4 address in network byte order.
+ * @return TRUE on success, FALSE on failure, timeout.
+ */
gboolean get_host_ipaddr(const char *host, guint32 *addrp);
-/*
- * Translate IPv6 numeric address or FQDN hostname, into binary IPv6 address.
- * Return TRUE if we succeed and set "*addrp" to that numeric IP address;
- * return FALSE if we fail.
+/** Translates a string representing a hostname or colon-hex IPv6 address
+ * into a numeric IPv6 address value in network byte order. If compiled with
+ * c-ares, the request will wait a maximum of 250ms for the request to finish.
+ * Otherwise the wait time will be system-dependent, usually much longer.
+ * Immediately returns FALSE for hostnames if network name resolution is
+ * disabled.
+ *
+ * @param[in] host The hostname.
+ * @param[out] addrp The numeric IPv6 address in network byte order.
+ * @return TRUE on success, FALSE on failure or timeout.
*/
gboolean get_host_ipaddr6(const char *host, struct e_in6_addr *addrp);
*/
const char* host_ip_af(const char *host);
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
#endif /* __RESOLV_H__ */
git.samba.org / obnox / wireshark / wip.git / blobdiff