Add docs for mgos_pppos_dev_get_ip_info()

PUBLISHED_FROM=132e2bd2c1ad50fa785c808d8db5cb69e5f3c6fd
mongoose-os-libs · Jan 15, 2018 · cec7cbf · cec7cbf
1 parent a9352e9
commit cec7cbf
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 22 deletions.
diff --git a/include/mgos_pppos.h b/include/mgos_pppos.h
diff --git a/src/mgos_pppos.h b/src/mgos_pppos.h
@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2014-2018 Cesanta Software Limited
+ * All rights reserved
+ */
+
+#ifndef CS_MOS_LIBS_PPPOS_SRC_MGOS_PPPOS_H_
+#define CS_MOS_LIBS_PPPOS_SRC_MGOS_PPPOS_H_
+
+#include "mgos_net.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+/*
+ * Retrieve IP configuration of the provided instance number (which should be
+ * of type `MGOS_NET_IF_TYPE_PPP`), and fill provided `ip_info` with it. Returns
+ * `true` in case of success, false otherwise.
+ */
+bool mgos_pppos_dev_get_ip_info(int if_instance,
+                                struct mgos_net_ip_info *ip_info);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif /* CS_MOS_LIBS_PPPOS_SRC_MGOS_PPPOS_H_ */