PageRenderTime 79ms CodeModel.GetById 59ms app.highlight 16ms RepoModel.GetById 1ms app.codeStats 0ms

/core/sdk-objc/Documentation/GMUserFileSystem/Classes/GMUserFileSystem_/Methods/Methods.html

http://macfuse.googlecode.com/
HTML | 175 lines | 173 code | 2 blank | 0 comment | 0 complexity | 35ed4dd3a85ab76c6372a81a2ae15a96 MD5 | raw file
  1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/1998/REC-html40-19980424/loose.dtd">
  2<html>
  3<head>
  4<title>Methods</title>
  5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  6<meta name="generator" content="HeaderDoc">
  7<style type="text/css"><!--.keyword {background:#ffffff; color:#761550;}.template {background:#ffffff; color:#761550;}.number {background: #ffffff; color:#0000ff;}.function {background:#ffffff; color:#000000;}.string {background: #ffffff; color:#891315;}.preprocessor {background:#ffffff; color:#236e25}.comment {background:#ffffff; color:#236e25}.char {background: #ffffff; color:#0000ff;}.var {background:#ffffff; color:#000000;}.type {background:#ffffff; color:#761550;}.param {background:#ffffff; color:#000000;}a:link {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #0000ff;}a:visited {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #0000ff;}a:visited:hover {text-decoration: underline; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #ff6600;}a:active {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #ff6600;}a:hover {text-decoration: underline; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #ff6600;}h4 {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: tiny; font-weight: bold;}body {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: 10pt;}--></style>
  8</head>
  9<body bgcolor="#ffffff">
 10<a name="top"></a><a name="HeaderDoc_methods"></a><dl>
 11<dt><tt><a href="Methods.html#//apple_ref/occ/instm/GMUserFileSystem/initWithDelegate:isThreadSafe:" target="doc">-initWithDelegate:isThreadSafe: </a></tt></dt>
 12<dd>Initialize the user space file system.
 13</dd>
 14<dt><tt><a href="Methods.html#//apple_ref/occ/instm/GMUserFileSystem/setDelegate:" target="doc">-setDelegate:</a></tt></dt>
 15<dd>Set the file system delegate.
 16</dd>
 17<dt><tt><a href="Methods.html#//apple_ref/occ/instm/GMUserFileSystem/delegate" target="doc">-delegate</a></tt></dt>
 18<dd>Get the file system delegate.
 19</dd>
 20<dt><tt><a href="Methods.html#//apple_ref/occ/instm/GMUserFileSystem/mountAtPath:withOptions:" target="doc">-mountAtPath:withOptions: </a></tt></dt>
 21<dd>Mount the file system at the given path.
 22</dd>
 23<dt><tt><a href="Methods.html#//apple_ref/occ/instm/GMUserFileSystem/mountAtPath:withOptions:shouldForeground:detachNewThread:" target="doc">-mountAtPath:withOptions:shouldForeground:detachNewThread: </a></tt></dt>
 24<dd>Mount the file system at the given path with advanced options.
 25</dd>
 26<dt><tt><a href="Methods.html#//apple_ref/occ/instm/GMUserFileSystem/unmount" target="doc">-unmount </a></tt></dt>
 27<dd>Unmount the file system.
 28</dd>
 29</dl>
 30<hr>
 31<!-- headerDoc=instm;  uid=//apple_ref/occ/instm/GMUserFileSystem/initWithDelegate:isThreadSafe:;  name=GMUserFileSystem::initWithDelegate:isThreadSafe: --><a name="//apple_ref/occ/instm/GMUserFileSystem/initWithDelegate:isThreadSafe:"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5">
 32<h3><a name="initWithDelegate:isThreadSafe:">initWithDelegate:isThreadSafe: </a></h3>
 33</td></tr></table>
 34<hr>
 35<p><!-- begin abstract -->Initialize the user space file system.
 36<!-- end abstract --></p>
 37<p></p>
 38<pre>- (<!-- a logicalPath="//apple_ref/occ/cl/id //apple_ref/occ/tdef/id //apple_ref/occ/tag/id //apple_ref/occ/econst/id //apple_ref/occ/struct/id //apple_ref/occ/clconst/id //apple_ref/occ/intf/id" --><span class="type">id</span><!-- /a -->)<!-- a logicalPath="//apple_ref/occ/instm/initWithDelegate //apple_ref/occ/clm/initWithDelegate //apple_ref/occ/intfcm/initWithDelegate //apple_ref/occ/intfm/initWithDelegate //apple_ref/occ/func/initWithDelegate //apple_ref/occ/ftmplt/initWithDelegate //apple_ref/occ/defn/initWithDelegate //apple_ref/occ/macro/initWithDelegate" --><span class="function">initWithDelegate</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/id //apple_ref/occ/tdef/id //apple_ref/occ/tag/id //apple_ref/occ/econst/id //apple_ref/occ/struct/id //apple_ref/occ/clconst/id //apple_ref/occ/intf/id" --><span class="type">id</span><!-- /a -->)<span class="param">delegate</span> <!-- a logicalPath="//apple_ref/occ/instm/isThreadSafe //apple_ref/occ/clm/isThreadSafe //apple_ref/occ/intfcm/isThreadSafe //apple_ref/occ/intfm/isThreadSafe //apple_ref/occ/func/isThreadSafe //apple_ref/occ/ftmplt/isThreadSafe //apple_ref/occ/defn/isThreadSafe //apple_ref/occ/macro/isThreadSafe" --><span class="function">isThreadSafe</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/BOOL //apple_ref/occ/tdef/BOOL //apple_ref/occ/tag/BOOL //apple_ref/occ/econst/BOOL //apple_ref/occ/struct/BOOL //apple_ref/occ/clconst/BOOL //apple_ref/occ/intf/BOOL" --><span class="type">BOOL</span><!-- /a -->)<span class="var">isThreadSafe</span>; </pre>
 39<h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Parameters</font></h5>
 40<dl>
 41<dt><code>delegate </code></dt>
 42<dd>The file system delegate; implements the file system logic.</dd>
 43<dt><code>isThreadSafe </code></dt>
 44<dd>Is the file system delegate thread safe?</dd>
 45</dl>
 46<h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Return Value</font></h5>
 47<p><!-- begin return value -->A GMUserFileSystem instance.
 48 
 49<!-- end return value --></p>
 50<h5 class="tight">
 51<font face="Lucida Grande,Helvetica,Arial">Discussion</font>
 52</h5>
 53<p><!-- begin discussion -->The file system delegate should implement some or all of the
 54GMUserFileSystemOperations informal protocol. You should only specify YES
 55for isThreadSafe if your file system delegate is thread safe with respect to
 56file system operations. That implies that it implements proper file system
 57locking so that multiple operations on the same file can be done safely.
 58<!-- end discussion --></p>
 59<p></p>
 60<hr>
 61<!-- headerDoc=instm;  uid=//apple_ref/occ/instm/GMUserFileSystem/setDelegate:;  name=GMUserFileSystem::setDelegate: --><a name="//apple_ref/occ/instm/GMUserFileSystem/setDelegate:"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5">
 62<h3><a name="setDelegate:">setDelegate:</a></h3>
 63</td></tr></table>
 64<hr>
 65<p><!-- begin abstract -->Set the file system delegate.
 66<!-- end abstract --></p>
 67<p></p>
 68<pre>- (<!-- a logicalPath="//apple_ref/occ/cl/void //apple_ref/occ/tdef/void //apple_ref/occ/tag/void //apple_ref/occ/econst/void //apple_ref/occ/struct/void //apple_ref/occ/clconst/void //apple_ref/occ/intf/void" --><span class="type">void</span><!-- /a -->)<!-- a logicalPath="//apple_ref/occ/instm/setDelegate //apple_ref/occ/clm/setDelegate //apple_ref/occ/intfcm/setDelegate //apple_ref/occ/intfm/setDelegate //apple_ref/occ/func/setDelegate //apple_ref/occ/ftmplt/setDelegate //apple_ref/occ/defn/setDelegate //apple_ref/occ/macro/setDelegate" --><span class="function">setDelegate</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/id //apple_ref/occ/tdef/id //apple_ref/occ/tag/id //apple_ref/occ/econst/id //apple_ref/occ/struct/id //apple_ref/occ/clconst/id //apple_ref/occ/intf/id" --><span class="type">id</span><!-- /a -->)<span class="var">delegate</span>; </pre>
 69<h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Parameters</font></h5>
 70<dl>
 71<dt><code>delegate </code></dt>
 72<dd>The delegate to use from now on for this file system.</dd>
 73</dl>
 74<p></p>
 75<hr>
 76<!-- headerDoc=instm;  uid=//apple_ref/occ/instm/GMUserFileSystem/delegate;  name=GMUserFileSystem::delegate --><a name="//apple_ref/occ/instm/GMUserFileSystem/delegate"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5">
 77<h3><a name="delegate">delegate</a></h3>
 78</td></tr></table>
 79<hr>
 80<p><!-- begin abstract -->Get the file system delegate.
 81<!-- end abstract --></p>
 82<p></p>
 83<pre>- (<!-- a logicalPath="//apple_ref/occ/cl/id //apple_ref/occ/tdef/id //apple_ref/occ/tag/id //apple_ref/occ/econst/id //apple_ref/occ/struct/id //apple_ref/occ/clconst/id //apple_ref/occ/intf/id" --><span class="type">id</span><!-- /a -->)<span class="var">delegate</span>; </pre>
 84<h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Return Value</font></h5>
 85<p><!-- begin return value -->The file system delegate.
 86 
 87<!-- end return value --></p>
 88<p></p>
 89<hr>
 90<!-- headerDoc=instm;  uid=//apple_ref/occ/instm/GMUserFileSystem/mountAtPath:withOptions:;  name=GMUserFileSystem::mountAtPath:withOptions: --><a name="//apple_ref/occ/instm/GMUserFileSystem/mountAtPath:withOptions:"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5">
 91<h3><a name="mountAtPath:withOptions:">mountAtPath:withOptions: </a></h3>
 92</td></tr></table>
 93<hr>
 94<p><!-- begin abstract -->Mount the file system at the given path.
 95<!-- end abstract --></p>
 96<p></p>
 97<pre>- (<!-- a logicalPath="//apple_ref/occ/cl/void //apple_ref/occ/tdef/void //apple_ref/occ/tag/void //apple_ref/occ/econst/void //apple_ref/occ/struct/void //apple_ref/occ/clconst/void //apple_ref/occ/intf/void" --><span class="type">void</span><!-- /a -->)<!-- a logicalPath="//apple_ref/occ/instm/mountAtPath //apple_ref/occ/clm/mountAtPath //apple_ref/occ/intfcm/mountAtPath //apple_ref/occ/intfm/mountAtPath //apple_ref/occ/func/mountAtPath //apple_ref/occ/ftmplt/mountAtPath //apple_ref/occ/defn/mountAtPath //apple_ref/occ/macro/mountAtPath" --><span class="function">mountAtPath</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSString //apple_ref/occ/tdef/NSString //apple_ref/occ/tag/NSString //apple_ref/occ/econst/NSString //apple_ref/occ/struct/NSString //apple_ref/occ/clconst/NSString //apple_ref/occ/intf/NSString" --><span class="type">NSString</span><!-- /a --> <span class="type">*</span>)<span class="param">mountPath</span> <!-- a logicalPath="//apple_ref/occ/instm/withOptions //apple_ref/occ/clm/withOptions //apple_ref/occ/intfcm/withOptions //apple_ref/occ/intfm/withOptions //apple_ref/occ/func/withOptions //apple_ref/occ/ftmplt/withOptions //apple_ref/occ/defn/withOptions //apple_ref/occ/macro/withOptions" --><span class="function">withOptions</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSArray //apple_ref/occ/tdef/NSArray //apple_ref/occ/tag/NSArray //apple_ref/occ/econst/NSArray //apple_ref/occ/struct/NSArray //apple_ref/occ/clconst/NSArray //apple_ref/occ/intf/NSArray" --><span class="type">NSArray</span><!-- /a --> <span class="type">*</span>)<span class="var">options</span>; </pre>
 98<h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Parameters</font></h5>
 99<dl>
100<dt><code>mountPath </code></dt>
101<dd>The path to mount on, e.g. /Volumes/MyFileSystem</dd>
102<dt><code>options </code></dt>
103<dd>The set of mount time options to use.</dd>
104</dl>
105<h5 class="tight">
106<font face="Lucida Grande,Helvetica,Arial">Discussion</font>
107</h5>
108<p><!-- begin discussion -->Mounts the file system at mountPath with the given set of options.
109The set of available options can be found on the 
110<a href="http://code.google.com/p/macfuse/wiki/OPTIONS" target="_top">options</a> wiki page.
111For example, to turn on debug output add @"debug" to the options NSArray.
112If the mount succeeds, then a kGMUserFileSystemDidMount notification is posted
113to the default noification center. If the mount fails, then a 
114kGMUserFileSystemMountFailed notification will be posted instead.
115<!-- end discussion --></p>
116<p></p>
117<hr>
118<!-- headerDoc=instm;  uid=//apple_ref/occ/instm/GMUserFileSystem/mountAtPath:withOptions:shouldForeground:detachNewThread:;  name=GMUserFileSystem::mountAtPath:withOptions:shouldForeground:detachNewThread: --><a name="//apple_ref/occ/instm/GMUserFileSystem/mountAtPath:withOptions:shouldForeground:detachNewThread:"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5">
119<h3><a name="mountAtPath:withOptions:shouldForeground:detachNewThread:">mountAtPath:withOptions:shouldForeground:detachNewThread: </a></h3>
120</td></tr></table>
121<hr>
122<p><!-- begin abstract -->Mount the file system at the given path with advanced options.
123<!-- end abstract --></p>
124<p></p>
125<pre>- (<!-- a logicalPath="//apple_ref/occ/cl/void //apple_ref/occ/tdef/void //apple_ref/occ/tag/void //apple_ref/occ/econst/void //apple_ref/occ/struct/void //apple_ref/occ/clconst/void //apple_ref/occ/intf/void" --><span class="type">void</span><!-- /a -->)<!-- a logicalPath="//apple_ref/occ/instm/mountAtPath //apple_ref/occ/clm/mountAtPath //apple_ref/occ/intfcm/mountAtPath //apple_ref/occ/intfm/mountAtPath //apple_ref/occ/func/mountAtPath //apple_ref/occ/ftmplt/mountAtPath //apple_ref/occ/defn/mountAtPath //apple_ref/occ/macro/mountAtPath" --><span class="function">mountAtPath</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSString //apple_ref/occ/tdef/NSString //apple_ref/occ/tag/NSString //apple_ref/occ/econst/NSString //apple_ref/occ/struct/NSString //apple_ref/occ/clconst/NSString //apple_ref/occ/intf/NSString" --><span class="type">NSString</span><!-- /a --> <span class="type">*</span>)<span class="param">mountPath</span> <!-- a logicalPath="//apple_ref/occ/instm/withOptions //apple_ref/occ/clm/withOptions //apple_ref/occ/intfcm/withOptions //apple_ref/occ/intfm/withOptions //apple_ref/occ/func/withOptions //apple_ref/occ/ftmplt/withOptions //apple_ref/occ/defn/withOptions //apple_ref/occ/macro/withOptions" --><span class="function">withOptions</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSArray //apple_ref/occ/tdef/NSArray //apple_ref/occ/tag/NSArray //apple_ref/occ/econst/NSArray //apple_ref/occ/struct/NSArray //apple_ref/occ/clconst/NSArray //apple_ref/occ/intf/NSArray" --><span class="type">NSArray</span><!-- /a --> <span class="type">*</span>)<span class="param">options</span> <!-- a logicalPath="//apple_ref/occ/instm/shouldForeground //apple_ref/occ/clm/shouldForeground //apple_ref/occ/intfcm/shouldForeground //apple_ref/occ/intfm/shouldForeground //apple_ref/occ/func/shouldForeground //apple_ref/occ/ftmplt/shouldForeground //apple_ref/occ/defn/shouldForeground //apple_ref/occ/macro/shouldForeground" --><span class="function">shouldForeground</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/BOOL //apple_ref/occ/tdef/BOOL //apple_ref/occ/tag/BOOL //apple_ref/occ/econst/BOOL //apple_ref/occ/struct/BOOL //apple_ref/occ/clconst/BOOL //apple_ref/occ/intf/BOOL" --><span class="type">BOOL</span><!-- /a -->)<span class="param">shouldForeground</span> <span class="comment">// Recommend: YES</span> <!-- a logicalPath="//apple_ref/occ/instm/detachNewThread //apple_ref/occ/clm/detachNewThread //apple_ref/occ/intfcm/detachNewThread //apple_ref/occ/intfm/detachNewThread //apple_ref/occ/func/detachNewThread //apple_ref/occ/ftmplt/detachNewThread //apple_ref/occ/defn/detachNewThread //apple_ref/occ/macro/detachNewThread" --><span class="function">detachNewThread</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/BOOL //apple_ref/occ/tdef/BOOL //apple_ref/occ/tag/BOOL //apple_ref/occ/econst/BOOL //apple_ref/occ/struct/BOOL //apple_ref/occ/clconst/BOOL //apple_ref/occ/intf/BOOL" --><span class="type">BOOL</span><!-- /a -->)<span class="var">detachNewThread</span>; </pre>
126<h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Parameters</font></h5>
127<dl>
128<dt><code>mountPath </code></dt>
129<dd>The path to mount on, e.g. /Volumes/MyFileSystem</dd>
130<dt><code>options </code></dt>
131<dd>The set of mount time options to use.</dd>
132<dt><code>shouldForeground </code></dt>
133<dd>Should the file system thread remain foreground rather 
134than daemonize? (Recommend: YES)</dd>
135<dt><code>detachNewThread </code></dt>
136<dd>Should the file system run in a new thread rather than
137the current one? (Recommend: YES)</dd>
138</dl>
139<h5 class="tight">
140<font face="Lucida Grande,Helvetica,Arial">Discussion</font>
141</h5>
142<p><!-- begin discussion -->Mounts the file system at mountPath with the given set of options.
143This is an advanced version of <a href="../../../../../Documentation/GMUserFileSystem/Classes/GMUserFileSystem_/index.html?Methods/Methods.html#//apple_ref/occ/instm/GMUserFileSystem/mountAtPath:withOptions:" logicalPath="//apple_ref/occ/instm/GMUserFileSystem/mountAtPath:withOptions:" target="_top">mountAtPath:withOptions </a>
144You can use this to mount from a command-line program as follows:</p>
145<ul>
146<li>For an app, use: shouldForeground=YES, detachNewThread=YES
147</li>
148<li>For a daemon: shouldForeground=NO, detachNewThread=NO
149</li>
150<li>For debug output: shouldForeground=YES, detachNewThread=NO
151</li>
152<li>For a daemon+runloop: shouldForeground=NO, detachNewThread=YES<br>
153- NOTE: I've never tried daemon+runloop; maybe it doesn't make sense</li>
154</ul>
155<!-- end discussion --><p></p>
156<hr>
157<!-- headerDoc=instm;  uid=//apple_ref/occ/instm/GMUserFileSystem/unmount;  name=GMUserFileSystem::unmount --><a name="//apple_ref/occ/instm/GMUserFileSystem/unmount"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5">
158<h3><a name="unmount">unmount </a></h3>
159</td></tr></table>
160<hr>
161<p><!-- begin abstract -->Unmount the file system.
162<!-- end abstract --></p>
163<p></p>
164<pre>- (<!-- a logicalPath="//apple_ref/occ/cl/void //apple_ref/occ/tdef/void //apple_ref/occ/tag/void //apple_ref/occ/econst/void //apple_ref/occ/struct/void //apple_ref/occ/clconst/void //apple_ref/occ/intf/void" --><span class="type">void</span><!-- /a -->)<span class="var">unmount</span>; </pre>
165<h5 class="tight">
166<font face="Lucida Grande,Helvetica,Arial">Discussion</font>
167</h5>
168<p><!-- begin discussion -->Unmounts the file system. The kGMUserFileSystemDidUnmount
169notification will be posted.
170 <!-- end discussion --></p>
171<p></p>
172<p>Last Updated: Monday, November 17, 2008
173</p>
174</body>
175</html>