summaryrefslogtreecommitdiff
path: root/pjlib/include/pj/ip_helper.h
diff options
context:
space:
mode:
authorBenny Prijono <bennylp@teluu.com>2007-03-25 18:44:51 +0000
committerBenny Prijono <bennylp@teluu.com>2007-03-25 18:44:51 +0000
commit84b0defcf6903a8b014ab1ba38d8923282f230ed (patch)
tree4f6ba42e6908ed6803e7793b61c350676e165697 /pjlib/include/pj/ip_helper.h
parentcd2cbf5e5a3a0393054a4bbd60ee03576f3fa504 (diff)
ICE (work in progress): use single socket for all candidates in component, and implemented IP interface enumeration on Win32
git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@1104 74dad513-b988-da41-8d7b-12977e46ad98
Diffstat (limited to 'pjlib/include/pj/ip_helper.h')
-rw-r--r--pjlib/include/pj/ip_helper.h88
1 files changed, 88 insertions, 0 deletions
diff --git a/pjlib/include/pj/ip_helper.h b/pjlib/include/pj/ip_helper.h
new file mode 100644
index 00000000..9515d978
--- /dev/null
+++ b/pjlib/include/pj/ip_helper.h
@@ -0,0 +1,88 @@
+/* $Id$ */
+/*
+ * Copyright (C)2003-2007 Benny Prijono <benny@prijono.org>
+ *
+ * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+#ifndef __PJ_IP_ROUTE_H__
+#define __PJ_IP_ROUTE_H__
+
+/**
+ * @file ip_helper.h
+ * @brief IP helper API
+ */
+
+#include <pj/sock.h>
+
+PJ_BEGIN_DECL
+
+/**
+ * @defgroup pj_ip_helper IP Interface and Routing Helper
+ * @ingroup PJ_IO
+ * @{
+ *
+ * This module provides functions to query local host's IP interface and
+ * routing table.
+ */
+
+/**
+ * This structure describes IP routing entry.
+ */
+typedef union pj_ip_route_entry
+{
+ /** IP routing entry for IP version 4 routing */
+ struct
+ {
+ pj_in_addr if_addr; /**< Local interface IP address. */
+ pj_in_addr dst_addr; /**< Destination IP address. */
+ pj_in_addr mask; /**< Destination mask. */
+ } ipv4;
+} pj_ip_route_entry;
+
+
+/**
+ * Enumerate the local IP interface currently active in the host.
+ *
+ * @param count On input, specify the number of entries. On output,
+ * it will be filled with the actual number of entries.
+ * @param ifs Array of IP addresses.
+ *
+ * @return PJ_SUCCESS on success, or the appropriate error code.
+ */
+PJ_DECL(pj_status_t) pj_enum_ip_interface(unsigned *count,
+ pj_in_addr ifs[]);
+
+
+/**
+ * Enumerate the IP routing table for this host.
+ *
+ * @param count On input, specify the number of routes entries. On output,
+ * it will be filled with the actual number of route entries.
+ * @param routes Array of IP routing entries.
+ *
+ * @return PJ_SUCCESS on success, or the appropriate error code.
+ */
+PJ_DECL(pj_status_t) pj_enum_ip_route(unsigned *count,
+ pj_ip_route_entry routes[]);
+
+
+
+/** @} */
+
+PJ_END_DECL
+
+
+#endif /* __PJ_IP_ROUTE_H__ */
+