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