| paul@90 | 1 | /* |
| paul@90 | 2 | * Filesystem client functions. |
| paul@90 | 3 | * |
| paul@90 | 4 | * Copyright (C) 2018, 2019, 2020, 2021 Paul Boddie <paul@boddie.org.uk> |
| paul@90 | 5 | * |
| paul@90 | 6 | * This program is free software; you can redistribute it and/or |
| paul@90 | 7 | * modify it under the terms of the GNU General Public License as |
| paul@90 | 8 | * published by the Free Software Foundation; either version 2 of |
| paul@90 | 9 | * the License, or (at your option) any later version. |
| paul@90 | 10 | * |
| paul@90 | 11 | * This program is distributed in the hope that it will be useful, |
| paul@90 | 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| paul@90 | 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| paul@90 | 14 | * GNU General Public License for more details. |
| paul@90 | 15 | * |
| paul@90 | 16 | * You should have received a copy of the GNU General Public License |
| paul@90 | 17 | * along with this program; if not, write to the Free Software |
| paul@90 | 18 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, |
| paul@90 | 19 | * Boston, MA 02110-1301, USA |
| paul@90 | 20 | */ |
| paul@90 | 21 | |
| paul@90 | 22 | #pragma once |
| paul@90 | 23 | |
| paul@99 | 24 | #include <fsclient/file.h> |
| paul@99 | 25 | |
| paul@99 | 26 | |
| paul@90 | 27 | |
| paul@90 | 28 | EXTERN_C_BEGIN |
| paul@90 | 29 | |
| paul@117 | 30 | /* Opening and closing operations. */ |
| paul@90 | 31 | |
| paul@90 | 32 | void client_close(file_t *file); |
| paul@90 | 33 | file_t *client_open(const char *name, flags_t flags); |
| paul@135 | 34 | file_t *client_open_using(const char *name, flags_t flags, const char *cap); |
| paul@90 | 35 | long client_pipe(file_t **reader, file_t **writer); |
| paul@135 | 36 | long client_pipe_using(file_t **reader, file_t **writer, const char *cap); |
| paul@90 | 37 | |
| paul@90 | 38 | /* File and region operations. */ |
| paul@90 | 39 | |
| paul@90 | 40 | long client_flush(file_t *file); |
| paul@90 | 41 | void *client_mmap(file_t *file, offset_t position, offset_t length); |
| paul@90 | 42 | |
| paul@90 | 43 | /* Pipe region operations. */ |
| paul@90 | 44 | |
| paul@116 | 45 | long client_current_region(file_t *file); |
| paul@116 | 46 | long client_next_region(file_t *file); |
| paul@90 | 47 | |
| paul@90 | 48 | /* File data operations. */ |
| paul@90 | 49 | |
| paul@90 | 50 | offset_t client_read(file_t *file, void *buf, offset_t count); |
| paul@90 | 51 | offset_t client_write(file_t *file, const void *buf, offset_t count); |
| paul@90 | 52 | |
| paul@90 | 53 | /* File navigation operations. */ |
| paul@90 | 54 | |
| paul@90 | 55 | offset_t client_seek(file_t *file, offset_t offset, int whence); |
| paul@90 | 56 | long client_tell(file_t *file); |
| paul@90 | 57 | |
| paul@117 | 58 | /* Notification operations. */ |
| paul@117 | 59 | |
| paul@122 | 60 | long client_set_blocking(file_t *file, notify_flags_t flags); |
| paul@121 | 61 | long client_subscribe(file_t *file, notify_flags_t flags); |
| paul@117 | 62 | long client_unsubscribe(file_t *file); |
| paul@123 | 63 | long client_wait_file(file_t *file); |
| paul@123 | 64 | long client_wait_files(file_t **file); |
| paul@117 | 65 | |
| paul@90 | 66 | EXTERN_C_END |
| paul@90 | 67 | |
| paul@90 | 68 | // vim: tabstop=2 expandtab shiftwidth=2 |
