You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ad...@apache.org on 2016/06/20 21:42:22 UTC
[20/51] [partial] incubator-mynewt-site git commit: generated two
versions of docs - develop and v0_9_0
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d18c34dd/develop/os/core_os/mbuf/os_mbuf_get_pkthdr/index.html
----------------------------------------------------------------------
diff --git a/develop/os/core_os/mbuf/os_mbuf_get_pkthdr/index.html b/develop/os/core_os/mbuf/os_mbuf_get_pkthdr/index.html
new file mode 100644
index 0000000..fd7ee9c
--- /dev/null
+++ b/develop/os/core_os/mbuf/os_mbuf_get_pkthdr/index.html
@@ -0,0 +1,965 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+
+ <link rel="canonical" href="http://mynewt.apache.org/os/core_os/mbuf/os_mbuf_get_pkthdr/">
+ <link rel="shortcut icon" href="../../../../img/favicon.ico">
+
+ <title>os_mbuf_get_pkthdr - Apache Mynewt</title>
+
+ <link href="../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
+ <link href="../../../../css/font-awesome-4.0.3.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../../../css/highlight.css">
+ <link href="../../../../css/base.css" rel="stylesheet">
+ <link href="../../../../css/custom.css" rel="stylesheet">
+ <link href="../../../../css/v2.css" rel="stylesheet">
+ <link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
+ <link href="../../../../extra.css" rel="stylesheet">
+
+ <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+ <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+ <![endif]-->
+
+
+ <script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-72162311-1', 'auto');
+ ga('send', 'pageview');
+ </script>
+
+ </head>
+
+
+ <body class="os_mbuf_get_pkthdr">
+
+
+
+
+
+
+
+
+
+<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container">
+ <!-- Collapsed navigation -->
+ <div class="navbar-header">
+ <!-- Expander button -->
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+ </div>
+
+ <!-- Expanded navigation -->
+ <div class="navbar-collapse collapse">
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav navbar-right">
+ <li
+ class=""
+>
+ <a href="/">Home</a>
+ </li>
+ <li
+ class="important"
+>
+ <a href="/quick-start/">Quick Start</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/about/">About</a>
+ </li>
+ <li
+ class="active"
+>
+ <a href="/latest/os/introduction">Documentation</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/download/">Download</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/community/">Community</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/events/">Events</a>
+ </li>
+ </ul>
+
+ <!-- Search, Navigation and Repo links -->
+ <ul class="nav navbar-nav navbar-right">
+
+ </ul>
+ </div>
+ </div>
+</nav>
+
+
+
+ <div class="container">
+
+ <div class="row">
+ <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary">
+ <div class="top">
+ <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
+ <div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
+ <div class="form-group">
+ <input type="text" name="q" class="form-control" placeholder="Search documentation" />
+ </div>
+ </form>
+ </div>
+ </div>
+ <ul class="toc-nav">
+ <li class="doc-version">
+<select class="form-control" onchange="if (this.value) window.location.href=this.value">
+
+ <option
+ value="/develop/os/introduction"
+ selected="selected"
+ >
+ Version: develop
+ </option>
+
+ <option
+ value="/v0_9_0/os/introduction"
+
+ >
+ Version: 0.9.0 (latest)
+ </option>
+
+</select>
+</li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li ><a href="../../../introduction/">Mynewt Documentation</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li ><a href="../../../get_started/get_started/">Basic Setup</a>
+
+
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../../../get_started/vocabulary/">Concepts</a>
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../tutorials/tutorials/">Tutorials</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../os_user_guide/">OS User Guide</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li ><a href="../../mynewt_os/">OS Core</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="
+ ../../os_init/
+">System-level Functions</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../context_switch/context_switch/">Scheduler</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../time/os_time/">Time</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../task/task/">Tasks</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../event_queue/event_queue/">Event Queues</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../semaphore/semaphore/">Semaphores</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../mutex/mutex/">Mutexes</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../memory_pool/memory_pool/">Memory Pools</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../heap/heap/">Heap</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+
+
+ ../mbuf/
+
+">Memory Buffers</a>
+
+
+ <ul>
+
+
+
+
+
+ <li ><a href="../mbuf/">Mbuf</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="
+ ../OS_MBUF_PKTHDR/
+">Functions/Macros</a>
+
+
+ <ul>
+
+
+
+ <li >
+ <a href="../OS_MBUF_PKTHDR/">OS_MBUF_PKTHDR</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_PKTHDR_TO_MBUF/">OS_MBUF_PKTHDR_TO_MBUF</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_PKTLEN/">OS_MBUF_PKTLEN</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_DATA/">OS_MBUF_DATA</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_USRHDR/">OS_MBUF_USRHDR</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_USRHDR_LEN/">OS_MBUF_USRHDR_LEN</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_LEADINGSPACE/">OS_MBUF_LEADINGSPACE</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_TRAILINGSPACE/">OS_MBUF_TRAILINGSPACE</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_adj/">os_mbuf_adj</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_append/">os_mbuf_append</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_concat/">os_mbuf_concat</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_copydata/">os_mbuf_copydata</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_copyinto/">os_mbuf_copyinto</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_dup/">os_mbuf_dup</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_extend/">os_mbuf_extend</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_free_chain/">os_mbuf_free_chain</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_get/">os_mbuf_get</a>
+ </li>
+
+
+
+
+
+ <li class="active">
+ <a href="./">os_mbuf_get_pkthdr</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_memcmp/">os_mbuf_memcmp</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_off/">os_mbuf_off</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_pool_init/">os_mbuf_pool_init</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_prepend/">os_mbuf_prepend</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_pullup/">os_mbuf_pullup</a>
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../msys/msys/">Msys</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../mqueue/mqueue/">MQueue</a>
+
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../sanity/sanity/">Sanity</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../callout/callout/">Callouts</a>
+
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../porting/port_os/">Porting to your Platform</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/console/console/">Console</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/shell/shell/">Shell</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/bootloader/bootloader/">Bootloader</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+
+
+ ../../../modules/fs/fs/fs/
+
+">File System</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/hal/hal/">Hardware Abstraction Layer</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/testutil/testutil/">Test Utilities</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/imgmgr/imgmgr/">Image Manager</a>
+
+
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../../../modules/baselibc/">Baselibc library</a>
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/elua/elua/">Embedded Lua</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/json/json/">JSON</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/stats/stats/">Stats</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/logs/logs/">Logs</a>
+
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+ ../../../../network/ble/ble_intro/
+">BLE User Guide</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../../newtmgr/overview/">Newt Manager Guide</a>
+
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+ ../../../../faq/how_to_edit_docs/
+">Appendix</a>
+
+
+ </li>
+
+
+
+ </ul>
+</div></div>
+
+ <div class="show-sidebar-container">
+ <button class="show-sidebar">Docs Menu</button>
+ </div>
+
+ <div class="col-md-9" role="main">
+ <div class="row doc-header">
+ <div class="col-sm-12">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs pull-right">
+ <li><a href="/develop/os/introduction">Docs</a></li>
+
+
+
+ <li>» <a href="../mbuf/">Mbuf</a></li>
+
+
+
+ <li>» <a href="../OS_MBUF_PKTHDR/">Functions/Macros</a></li>
+
+
+
+ <li>» os_mbuf_get_pkthdr</li>
+
+
+
+ </ul>
+</div>
+ </div>
+ </div>
+
+ <h2 id="os_mbuf_get_pkthdr"><font color="#F2853F" style="font-size:24pt">os_mbuf_get_pkthdr</font></h2>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">struct</span> <span style="color: #000000">os_mbuf</span> <span style="color: #000000">*os_mbuf_get_pkthdr</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">os_mbuf_pool</span> <span style="color: #000000">*omp</span>, <span style="color: #A90D91">uint8_t</span> <span style="color: #000000">pkthdr_len</span>);
+</pre></div>
+
+
+<p>Allocates a packet header mbuf from the mbuf pool pointed to by <em>omp</em>. Adds a user header of length <em>pkthdr_len</em> to packet header mbuf.</p>
+<p><br></p>
+<h4 id="arguments">Arguments</h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>om</td>
+<td>Pointer to mbuf pool from which to allocate mbuf</td>
+</tr>
+<tr>
+<td>pkthdr_len</td>
+<td>The user header packet length to allocate for the packet header mbuf</td>
+</tr>
+</tbody>
+</table>
+<p><br></p>
+<h4 id="returned-values">Returned values</h4>
+<p>Returns a pointer to the allocated mbuf or NULL if there are no mbufs available or the user packet header was too large.</p>
+<p><br></p>
+<h4 id="notes">Notes</h4>
+<p>The packet header mbuf returned will have its data pointer incremented by the sizeof(struct os_mbuf_pkthdr) as well as the amount of user header data (i.e. <em>pkthdr_len</em>). In other words, the data pointer is offset from the start of the mbuf by: sizeof(struct os_mbuf) + sizeof(struct os_mbuf_pkthdr) + pkthdr_len. The <code>om_pkthdr_len</code> element in the allocated mbuf is set to: sizeof(struct os_mbuf_pkthdr) + pkthdr_len.</p>
+<p><br></p>
+<h4 id="example">Example</h4>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #A90D91">struct</span> <span style="color: #000000">os_mbuf</span> <span style="color: #000000">*om</span>;
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">my_user_header</span> <span style="color: #000000">my_hdr</span>;
+
+ <span style="color: #177500">/* Get a packet header mbuf with a user header in it */</span>
+ <span style="color: #000000">om</span> <span style="color: #000000">=</span> <span style="color: #000000">os_mbuf_get_pkthdr</span>(<span style="color: #000000">&g_mbuf_pool</span>, <span style="color: #A90D91">sizeof</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">my_user_header</span>));
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">om</span>) {
+ <span style="color: #177500">/* Packet header mbuf was allocated */</span>
+ }
+</pre></div>
+
+ <div class="row">
+
+
+
+
+<ul class="nav nav-pills" style="margin-bottom: 10px">
+ <li>
+
+ <a href=../os_mbuf_get/>
+ <span class="fa fa-arrow-left"></span>
+ Previous: os_mbuf_get
+ </a>
+
+ </li>
+ <li class="pull-right">
+
+ <a href=../os_mbuf_memcmp/>
+ Next: os_mbuf_memcmp
+ <span class="fa fa-arrow-right"></span>
+ </a>
+
+ </li>
+</ul>
+ </div>
+ <div class="row">
+ <footer>
+ <div class="row">
+ <div class="col-md-12">
+
+ <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p>
+
+ </div>
+ </div>
+ <div class="copyright-logos">
+ <div class="row">
+ <div class="col-xs-6 text-right">
+ <img src="/img/apache-feather.png" alt="Apache" title="Apache">
+ </div>
+ <div class="col-xs-6 text-left">
+ <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator">
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-12">
+ <small class="footnote">
+ MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+ </small>
+ </div>
+ </div>
+</footer>
+ </div>
+ </div>
+ </div>
+
+
+ </div>
+
+ <script src="../../../../js/jquery-1.10.2.min.js"></script>
+ <script src="../../../../js/bootstrap-3.0.3.min.js"></script>
+ <script src="../../../../js/highlight.pack.js"></script>
+ <script src="../../../../js/base.js"></script>
+ <script src="../../../../js/custom.js"></script>
+
+ </body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d18c34dd/develop/os/core_os/mbuf/os_mbuf_memcmp/index.html
----------------------------------------------------------------------
diff --git a/develop/os/core_os/mbuf/os_mbuf_memcmp/index.html b/develop/os/core_os/mbuf/os_mbuf_memcmp/index.html
new file mode 100644
index 0000000..076bc29
--- /dev/null
+++ b/develop/os/core_os/mbuf/os_mbuf_memcmp/index.html
@@ -0,0 +1,974 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+
+ <link rel="canonical" href="http://mynewt.apache.org/os/core_os/mbuf/os_mbuf_memcmp/">
+ <link rel="shortcut icon" href="../../../../img/favicon.ico">
+
+ <title>os_mbuf_memcmp - Apache Mynewt</title>
+
+ <link href="../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
+ <link href="../../../../css/font-awesome-4.0.3.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../../../css/highlight.css">
+ <link href="../../../../css/base.css" rel="stylesheet">
+ <link href="../../../../css/custom.css" rel="stylesheet">
+ <link href="../../../../css/v2.css" rel="stylesheet">
+ <link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
+ <link href="../../../../extra.css" rel="stylesheet">
+
+ <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+ <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+ <![endif]-->
+
+
+ <script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-72162311-1', 'auto');
+ ga('send', 'pageview');
+ </script>
+
+ </head>
+
+
+ <body class="os_mbuf_memcmp">
+
+
+
+
+
+
+
+
+
+<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container">
+ <!-- Collapsed navigation -->
+ <div class="navbar-header">
+ <!-- Expander button -->
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+ </div>
+
+ <!-- Expanded navigation -->
+ <div class="navbar-collapse collapse">
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav navbar-right">
+ <li
+ class=""
+>
+ <a href="/">Home</a>
+ </li>
+ <li
+ class="important"
+>
+ <a href="/quick-start/">Quick Start</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/about/">About</a>
+ </li>
+ <li
+ class="active"
+>
+ <a href="/latest/os/introduction">Documentation</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/download/">Download</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/community/">Community</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/events/">Events</a>
+ </li>
+ </ul>
+
+ <!-- Search, Navigation and Repo links -->
+ <ul class="nav navbar-nav navbar-right">
+
+ </ul>
+ </div>
+ </div>
+</nav>
+
+
+
+ <div class="container">
+
+ <div class="row">
+ <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary">
+ <div class="top">
+ <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
+ <div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
+ <div class="form-group">
+ <input type="text" name="q" class="form-control" placeholder="Search documentation" />
+ </div>
+ </form>
+ </div>
+ </div>
+ <ul class="toc-nav">
+ <li class="doc-version">
+<select class="form-control" onchange="if (this.value) window.location.href=this.value">
+
+ <option
+ value="/develop/os/introduction"
+ selected="selected"
+ >
+ Version: develop
+ </option>
+
+ <option
+ value="/v0_9_0/os/introduction"
+
+ >
+ Version: 0.9.0 (latest)
+ </option>
+
+</select>
+</li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li ><a href="../../../introduction/">Mynewt Documentation</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li ><a href="../../../get_started/get_started/">Basic Setup</a>
+
+
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../../../get_started/vocabulary/">Concepts</a>
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../tutorials/tutorials/">Tutorials</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../os_user_guide/">OS User Guide</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li ><a href="../../mynewt_os/">OS Core</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="
+ ../../os_init/
+">System-level Functions</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../context_switch/context_switch/">Scheduler</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../time/os_time/">Time</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../task/task/">Tasks</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../event_queue/event_queue/">Event Queues</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../semaphore/semaphore/">Semaphores</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../mutex/mutex/">Mutexes</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../memory_pool/memory_pool/">Memory Pools</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../heap/heap/">Heap</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+
+
+ ../mbuf/
+
+">Memory Buffers</a>
+
+
+ <ul>
+
+
+
+
+
+ <li ><a href="../mbuf/">Mbuf</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="
+ ../OS_MBUF_PKTHDR/
+">Functions/Macros</a>
+
+
+ <ul>
+
+
+
+ <li >
+ <a href="../OS_MBUF_PKTHDR/">OS_MBUF_PKTHDR</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_PKTHDR_TO_MBUF/">OS_MBUF_PKTHDR_TO_MBUF</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_PKTLEN/">OS_MBUF_PKTLEN</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_DATA/">OS_MBUF_DATA</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_USRHDR/">OS_MBUF_USRHDR</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_USRHDR_LEN/">OS_MBUF_USRHDR_LEN</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_LEADINGSPACE/">OS_MBUF_LEADINGSPACE</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_TRAILINGSPACE/">OS_MBUF_TRAILINGSPACE</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_adj/">os_mbuf_adj</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_append/">os_mbuf_append</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_concat/">os_mbuf_concat</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_copydata/">os_mbuf_copydata</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_copyinto/">os_mbuf_copyinto</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_dup/">os_mbuf_dup</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_extend/">os_mbuf_extend</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_free_chain/">os_mbuf_free_chain</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_get/">os_mbuf_get</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_get_pkthdr/">os_mbuf_get_pkthdr</a>
+ </li>
+
+
+
+
+
+ <li class="active">
+ <a href="./">os_mbuf_memcmp</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_off/">os_mbuf_off</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_pool_init/">os_mbuf_pool_init</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_prepend/">os_mbuf_prepend</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_pullup/">os_mbuf_pullup</a>
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../msys/msys/">Msys</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../mqueue/mqueue/">MQueue</a>
+
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../sanity/sanity/">Sanity</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../callout/callout/">Callouts</a>
+
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../porting/port_os/">Porting to your Platform</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/console/console/">Console</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/shell/shell/">Shell</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/bootloader/bootloader/">Bootloader</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+
+
+ ../../../modules/fs/fs/fs/
+
+">File System</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/hal/hal/">Hardware Abstraction Layer</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/testutil/testutil/">Test Utilities</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/imgmgr/imgmgr/">Image Manager</a>
+
+
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../../../modules/baselibc/">Baselibc library</a>
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/elua/elua/">Embedded Lua</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/json/json/">JSON</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/stats/stats/">Stats</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/logs/logs/">Logs</a>
+
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+ ../../../../network/ble/ble_intro/
+">BLE User Guide</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../../newtmgr/overview/">Newt Manager Guide</a>
+
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+ ../../../../faq/how_to_edit_docs/
+">Appendix</a>
+
+
+ </li>
+
+
+
+ </ul>
+</div></div>
+
+ <div class="show-sidebar-container">
+ <button class="show-sidebar">Docs Menu</button>
+ </div>
+
+ <div class="col-md-9" role="main">
+ <div class="row doc-header">
+ <div class="col-sm-12">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs pull-right">
+ <li><a href="/develop/os/introduction">Docs</a></li>
+
+
+
+ <li>» <a href="../mbuf/">Mbuf</a></li>
+
+
+
+ <li>» <a href="../OS_MBUF_PKTHDR/">Functions/Macros</a></li>
+
+
+
+ <li>» os_mbuf_memcmp</li>
+
+
+
+ </ul>
+</div>
+ </div>
+ </div>
+
+ <h2 id="os_mbuf_memcmp"><font color="#F2853F" style="font-size:24pt">os_mbuf_memcmp</font></h2>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">os_mbuf_memcmp</span>(<span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #000000">os_mbuf</span> <span style="color: #000000">*om</span>, <span style="color: #A90D91">int</span> <span style="color: #000000">off</span>, <span style="color: #A90D91">const</span> <span style="color: #A90D91">void</span> <span style="color: #000000">*data</span>, <span style="color: #A90D91">int</span> <span style="color: #000000">len</span>)
+</pre></div>
+
+
+<p>Performs a memory compare of the specified region of an mbuf chain against a flat buffer.</p>
+<p><br></p>
+<h4 id="arguments">Arguments</h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>om</td>
+<td>Pointer to mbuf</td>
+</tr>
+<tr>
+<td>off</td>
+<td>Offset, in bytes, from start of mbuf to start of comparison</td>
+</tr>
+<tr>
+<td>data</td>
+<td>Pointer to flat data buffer to compare</td>
+</tr>
+<tr>
+<td>len</td>
+<td>Number of bytes to compare</td>
+</tr>
+</tbody>
+</table>
+<p><br></p>
+<h4 id="returned-values">Returned values</h4>
+<p>A value of zero means the memory regions are identical; all other values represent either an error or a value returned from memcmp. </p>
+<p><br></p>
+<h4 id="notes">Notes</h4>
+<p>This function will compare bytes starting from <em>off</em> bytes from the start of the mbuf chain with a data buffer.</p>
+<p><br></p>
+<h4 id="example">Example</h4>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>;
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">os_mbuf</span> <span style="color: #000000">*om</span>;
+ <span style="color: #A90D91">uint8_t</span> <span style="color: #000000">my_data_buffer</span>[<span style="color: #1C01CE">32</span>];
+
+ <span style="color: #177500">/* Get a packet header mbuf with a user header in it */</span>
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">os_mbuf_memcmp</span>(<span style="color: #000000">om</span>, <span style="color: #1C01CE">0</span>, <span style="color: #000000">my_data_buffer</span>, <span style="color: #1C01CE">32</span>);
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">!rc</span>) {
+ <span style="color: #177500">/* "my_data_buffer" and the data from offset 0 in the mbuf chain are identical! */</span>
+ }
+</pre></div>
+
+ <div class="row">
+
+
+
+
+<ul class="nav nav-pills" style="margin-bottom: 10px">
+ <li>
+
+ <a href=../os_mbuf_get_pkthdr/>
+ <span class="fa fa-arrow-left"></span>
+ Previous: os_mbuf_get_pkthdr
+ </a>
+
+ </li>
+ <li class="pull-right">
+
+ <a href=../os_mbuf_off/>
+ Next: os_mbuf_off
+ <span class="fa fa-arrow-right"></span>
+ </a>
+
+ </li>
+</ul>
+ </div>
+ <div class="row">
+ <footer>
+ <div class="row">
+ <div class="col-md-12">
+
+ <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p>
+
+ </div>
+ </div>
+ <div class="copyright-logos">
+ <div class="row">
+ <div class="col-xs-6 text-right">
+ <img src="/img/apache-feather.png" alt="Apache" title="Apache">
+ </div>
+ <div class="col-xs-6 text-left">
+ <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator">
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-12">
+ <small class="footnote">
+ MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+ </small>
+ </div>
+ </div>
+</footer>
+ </div>
+ </div>
+ </div>
+
+
+ </div>
+
+ <script src="../../../../js/jquery-1.10.2.min.js"></script>
+ <script src="../../../../js/bootstrap-3.0.3.min.js"></script>
+ <script src="../../../../js/highlight.pack.js"></script>
+ <script src="../../../../js/base.js"></script>
+ <script src="../../../../js/custom.js"></script>
+
+ </body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d18c34dd/develop/os/core_os/mbuf/os_mbuf_off/index.html
----------------------------------------------------------------------
diff --git a/develop/os/core_os/mbuf/os_mbuf_off/index.html b/develop/os/core_os/mbuf/os_mbuf_off/index.html
new file mode 100644
index 0000000..14b7246
--- /dev/null
+++ b/develop/os/core_os/mbuf/os_mbuf_off/index.html
@@ -0,0 +1,981 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+
+ <link rel="canonical" href="http://mynewt.apache.org/os/core_os/mbuf/os_mbuf_off/">
+ <link rel="shortcut icon" href="../../../../img/favicon.ico">
+
+ <title>os_mbuf_off - Apache Mynewt</title>
+
+ <link href="../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
+ <link href="../../../../css/font-awesome-4.0.3.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../../../css/highlight.css">
+ <link href="../../../../css/base.css" rel="stylesheet">
+ <link href="../../../../css/custom.css" rel="stylesheet">
+ <link href="../../../../css/v2.css" rel="stylesheet">
+ <link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
+ <link href="../../../../extra.css" rel="stylesheet">
+
+ <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+ <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+ <![endif]-->
+
+
+ <script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-72162311-1', 'auto');
+ ga('send', 'pageview');
+ </script>
+
+ </head>
+
+
+ <body class="os_mbuf_off">
+
+
+
+
+
+
+
+
+
+<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container">
+ <!-- Collapsed navigation -->
+ <div class="navbar-header">
+ <!-- Expander button -->
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+ </div>
+
+ <!-- Expanded navigation -->
+ <div class="navbar-collapse collapse">
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav navbar-right">
+ <li
+ class=""
+>
+ <a href="/">Home</a>
+ </li>
+ <li
+ class="important"
+>
+ <a href="/quick-start/">Quick Start</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/about/">About</a>
+ </li>
+ <li
+ class="active"
+>
+ <a href="/latest/os/introduction">Documentation</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/download/">Download</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/community/">Community</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/events/">Events</a>
+ </li>
+ </ul>
+
+ <!-- Search, Navigation and Repo links -->
+ <ul class="nav navbar-nav navbar-right">
+
+ </ul>
+ </div>
+ </div>
+</nav>
+
+
+
+ <div class="container">
+
+ <div class="row">
+ <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary">
+ <div class="top">
+ <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
+ <div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
+ <div class="form-group">
+ <input type="text" name="q" class="form-control" placeholder="Search documentation" />
+ </div>
+ </form>
+ </div>
+ </div>
+ <ul class="toc-nav">
+ <li class="doc-version">
+<select class="form-control" onchange="if (this.value) window.location.href=this.value">
+
+ <option
+ value="/develop/os/introduction"
+ selected="selected"
+ >
+ Version: develop
+ </option>
+
+ <option
+ value="/v0_9_0/os/introduction"
+
+ >
+ Version: 0.9.0 (latest)
+ </option>
+
+</select>
+</li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li ><a href="../../../introduction/">Mynewt Documentation</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li ><a href="../../../get_started/get_started/">Basic Setup</a>
+
+
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../../../get_started/vocabulary/">Concepts</a>
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../tutorials/tutorials/">Tutorials</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../os_user_guide/">OS User Guide</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li ><a href="../../mynewt_os/">OS Core</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="
+ ../../os_init/
+">System-level Functions</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../context_switch/context_switch/">Scheduler</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../time/os_time/">Time</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../task/task/">Tasks</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../event_queue/event_queue/">Event Queues</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../semaphore/semaphore/">Semaphores</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../mutex/mutex/">Mutexes</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../memory_pool/memory_pool/">Memory Pools</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../heap/heap/">Heap</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+
+
+ ../mbuf/
+
+">Memory Buffers</a>
+
+
+ <ul>
+
+
+
+
+
+ <li ><a href="../mbuf/">Mbuf</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="
+ ../OS_MBUF_PKTHDR/
+">Functions/Macros</a>
+
+
+ <ul>
+
+
+
+ <li >
+ <a href="../OS_MBUF_PKTHDR/">OS_MBUF_PKTHDR</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_PKTHDR_TO_MBUF/">OS_MBUF_PKTHDR_TO_MBUF</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_PKTLEN/">OS_MBUF_PKTLEN</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_DATA/">OS_MBUF_DATA</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_USRHDR/">OS_MBUF_USRHDR</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_USRHDR_LEN/">OS_MBUF_USRHDR_LEN</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_LEADINGSPACE/">OS_MBUF_LEADINGSPACE</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_TRAILINGSPACE/">OS_MBUF_TRAILINGSPACE</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_adj/">os_mbuf_adj</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_append/">os_mbuf_append</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_concat/">os_mbuf_concat</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_copydata/">os_mbuf_copydata</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_copyinto/">os_mbuf_copyinto</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_dup/">os_mbuf_dup</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_extend/">os_mbuf_extend</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_free_chain/">os_mbuf_free_chain</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_get/">os_mbuf_get</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_get_pkthdr/">os_mbuf_get_pkthdr</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_memcmp/">os_mbuf_memcmp</a>
+ </li>
+
+
+
+
+
+ <li class="active">
+ <a href="./">os_mbuf_off</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_pool_init/">os_mbuf_pool_init</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_prepend/">os_mbuf_prepend</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_pullup/">os_mbuf_pullup</a>
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../msys/msys/">Msys</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../mqueue/mqueue/">MQueue</a>
+
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../sanity/sanity/">Sanity</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../callout/callout/">Callouts</a>
+
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../porting/port_os/">Porting to your Platform</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/console/console/">Console</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/shell/shell/">Shell</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/bootloader/bootloader/">Bootloader</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+
+
+ ../../../modules/fs/fs/fs/
+
+">File System</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/hal/hal/">Hardware Abstraction Layer</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/testutil/testutil/">Test Utilities</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/imgmgr/imgmgr/">Image Manager</a>
+
+
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../../../modules/baselibc/">Baselibc library</a>
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/elua/elua/">Embedded Lua</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/json/json/">JSON</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/stats/stats/">Stats</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/logs/logs/">Logs</a>
+
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+ ../../../../network/ble/ble_intro/
+">BLE User Guide</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../../newtmgr/overview/">Newt Manager Guide</a>
+
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+ ../../../../faq/how_to_edit_docs/
+">Appendix</a>
+
+
+ </li>
+
+
+
+ </ul>
+</div></div>
+
+ <div class="show-sidebar-container">
+ <button class="show-sidebar">Docs Menu</button>
+ </div>
+
+ <div class="col-md-9" role="main">
+ <div class="row doc-header">
+ <div class="col-sm-12">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs pull-right">
+ <li><a href="/develop/os/introduction">Docs</a></li>
+
+
+
+ <li>» <a href="../mbuf/">Mbuf</a></li>
+
+
+
+ <li>» <a href="../OS_MBUF_PKTHDR/">Functions/Macros</a></li>
+
+
+
+ <li>» os_mbuf_off</li>
+
+
+
+ </ul>
+</div>
+ </div>
+ </div>
+
+ <h2 id="os_mbuf_off"><font color="#F2853F" style="font-size:24pt">os_mbuf_off</font></h2>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">struct</span> <span style="color: #000000">os_mbuf</span> <span style="color: #000000">*os_mbuf_off</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">os_mbuf</span> <span style="color: #000000">*om</span>, <span style="color: #A90D91">int</span> <span style="color: #000000">off</span>, <span style="color: #A90D91">int</span> <span style="color: #000000">*out_off</span>)
+</pre></div>
+
+
+<p>Given an offset in the packet (i.e. user data byte offset in the mbuf chain), return the mbuf and the offset in that mbuf where byte 'off' is located. Note that the offset is 'returned' in <em>out_off</em>.</p>
+<p><br></p>
+<h4 id="arguments">Arguments</h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>om</td>
+<td>Pointer to mbuf</td>
+</tr>
+<tr>
+<td>off</td>
+<td>Location in mbuf chain of desired byte offset</td>
+</tr>
+<tr>
+<td>out_off</td>
+<td>Pointer to storage for the relative offset of the absolute location in the returned mbuf</td>
+</tr>
+</tbody>
+</table>
+<p><br></p>
+<h4 id="returned-values">Returned values</h4>
+<p>NULL if the offset is not within the mbuf chain or <em>om</em> points to NULL.</p>
+<p><br></p>
+<h4 id="notes">Notes</h4>
+<p>The user is allowed to call this function with the length of the mbuf chain but no greater. This allows the user to get the mbuf and offset (in that mbuf) where the next user data byte should be written.</p>
+<p>While this api is provided to the user, other API are expected to be used by the applciation developer (i.e. <code>os_mbuf_append()</code> or <code>os_mbuf_copyinto()</code>).
+<br></p>
+<h4 id="example">Example</h4>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #A90D91">int</span> <span style="color: #000000">relative_offset</span>;
+ <span style="color: #A90D91">uint16_t</span> <span style="color: #000000">pktlen</span>;
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">os_mbuf</span> <span style="color: #000000">*om</span>;
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">os_mbuf</span> <span style="color: #000000">*tmp</span>;
+
+ <span style="color: #177500">/* Append a new line character to end of mbuf data */</span>
+ <span style="color: #000000">pktlen</span> <span style="color: #000000">=</span> <span style="color: #000000">OS_MBUF_PKTLEN</span>(<span style="color: #000000">om</span>);
+
+ <span style="color: #000000">relative_offset</span> <span style="color: #000000">=</span> <span style="color: #1C01CE">0</span>;
+ <span style="color: #000000">tmp</span> <span style="color: #000000">=</span> <span style="color: #000000">os_mbuf_off</span>(<span style="color: #000000">om</span>, <span style="color: #000000">pktlen</span>, <span style="color: #000000">&relative_offset</span>);
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">tmp</span>) {
+ <span style="color: #177500">/* Offset found. */</span>
+ <span style="color: #000000">tmp->om_data</span>[<span style="color: #000000">relative_offset</span>] <span style="color: #000000">=</span> <span style="color: #2300CE">'\n'</span>;
+ } <span style="color: #A90D91">else</span> {
+ <span style="color: #177500">/*</span>
+<span style="color: #177500"> * This mbuf does not contain enough bytes so this is an invalid offset.</span>
+<span style="color: #177500"> * In other words, the mbuf is less than 62 bytes in length.</span>
+<span style="color: #177500"> */</span>
+ }
+</pre></div>
+
+ <div class="row">
+
+
+
+
+<ul class="nav nav-pills" style="margin-bottom: 10px">
+ <li>
+
+ <a href=../os_mbuf_memcmp/>
+ <span class="fa fa-arrow-left"></span>
+ Previous: os_mbuf_memcmp
+ </a>
+
+ </li>
+ <li class="pull-right">
+
+ <a href=../os_mbuf_pool_init/>
+ Next: os_mbuf_pool_init
+ <span class="fa fa-arrow-right"></span>
+ </a>
+
+ </li>
+</ul>
+ </div>
+ <div class="row">
+ <footer>
+ <div class="row">
+ <div class="col-md-12">
+
+ <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p>
+
+ </div>
+ </div>
+ <div class="copyright-logos">
+ <div class="row">
+ <div class="col-xs-6 text-right">
+ <img src="/img/apache-feather.png" alt="Apache" title="Apache">
+ </div>
+ <div class="col-xs-6 text-left">
+ <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator">
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-12">
+ <small class="footnote">
+ MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+ </small>
+ </div>
+ </div>
+</footer>
+ </div>
+ </div>
+ </div>
+
+
+ </div>
+
+ <script src="../../../../js/jquery-1.10.2.min.js"></script>
+ <script src="../../../../js/bootstrap-3.0.3.min.js"></script>
+ <script src="../../../../js/highlight.pack.js"></script>
+ <script src="../../../../js/base.js"></script>
+ <script src="../../../../js/custom.js"></script>
+
+ </body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d18c34dd/develop/os/core_os/mbuf/os_mbuf_pool_init/index.html
----------------------------------------------------------------------
diff --git a/develop/os/core_os/mbuf/os_mbuf_pool_init/index.html b/develop/os/core_os/mbuf/os_mbuf_pool_init/index.html
new file mode 100644
index 0000000..588b410
--- /dev/null
+++ b/develop/os/core_os/mbuf/os_mbuf_pool_init/index.html
@@ -0,0 +1,992 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+
+ <link rel="canonical" href="http://mynewt.apache.org/os/core_os/mbuf/os_mbuf_pool_init/">
+ <link rel="shortcut icon" href="../../../../img/favicon.ico">
+
+ <title>os_mbuf_pool_init - Apache Mynewt</title>
+
+ <link href="../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
+ <link href="../../../../css/font-awesome-4.0.3.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../../../css/highlight.css">
+ <link href="../../../../css/base.css" rel="stylesheet">
+ <link href="../../../../css/custom.css" rel="stylesheet">
+ <link href="../../../../css/v2.css" rel="stylesheet">
+ <link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
+ <link href="../../../../extra.css" rel="stylesheet">
+
+ <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+ <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+ <![endif]-->
+
+
+ <script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-72162311-1', 'auto');
+ ga('send', 'pageview');
+ </script>
+
+ </head>
+
+
+ <body class="os_mbuf_pool_init">
+
+
+
+
+
+
+
+
+
+<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container">
+ <!-- Collapsed navigation -->
+ <div class="navbar-header">
+ <!-- Expander button -->
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+ </div>
+
+ <!-- Expanded navigation -->
+ <div class="navbar-collapse collapse">
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav navbar-right">
+ <li
+ class=""
+>
+ <a href="/">Home</a>
+ </li>
+ <li
+ class="important"
+>
+ <a href="/quick-start/">Quick Start</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/about/">About</a>
+ </li>
+ <li
+ class="active"
+>
+ <a href="/latest/os/introduction">Documentation</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/download/">Download</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/community/">Community</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/events/">Events</a>
+ </li>
+ </ul>
+
+ <!-- Search, Navigation and Repo links -->
+ <ul class="nav navbar-nav navbar-right">
+
+ </ul>
+ </div>
+ </div>
+</nav>
+
+
+
+ <div class="container">
+
+ <div class="row">
+ <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary">
+ <div class="top">
+ <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
+ <div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
+ <div class="form-group">
+ <input type="text" name="q" class="form-control" placeholder="Search documentation" />
+ </div>
+ </form>
+ </div>
+ </div>
+ <ul class="toc-nav">
+ <li class="doc-version">
+<select class="form-control" onchange="if (this.value) window.location.href=this.value">
+
+ <option
+ value="/develop/os/introduction"
+ selected="selected"
+ >
+ Version: develop
+ </option>
+
+ <option
+ value="/v0_9_0/os/introduction"
+
+ >
+ Version: 0.9.0 (latest)
+ </option>
+
+</select>
+</li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li ><a href="../../../introduction/">Mynewt Documentation</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li ><a href="../../../get_started/get_started/">Basic Setup</a>
+
+
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../../../get_started/vocabulary/">Concepts</a>
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../tutorials/tutorials/">Tutorials</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../os_user_guide/">OS User Guide</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li ><a href="../../mynewt_os/">OS Core</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="
+ ../../os_init/
+">System-level Functions</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../context_switch/context_switch/">Scheduler</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../time/os_time/">Time</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../task/task/">Tasks</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../event_queue/event_queue/">Event Queues</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../semaphore/semaphore/">Semaphores</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../mutex/mutex/">Mutexes</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../memory_pool/memory_pool/">Memory Pools</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../heap/heap/">Heap</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+
+
+ ../mbuf/
+
+">Memory Buffers</a>
+
+
+ <ul>
+
+
+
+
+
+ <li ><a href="../mbuf/">Mbuf</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="
+ ../OS_MBUF_PKTHDR/
+">Functions/Macros</a>
+
+
+ <ul>
+
+
+
+ <li >
+ <a href="../OS_MBUF_PKTHDR/">OS_MBUF_PKTHDR</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_PKTHDR_TO_MBUF/">OS_MBUF_PKTHDR_TO_MBUF</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_PKTLEN/">OS_MBUF_PKTLEN</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_DATA/">OS_MBUF_DATA</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_USRHDR/">OS_MBUF_USRHDR</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_USRHDR_LEN/">OS_MBUF_USRHDR_LEN</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_LEADINGSPACE/">OS_MBUF_LEADINGSPACE</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../OS_MBUF_TRAILINGSPACE/">OS_MBUF_TRAILINGSPACE</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_adj/">os_mbuf_adj</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_append/">os_mbuf_append</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_concat/">os_mbuf_concat</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_copydata/">os_mbuf_copydata</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_copyinto/">os_mbuf_copyinto</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_dup/">os_mbuf_dup</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_extend/">os_mbuf_extend</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_free_chain/">os_mbuf_free_chain</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_get/">os_mbuf_get</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_get_pkthdr/">os_mbuf_get_pkthdr</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_memcmp/">os_mbuf_memcmp</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_off/">os_mbuf_off</a>
+ </li>
+
+
+
+
+
+ <li class="active">
+ <a href="./">os_mbuf_pool_init</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_prepend/">os_mbuf_prepend</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mbuf_pullup/">os_mbuf_pullup</a>
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../msys/msys/">Msys</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../mqueue/mqueue/">MQueue</a>
+
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../sanity/sanity/">Sanity</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../callout/callout/">Callouts</a>
+
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../porting/port_os/">Porting to your Platform</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/console/console/">Console</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/shell/shell/">Shell</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/bootloader/bootloader/">Bootloader</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+
+
+ ../../../modules/fs/fs/fs/
+
+">File System</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/hal/hal/">Hardware Abstraction Layer</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/testutil/testutil/">Test Utilities</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/imgmgr/imgmgr/">Image Manager</a>
+
+
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../../../modules/baselibc/">Baselibc library</a>
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/elua/elua/">Embedded Lua</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/json/json/">JSON</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/stats/stats/">Stats</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/logs/logs/">Logs</a>
+
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+ ../../../../network/ble/ble_intro/
+">BLE User Guide</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../../newtmgr/overview/">Newt Manager Guide</a>
+
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+ ../../../../faq/how_to_edit_docs/
+">Appendix</a>
+
+
+ </li>
+
+
+
+ </ul>
+</div></div>
+
+ <div class="show-sidebar-container">
+ <button class="show-sidebar">Docs Menu</button>
+ </div>
+
+ <div class="col-md-9" role="main">
+ <div class="row doc-header">
+ <div class="col-sm-12">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs pull-right">
+ <li><a href="/develop/os/introduction">Docs</a></li>
+
+
+
+ <li>» <a href="../mbuf/">Mbuf</a></li>
+
+
+
+ <li>» <a href="../OS_MBUF_PKTHDR/">Functions/Macros</a></li>
+
+
+
+ <li>» os_mbuf_pool_init</li>
+
+
+
+ </ul>
+</div>
+ </div>
+ </div>
+
+ <h2 id="os_mbuf_pool_init"><font color="#F2853F" style="font-size:24pt">os_mbuf_pool_init</font></h2>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">os_mbuf_pool_init</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">os_mbuf_pool</span> <span style="color: #000000">*omp</span>, <span style="color: #A90D91">struct</span> <span style="color: #000000">os_mempool</span> <span style="color: #000000">*mp</span>, <span style="color: #A90D91">uint16_t</span> <span style="color: #000000">buf_len</span>,
+ <span style="color: #A90D91">uint16_t</span> <span style="color: #000000">nbufs</span>)
+</pre></div>
+
+
+<p>Initialize an mbuf pool</p>
+<p><br></p>
+<h4 id="arguments">Arguments</h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>omp</td>
+<td>Pointer to mbuf pool to initialize</td>
+</tr>
+<tr>
+<td>mp</td>
+<td>Pointer to memory pool used by mbuf pool</td>
+</tr>
+<tr>
+<td>buf_len</td>
+<td>The size of the memory blocks in the memory pool used by the mbuf pool</td>
+</tr>
+<tr>
+<td>nbufs</td>
+<td>The number of mbufs in the pool</td>
+</tr>
+</tbody>
+</table>
+<p><br></p>
+<h4 id="returned-values">Returned values</h4>
+<p>0 on success; all other values indicate an error.</p>
+<p><br></p>
+<h4 id="notes">Notes</h4>
+<p>The parameter <em>buf_len</em> is the total size of the memory block. This must accommodate the os_mbuf structure, the os_mbuf_pkthdr structure, any user headers plus the desired amount of user data.</p>
+<p><br></p>
+<h4 id="example">Example</h4>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#define MBUF_PKTHDR_OVERHEAD sizeof(struct os_mbuf_pkthdr) + sizeof(struct user_hdr)</span>
+<span style="color: #633820">#define MBUF_MEMBLOCK_OVERHEAD sizeof(struct os_mbuf) + MBUF_PKTHDR_OVERHEAD</span>
+
+<span style="color: #633820">#define MBUF_NUM_MBUFS (32)</span>
+<span style="color: #633820">#define MBUF_PAYLOAD_SIZE (64)</span>
+<span style="color: #633820">#define MBUF_BUF_SIZE OS_ALIGN(MBUF_PAYLOAD_SIZE, 4)</span>
+<span style="color: #633820">#define MBUF_MEMBLOCK_SIZE (MBUF_BUF_SIZE + MBUF_MEMBLOCK_OVERHEAD)</span>
+<span style="color: #633820">#define MBUF_MEMPOOL_SIZE OS_MEMPOOL_SIZE(MBUF_NUM_MBUFS, MBUF_MEMBLOCK_SIZE)</span>
+
+<span style="color: #A90D91">struct</span> <span style="color: #000000">os_mbuf_pool</span> <span style="color: #000000">g_mbuf_pool</span>;
+<span style="color: #A90D91">struct</span> <span style="color: #000000">os_mempool</span> <span style="color: #000000">g_mbuf_mempool</span>;
+<span style="color: #A90D91">os_membuf_t</span> <span style="color: #000000">g_mbuf_buffer</span>[<span style="color: #000000">MBUF_MEMPOOL_SIZE</span>];
+
+<span style="color: #A90D91">void</span>
+<span style="color: #000000">create_mbuf_pool</span>(<span style="color: #A90D91">void</span>)
+{
+ <span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>;
+
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">os_mempool_init</span>(<span style="color: #000000">&g_mbuf_mempool</span>, <span style="color: #000000">MBUF_NUM_MBUFS</span>,
+ <span style="color: #000000">MBUF_MEMBLOCK_SIZE</span>, <span style="color: #000000">&g_mbuf_buffer</span>[<span style="color: #1C01CE">0</span>], <span style="color: #C41A16">"mbuf_pool"</span>);
+ <span style="color: #000000">assert</span>(<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>);
+
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">os_mbuf_pool_init</span>(<span style="color: #000000">&g_mbuf_pool</span>, <span style="color: #000000">&g_mbuf_mempool</span>, <span style="color: #000000">MBUF_MEMBLOCK_SIZE</span>,
+ <span style="color: #000000">MBUF_NUM_MBUFS</span>);
+ <span style="color: #000000">assert</span>(<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>);
+}
+</pre></div>
+
+ <div class="row">
+
+
+
+
+<ul class="nav nav-pills" style="margin-bottom: 10px">
+ <li>
+
+ <a href=../os_mbuf_off/>
+ <span class="fa fa-arrow-left"></span>
+ Previous: os_mbuf_off
+ </a>
+
+ </li>
+ <li class="pull-right">
+
+ <a href=../os_mbuf_prepend/>
+ Next: os_mbuf_prepend
+ <span class="fa fa-arrow-right"></span>
+ </a>
+
+ </li>
+</ul>
+ </div>
+ <div class="row">
+ <footer>
+ <div class="row">
+ <div class="col-md-12">
+
+ <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p>
+
+ </div>
+ </div>
+ <div class="copyright-logos">
+ <div class="row">
+ <div class="col-xs-6 text-right">
+ <img src="/img/apache-feather.png" alt="Apache" title="Apache">
+ </div>
+ <div class="col-xs-6 text-left">
+ <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator">
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-12">
+ <small class="footnote">
+ MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+ </small>
+ </div>
+ </div>
+</footer>
+ </div>
+ </div>
+ </div>
+
+
+ </div>
+
+ <script src="../../../../js/jquery-1.10.2.min.js"></script>
+ <script src="../../../../js/bootstrap-3.0.3.min.js"></script>
+ <script src="../../../../js/highlight.pack.js"></script>
+ <script src="../../../../js/base.js"></script>
+ <script src="../../../../js/custom.js"></script>
+
+ </body>
+</html>
\ No newline at end of file