Copyright (c) 2007 Antti Kantee. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
.Dd January 19, 2007 .Dt PUFFS_CC 3 .Os .Sh NAME .Nm puffs_cc .Nd puffs continuation routines .Sh LIBRARY .Lb libpuffs .Sh SYNOPSIS n puffs.h .Ft struct puffs_usermount * .Fn puffs_cc_getusermount "struct puffs_cc *" .Ft void .Fn puffs_cc_yield(struct puffs_cc *pcc) .Ft void .Fn puffs_cc_continue(struct puffs_cc *pcc) .Sh DESCRIPTION .Em IMPORTANT NOTE! This document describes interfaces which are not yet guaranteed to be stable. In case you update your system sources, please recompile everything and fix complation errors. If your sources are out-of-sync, incorrect operation may result. The interfaces in this document will most likely be hugely simplified in later versions or made transparent to the implementation.
p These functions enable the use of continuations within the framework. Every operation callback within a file system implementation is automatically passed an opaque cookie, .Va pcc , to be used as a continuation handle.
p File systems using continuations should define their own even loop instead of using .Fn puffs_mainloop .
p Calling .Fn puffs_cc_yield will suspend and save the current execution context and return control to the previous point. Likewise, calling .Fn puffs_cc_continue will suspend current execution and return control to where it was before before calling .Fn puffs_cc_yield .
p Before calling .Fn puffs_cc_yield a file system will typically want to record some cookie value into its own internal bookkeeping. This cookie should be hooked to the .Va pcc so that the correct continuation can be continued when the event it was waiting for triggers.
p The puffs ssh file system is supposed to be the canonical example for the use of the continuation framework. .Sh SEE ALSO .Xr mount_psshfs 8 , .Xr puffs 3