diff options
Diffstat (limited to 'static/freebsd/man4/ng_eiface.4 3.html')
| -rw-r--r-- | static/freebsd/man4/ng_eiface.4 3.html | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/static/freebsd/man4/ng_eiface.4 3.html b/static/freebsd/man4/ng_eiface.4 3.html new file mode 100644 index 00000000..e33b63c3 --- /dev/null +++ b/static/freebsd/man4/ng_eiface.4 3.html @@ -0,0 +1,96 @@ +<table class="head"> + <tr> + <td class="head-ltitle">NG_EIFACE(4)</td> + <td class="head-vol">Device Drivers Manual</td> + <td class="head-rtitle">NG_EIFACE(4)</td> + </tr> +</table> +<div class="manual-text"> +<section class="Sh"> +<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<p class="Pp"><code class="Nm">ng_eiface</code> — + <span class="Nd">generic Ethernet interface netgraph node type</span></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<p class="Pp"><code class="In">#include + <<a class="In">netgraph/ng_eiface.h</a>></code></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp">The <var class="Vt">eiface</var> netgraph node implements the + generic Ethernet interface. When an <var class="Vt">eiface</var> node is + created, a new interface appears which is accessible via + <a class="Xr">ifconfig(8)</a>. These interfaces are named + “<code class="Li">ngeth0</code>”, + “<code class="Li">ngeth1</code>”, etc. When a node is shut + down, the corresponding interface is removed, and the interface name becomes + available for reuse by future <var class="Vt">eiface</var> nodes. New nodes + always take the first unused interface.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HOOKS"><a class="permalink" href="#HOOKS">HOOKS</a></h1> +<p class="Pp">An <var class="Vt">eiface</var> node has a single hook named + <var class="Va">ether</var>, which should be connected to the Ethernet + downstream, for example, to the <a class="Xr">ng_vlan(4)</a> node. Packets + transmitted via the interface flow out this hook. Similarly, packets + received on the hook go to the protocol stack as packets received by any + real Ethernet interface.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="CONTROL_MESSAGES"><a class="permalink" href="#CONTROL_MESSAGES">CONTROL + MESSAGES</a></h1> +<p class="Pp">This node type supports the generic control messages, plus the + following:</p> +<dl class="Bl-tag"> + <dt id="NGM_EIFACE_SET"><a class="permalink" href="#NGM_EIFACE_SET"><code class="Dv">NGM_EIFACE_SET</code></a> + (<code class="Ic">set</code>)</dt> + <dd>Set link-level address of the interface. Requires <var class="Vt">struct + ether_addr</var> as an argument. This message also has an ASCII version, + called “<code class="Li">set</code>”, which requires as an + argument an ASCII string consisting of 6 colon-separated hex digits.</dd> + <dt id="NGM_EIFACE_GET_IFNAME"><a class="permalink" href="#NGM_EIFACE_GET_IFNAME"><code class="Dv">NGM_EIFACE_GET_IFNAME</code></a> + (<code class="Ic">getifname</code>)</dt> + <dd>Return the name of the associated interface as a + <code class="Dv">NULL</code>-terminated ASCII string.</dd> + <dt id="NGM_EIFACE_GET_IFADDRS"><a class="permalink" href="#NGM_EIFACE_GET_IFADDRS"><code class="Dv">NGM_EIFACE_GET_IFADDRS</code></a></dt> + <dd>Return the list of link-level addresses associated with the node.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="SHUTDOWN"><a class="permalink" href="#SHUTDOWN">SHUTDOWN</a></h1> +<p class="Pp">This node shuts down upon receipt of a + <code class="Dv">NGM_SHUTDOWN</code> control message. The associated + interface is removed and its name becomes available for reuse by future + <var class="Vt">eiface</var> nodes.</p> +<p class="Pp" id="not">Unlike most other node types, an + <var class="Vt">eiface</var> node does + <a class="permalink" href="#not"><i class="Em">not</i></a> go away when all + hooks have been disconnected; rather, an explicit + <code class="Dv">NGM_SHUTDOWN</code> control message is required.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<p class="Pp"><a class="Xr">netgraph(4)</a>, <a class="Xr">ng_ether(4)</a>, + <a class="Xr">ng_iface(4)</a>, <a class="Xr">ng_vlan(4)</a>, + <a class="Xr">ifconfig(8)</a>, <a class="Xr">ngctl(8)</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> +<p class="Pp">The <var class="Vt">eiface</var> node type was implemented in + <span class="Ux">FreeBSD 4.6</span>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> +<p class="Pp">The <var class="Vt">eiface</var> node type was written by + <span class="An">Vitaly V Belekhov</span>. This manual page was written by + <span class="An">Gleb Smirnoff</span>.</p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">May 14, 2019</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |