Skip to content

Commit 98a506f

Browse files
glarsennordiccarlescufi
glarsennordic
authored and
carlescufi
committed
net: conn_mgr: Write documentation
Write documentation for conn_mgr and its subsystems, especially guidelines for writing connectivity implementations Signed-off-by: Georges Oates_Larsen <[email protected]>
1 parent fe61d65 commit 98a506f

16 files changed

+1316
-33
lines changed

‎doc/connectivity/networking/api/net_if.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ pointer or by a network interface index. The network interface can be
3131
resolved from its index by calling ``net_if_get_by_index()`` and from interface
3232
pointer by calling ``net_if_get_by_iface()``.
3333

34+
.. _net_if_interface_ip_management:
35+
3436
The IP address for network devices must be set for them to be connectable.
3537
In a typical dynamic network environment, IP addresses are set automatically
3638
by DHCPv4, for example. If needed though, the application can set a device's
@@ -55,6 +57,8 @@ network technology supports promiscuous mode, then it is possible to receive
5557
all the network packets that the network device driver is able to receive.
5658
See :ref:`promiscuous_interface` API for more details.
5759

60+
.. _net_if_interface_state_management:
61+
5862
Network interface state management
5963
**********************************
6064

‎doc/connectivity/networking/api/net_mgmt.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ To avoid extra cost, all :c:func:`net_mgmt` calls are direct. Though this
4242
may change in a future release, it will not affect the users of this
4343
function.
4444

45+
.. _net_mgmt_listening:
46+
4547
Listening to network events
4648
***************************
4749

‎doc/connectivity/networking/conn_mgr/figures/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Ignore drawio backup files
2+
.$*

‎doc/connectivity/networking/conn_mgr/figures/integration_diagram_detailed.drawio

Lines changed: 205 additions & 0 deletions
Large diffs are not rendered by default.

‎doc/connectivity/networking/conn_mgr/figures/integration_diagram_detailed.svg

Lines changed: 3 additions & 0 deletions
Loading

‎doc/connectivity/networking/conn_mgr/figures/integration_diagram_simplified.drawio

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
<mxfile host="Electron" modified="2023-08-28T23:41:19.284Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/21.6.8 Chrome/114.0.5735.289 Electron/25.5.0 Safari/537.36" etag="LLGj6geb5OPwGWt5pcNY" version="21.6.8" type="device">
2+
<diagram id="W1R5wPltpbE_ZV7s-k6x" name="Page-1">
3+
<mxGraphModel dx="1050" dy="1027" grid="0" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="0" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
4+
<root>
5+
<mxCell id="0" />
6+
<mxCell id="1" parent="0" />
7+
<mxCell id="Db8zi3n4dXzB52SZQf6J-169" value="" style="rounded=0;whiteSpace=wrap;html=1;dashed=1;fontSize=16;fillColor=none;movable=1;resizable=1;rotatable=1;deletable=1;editable=1;locked=0;connectable=1;strokeColor=default;" parent="1" vertex="1">
8+
<mxGeometry x="527" y="-207" width="195" height="261" as="geometry" />
9+
</mxCell>
10+
<mxCell id="Db8zi3n4dXzB52SZQf6J-10" value="&lt;div&gt;network&lt;/div&gt;&lt;div&gt;readiness&lt;/div&gt;&lt;div&gt;events&lt;/div&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
11+
<mxGeometry x="574" y="-81" width="164" height="30" as="geometry" />
12+
</mxCell>
13+
<mxCell id="Db8zi3n4dXzB52SZQf6J-11" value="&lt;div&gt;Application&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" parent="1" vertex="1">
14+
<mxGeometry x="271" y="-122" width="116" height="348" as="geometry" />
15+
</mxCell>
16+
<mxCell id="Db8zi3n4dXzB52SZQf6J-61" value="L2" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
17+
<mxGeometry x="714" y="173" width="108" height="51" as="geometry" />
18+
</mxCell>
19+
<mxCell id="Db8zi3n4dXzB52SZQf6J-71" value="&lt;div&gt;connectivity&lt;/div&gt;&lt;div&gt;commands&lt;br&gt;&lt;/div&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
20+
<mxGeometry x="584" y="22" width="164" height="30" as="geometry" />
21+
</mxCell>
22+
<mxCell id="Db8zi3n4dXzB52SZQf6J-89" value="&lt;div&gt;iface commands&lt;/div&gt;&lt;div&gt;and events&lt;/div&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
23+
<mxGeometry x="596" y="128" width="164" height="30" as="geometry" />
24+
</mxCell>
25+
<mxCell id="Db8zi3n4dXzB52SZQf6J-113" value="&lt;div&gt;iface commands&lt;/div&gt;&lt;div&gt;and events&lt;/div&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
26+
<mxGeometry x="397" y="208" width="164" height="30" as="geometry" />
27+
</mxCell>
28+
<mxCell id="Db8zi3n4dXzB52SZQf6J-155" style="edgeStyle=orthogonalEdgeStyle;rounded=0;comic=0;sketch=0;jumpStyle=none;jumpSize=23;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;strokeColor=default;fontSize=16;startArrow=none;startFill=0;endArrow=classic;endFill=1;fillColor=#CCE5FF;elbow=vertical;" parent="1" source="Db8zi3n4dXzB52SZQf6J-122" target="Db8zi3n4dXzB52SZQf6J-150" edge="1">
29+
<mxGeometry relative="1" as="geometry" />
30+
</mxCell>
31+
<mxCell id="Db8zi3n4dXzB52SZQf6J-122" value="Connectivity Control" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" parent="1" vertex="1">
32+
<mxGeometry x="552" y="-35" width="147" height="50" as="geometry" />
33+
</mxCell>
34+
<mxCell id="Db8zi3n4dXzB52SZQf6J-129" style="edgeStyle=orthogonalEdgeStyle;rounded=0;comic=0;sketch=0;jumpStyle=sharp;jumpSize=23;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.484;entryY=-0.006;entryDx=0;entryDy=0;strokeColor=default;startArrow=none;startFill=0;endArrow=classic;endFill=1;fillColor=default;elbow=vertical;entryPerimeter=0;" parent="1" source="Db8zi3n4dXzB52SZQf6J-124" target="Db8zi3n4dXzB52SZQf6J-122" edge="1">
35+
<mxGeometry relative="1" as="geometry" />
36+
</mxCell>
37+
<mxCell id="Db8zi3n4dXzB52SZQf6J-124" value="Connectivity Monitoring" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" parent="1" vertex="1">
38+
<mxGeometry x="549" y="-148" width="147" height="50" as="geometry" />
39+
</mxCell>
40+
<mxCell id="Db8zi3n4dXzB52SZQf6J-135" value="&lt;div&gt;network&lt;/div&gt;&lt;div&gt;commands&lt;br&gt;&lt;/div&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
41+
<mxGeometry x="341" y="-8" width="164" height="30" as="geometry" />
42+
</mxCell>
43+
<mxCell id="Db8zi3n4dXzB52SZQf6J-136" style="edgeStyle=orthogonalEdgeStyle;rounded=0;comic=0;sketch=0;jumpStyle=none;jumpSize=23;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;strokeColor=default;startArrow=none;startFill=0;endArrow=classic;endFill=1;fillColor=#CCE5FF;elbow=vertical;noJump=0;" parent="1" source="Db8zi3n4dXzB52SZQf6J-124" edge="1">
44+
<mxGeometry relative="1" as="geometry">
45+
<mxPoint x="386" y="-59" as="targetPoint" />
46+
<Array as="points">
47+
<mxPoint x="622" y="-59" />
48+
<mxPoint x="401" y="-59" />
49+
</Array>
50+
</mxGeometry>
51+
</mxCell>
52+
<mxCell id="Db8zi3n4dXzB52SZQf6J-139" value="&lt;font style=&quot;font-size: 16px;&quot;&gt;Connection Manager&lt;br&gt;&lt;/font&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;dashed=1;" parent="1" vertex="1">
53+
<mxGeometry x="543" y="-198" width="171" height="30" as="geometry" />
54+
</mxCell>
55+
<mxCell id="Db8zi3n4dXzB52SZQf6J-141" style="edgeStyle=orthogonalEdgeStyle;rounded=0;comic=0;sketch=0;jumpStyle=none;jumpSize=23;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.004;exitY=0.631;exitDx=0;exitDy=0;entryX=1.017;entryY=0.937;entryDx=0;entryDy=0;entryPerimeter=0;strokeColor=default;fontSize=16;startArrow=classic;startFill=1;endArrow=classic;endFill=1;fillColor=#CCE5FF;elbow=vertical;exitPerimeter=0;" parent="1" source="Db8zi3n4dXzB52SZQf6J-144" target="Db8zi3n4dXzB52SZQf6J-11" edge="1">
56+
<mxGeometry relative="1" as="geometry">
57+
<mxPoint x="547" y="191.75" as="sourcePoint" />
58+
</mxGeometry>
59+
</mxCell>
60+
<mxCell id="Db8zi3n4dXzB52SZQf6J-166" style="edgeStyle=orthogonalEdgeStyle;rounded=0;comic=0;sketch=0;jumpStyle=none;jumpSize=23;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.25;exitDx=0;exitDy=0;entryX=0;entryY=0.25;entryDx=0;entryDy=0;strokeColor=default;fontSize=16;startArrow=none;startFill=0;endArrow=classic;endFill=1;fillColor=#CCE5FF;elbow=vertical;" parent="1" source="Db8zi3n4dXzB52SZQf6J-144" target="Db8zi3n4dXzB52SZQf6J-124" edge="1">
61+
<mxGeometry relative="1" as="geometry">
62+
<Array as="points">
63+
<mxPoint x="468" y="186" />
64+
<mxPoint x="468" y="-135" />
65+
</Array>
66+
</mxGeometry>
67+
</mxCell>
68+
<mxCell id="Db8zi3n4dXzB52SZQf6J-144" value="&lt;div&gt;Zephyr ifaces&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" parent="1" vertex="1">
69+
<mxGeometry x="552" y="173" width="147" height="50" as="geometry" />
70+
</mxCell>
71+
<mxCell id="Db8zi3n4dXzB52SZQf6J-158" style="edgeStyle=orthogonalEdgeStyle;rounded=0;comic=0;sketch=0;jumpStyle=none;jumpSize=23;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;strokeColor=default;fontSize=16;startArrow=classic;startFill=1;endArrow=classic;endFill=1;fillColor=#CCE5FF;elbow=vertical;" parent="1" source="Db8zi3n4dXzB52SZQf6J-150" target="Db8zi3n4dXzB52SZQf6J-144" edge="1">
72+
<mxGeometry relative="1" as="geometry" />
73+
</mxCell>
74+
<mxCell id="Db8zi3n4dXzB52SZQf6J-161" style="edgeStyle=orthogonalEdgeStyle;rounded=0;comic=0;sketch=0;jumpStyle=none;jumpSize=23;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.999;exitY=0.676;exitDx=0;exitDy=0;strokeColor=default;fontSize=16;startArrow=classic;startFill=1;endArrow=classic;endFill=1;fillColor=#CCE5FF;elbow=vertical;exitPerimeter=0;" parent="1" source="Db8zi3n4dXzB52SZQf6J-150" target="Db8zi3n4dXzB52SZQf6J-61" edge="1">
75+
<mxGeometry relative="1" as="geometry">
76+
<Array as="points">
77+
<mxPoint x="700" y="103" />
78+
<mxPoint x="768" y="102" />
79+
</Array>
80+
</mxGeometry>
81+
</mxCell>
82+
<mxCell id="Db8zi3n4dXzB52SZQf6J-150" value="Connectivity Implementations" style="rounded=0;whiteSpace=wrap;html=1;labelBackgroundColor=none;" parent="1" vertex="1">
83+
<mxGeometry x="552" y="69" width="147" height="50" as="geometry" />
84+
</mxCell>
85+
<mxCell id="Db8zi3n4dXzB52SZQf6J-153" value="" style="endArrow=classic;html=1;rounded=0;comic=0;sketch=0;strokeColor=default;fontSize=16;fillColor=#CCE5FF;elbow=vertical;jumpStyle=none;jumpSize=23;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=0.991;exitY=0.322;exitDx=0;exitDy=0;exitPerimeter=0;" parent="1" source="Db8zi3n4dXzB52SZQf6J-11" target="Db8zi3n4dXzB52SZQf6J-122" edge="1">
86+
<mxGeometry width="50" height="50" relative="1" as="geometry">
87+
<mxPoint x="413" y="18" as="sourcePoint" />
88+
<mxPoint x="463" y="-32" as="targetPoint" />
89+
</mxGeometry>
90+
</mxCell>
91+
<mxCell id="Db8zi3n4dXzB52SZQf6J-162" value="&lt;div&gt;connectivity&lt;/div&gt;&lt;div&gt;commands&lt;/div&gt;&lt;div&gt;and events&lt;br&gt;&lt;/div&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
92+
<mxGeometry x="725" y="128" width="164" height="30" as="geometry" />
93+
</mxCell>
94+
<mxCell id="Db8zi3n4dXzB52SZQf6J-167" value="&lt;div&gt;iface events&lt;/div&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
95+
<mxGeometry x="426" y="162" width="164" height="30" as="geometry" />
96+
</mxCell>
97+
</root>
98+
</mxGraphModel>
99+
</diagram>
100+
</mxfile>

‎doc/connectivity/networking/conn_mgr/figures/integration_diagram_simplified.svg

Lines changed: 3 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)