sci_iterator.h revision 230557 
1/*-
2 * This file is provided under a dual BSD/GPLv2 license.  When using or
3 * redistributing this file, you may do so under either license.
4 *
5 * GPL LICENSE SUMMARY
6 *
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of version 2 of the GNU General Public License as
11 * published by the Free Software Foundation.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16 * General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
21 * The full GNU General Public License is included in this distribution
22 * in the file called LICENSE.GPL.
23 *
24 * BSD LICENSE
25 *
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
28 *
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
31 * are met:
32 *
33 *   * Redistributions of source code must retain the above copyright
34 *     notice, this list of conditions and the following disclaimer.
35 *   * Redistributions in binary form must reproduce the above copyright
36 *     notice, this list of conditions and the following disclaimer in
37 *     the documentation and/or other materials provided with the
38 *     distribution.
39 *
40 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
41 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
42 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
43 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
44 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
46 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
47 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
48 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
49 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
50 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
51 *
52 * $FreeBSD$
53 */
54/**
55 * @file
56 *
57 * @brief This file contains the interface to the iterator class.
58 *        Methods Provided:
59 *        - sci_iterator_get_object_size()
60 *        - sci_iterator_get_current()
61 *        - sci_iterator_first()
62 *        - sci_iterator_next()
63 */
64
65#ifndef _SCI_ITERATOR_H_
66#define _SCI_ITERATOR_H_
67
68#ifdef __cplusplus
69extern "C" {
70#endif // __cplusplus
71
72#if !defined(DISABLE_SCI_ITERATORS)
73
74//******************************************************************************
75//*
76//*     I N C L U D E S
77//*
78//******************************************************************************
79
80#include <dev/isci/scil/sci_types.h>
81
82//******************************************************************************
83//*
84//*     C O N S T A N T S
85//*
86//******************************************************************************
87
88//******************************************************************************
89//*
90//*     T Y P E S
91//*
92//******************************************************************************
93
94//******************************************************************************
95//*
96//*     P U B L I C       M E T H O D S
97//*
98//******************************************************************************
99
100U32 sci_iterator_get_object_size(
101   void
102);
103
104void * sci_iterator_get_current(
105   SCI_ITERATOR_HANDLE_T iterator_handle
106);
107
108void sci_iterator_first(
109   SCI_ITERATOR_HANDLE_T iterator_handle
110);
111
112void sci_iterator_next(
113   SCI_ITERATOR_HANDLE_T iterator_handle
114);
115
116#else // !defined(DISABLE_SCI_ITERATORS)
117
118#define sci_iterator_get_object_size() 0
119#define sci_iterator_get_current(the_iterator) NULL
120#define sci_iterator_first(the_iterator)
121#define sci_iterator_next(the_iterator)
122
123#endif // !defined(DISABLE_SCI_ITERATORS)
124
125#ifdef __cplusplus
126}
127#endif // __cplusplus
128
129#endif // _ITERATOR_H_
130