Added functionality for handling global profiles.
[obnox/wireshark/wip.git] / epan / addr_resolv.h
index 90d80b760280d195a4cc803ac76742c680a75b5e..79b424232a4bf8b82ab227a413f7c2d6406cfcf2 100644 (file)
@@ -23,8 +23,8 @@
  * 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. 
+/* 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
@@ -47,7 +47,7 @@ extern "C" {
 /*
  * Flag controlling what names to resolve.
  */
-WS_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
@@ -102,18 +102,19 @@ extern gchar *get_sctp_port(guint port);
 /*  - 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 */
 
-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, 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);
 
 
 /*
@@ -123,19 +124,25 @@ void get_addr_name_buf(address *addr, gchar *buf, guint 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 GLIB timeouts in Wireshark,
-   and before processing each packet in TShark, if we're using ADNS */
+/** 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 const 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;
-extern 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
@@ -164,23 +171,40 @@ extern guint8 *get_ether_addr(const gchar *name);
 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);