Jean-Luc Brouillet | be21638 | 2015-03-22 12:44:27 -0700 | [diff] [blame^] | 1 | # |
| 2 | # Copyright (C) 2015 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 | header: |
| 18 | summary: Input/output functions |
| 19 | description: |
| 20 | TODO Add documentation |
| 21 | end: |
| 22 | |
| 23 | function: rsAllocationIoReceive |
| 24 | version: 16 |
| 25 | ret: void |
| 26 | arg: rs_allocation a, "allocation to work on" |
| 27 | summary: Receive new content from the queue |
| 28 | description: |
| 29 | Receive a new set of contents from the queue. |
| 30 | test: none |
| 31 | end: |
| 32 | |
| 33 | function: rsAllocationIoSend |
| 34 | version: 16 |
| 35 | ret: void |
| 36 | arg: rs_allocation a, "allocation to work on" |
| 37 | summary: Send new content to the queue |
| 38 | description: |
| 39 | Send the contents of the Allocation to the queue. |
| 40 | test: none |
| 41 | end: |
| 42 | |
| 43 | function: rsSendToClient |
| 44 | ret: bool |
| 45 | arg: int cmdID |
| 46 | summary: |
| 47 | description: |
| 48 | Send a message back to the client. Will not block and returns true |
| 49 | if the message was sendable and false if the fifo was full. |
| 50 | A message ID is required. Data payload is optional. |
| 51 | test: none |
| 52 | end: |
| 53 | |
| 54 | function: rsSendToClient |
| 55 | ret: bool |
| 56 | arg: int cmdID |
| 57 | arg: const void* data |
| 58 | arg: uint len |
| 59 | test: none |
| 60 | end: |
| 61 | |
| 62 | function: rsSendToClientBlocking |
| 63 | ret: void |
| 64 | arg: int cmdID |
| 65 | summary: |
| 66 | description: |
| 67 | Send a message back to the client, blocking until the message is queued. |
| 68 | A message ID is required. Data payload is optional. |
| 69 | test: none |
| 70 | end: |
| 71 | |
| 72 | function: rsSendToClientBlocking |
| 73 | ret: void |
| 74 | arg: int cmdID |
| 75 | arg: const void* data |
| 76 | arg: uint len |
| 77 | test: none |
| 78 | end: |