1/* $NetBSD: chan.h,v 1.1 2022/01/22 08:09:40 pho Exp $ */
2
3/*
4 * Copyright (c) 2021 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 * 3. The name of the author may not be used to endorse or promote
16 *    products derived from this software without specific prior written
17 *    permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
20 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
23 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
25 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
27 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31#if !defined(_FUSE_CHAN_H_)
32#define _FUSE_CHAN_H_
33
34/*
35 * Fuse communication channel API, appeared on FUSE 2.4.
36 */
37
38#if !defined(FUSE_H_)
39#  error Do not include this header directly. Include <fuse.h> instead.
40#endif
41
42#include <stdbool.h>
43#include <stddef.h>
44#include <sys/cdefs.h>
45
46#ifdef __cplusplus
47extern "C" {
48#endif
49
50/* An opaque object representing a communication channel. */
51struct fuse_chan;
52
53/* Implementation details. User code should never call these functions
54 * directly. */
55struct fuse;
56struct fuse_args;
57__BEGIN_HIDDEN_DECLS
58struct fuse_chan* fuse_chan_new(const char* mountpoint, const struct fuse_args* args);
59void              fuse_chan_destroy(struct fuse_chan* chan);
60
61int               fuse_chan_stash(struct fuse_chan* chan);
62struct fuse_chan* fuse_chan_peek(int idx);
63struct fuse_chan* fuse_chan_take(int idx);
64struct fuse_chan* fuse_chan_find(bool (*pred)(struct fuse_chan* chan, void* priv),
65                                 int* found_idx, void* priv);
66
67void              fuse_chan_set_fuse(struct fuse_chan* chan, struct fuse* fuse);
68void              fuse_chan_set_to_be_destroyed(struct fuse_chan* chan, bool is_to_be_destroyed);
69
70const char*       fuse_chan_mountpoint(const struct fuse_chan* chan);
71struct fuse_args* fuse_chan_args(struct fuse_chan* chan);
72struct fuse*      fuse_chan_fuse(struct fuse_chan* chan);
73bool              fuse_chan_is_to_be_destroyed(const struct fuse_chan* chan);
74__END_HIDDEN_DECLS
75
76#ifdef __cplusplus
77}
78#endif
79
80#endif
81