summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorErik Gabriel Carrillo <erik.g.carrillo@intel.com>2018-04-04 16:51:06 -0500
committerThomas Monjalon <thomas@monjalon.net>2018-04-16 11:04:46 +0200
commita6562f6d6f8eb64b1eed98bf67021b5a74921a34 (patch)
tree527f698c13dfb2283f37ba97e23ec98fb1b11aaf /doc/api
parent463dee906eeee3b2ed1715930083e2be90578de8 (diff)
downloaddpdk-next-eventdev-a6562f6d6f8eb64b1eed98bf67021b5a74921a34.zip
dpdk-next-eventdev-a6562f6d6f8eb64b1eed98bf67021b5a74921a34.tar.gz
dpdk-next-eventdev-a6562f6d6f8eb64b1eed98bf67021b5a74921a34.tar.xz
eventdev: introduce event timer adapter
Event devices can be coupled with various components to provide new event sources by using event adapters. The event timer adapter is one such adapter; it bridges event devices and timer mechanisms. This library extends the event-driven programming model by introducing a new type of event that represents a timer expiration, and it provides APIs with which adapters can be created or destroyed and event timers can be armed and canceled. Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com> Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com> Signed-off-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/doxy-api-index.md32
1 files changed, 3 insertions, 29 deletions
diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index d5ccbe8..26ce7b4 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -2,35 +2,8 @@ API {#index}
===
<!--
- BSD LICENSE
-
- Copyright 2013-2017 6WIND S.A.
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions
- are met:
-
- * Redistributions of source code must retain the above copyright
- notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright
- notice, this list of conditions and the following disclaimer in
- the documentation and/or other materials provided with the
- distribution.
- * Neither the name of 6WIND S.A. nor the names of its
- contributors may be used to endorse or promote products derived
- from this software without specific prior written permission.
-
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2013-2017 6WIND S.A.
-->
The public API headers are grouped by topics:
@@ -47,6 +20,7 @@ The public API headers are grouped by topics:
[security] (@ref rte_security.h),
[eventdev] (@ref rte_eventdev.h),
[event_eth_rx_adapter] (@ref rte_event_eth_rx_adapter.h),
+ [event_timer_adapter] (@ref rte_event_timer_adapter.h),
[rawdev] (@ref rte_rawdev.h),
[metrics] (@ref rte_metrics.h),
[bitrate] (@ref rte_bitrate.h),