1/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ANDROID_RS_FIFO_H
18#define ANDROID_RS_FIFO_H
19
20
21#include "rsUtils.h"
22
23namespace android {
24namespace renderscript {
25
26
27// A simple FIFO to be used as a producer / consumer between two
28// threads.  One is writer and one is reader.  The common cases
29// will not require locking.  It is not threadsafe for multiple
30// readers or writers by design.
31
32class Fifo {
33protected:
34    Fifo();
35    virtual ~Fifo();
36
37public:
38    bool virtual writeAsync(const void *data, size_t bytes, bool waitForSpace = true) = 0;
39    void virtual writeWaitReturn(void *ret, size_t retSize) = 0;
40    size_t virtual read(void *data, size_t bytes, bool doWait = true, uint64_t timeToWait = 0) = 0;
41    void virtual readReturn(const void *data, size_t bytes) = 0;
42
43    void virtual flush() = 0;
44
45};
46
47}
48}
49#endif
50