1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../css/manpage.css" type="text/css" />
7<title>SuspendScheduler</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../nn/Overview.html">nn</a>::<a href="../../nn/ndm/Overview.html">ndm</a>::SuspendScheduler</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../nn/Result/Overview.html">Result</a> SuspendScheduler(
15     bool bAsync = false
16);
17</pre>
18    </div>
19<h2>Parameters</h2>
20    <div class="section">
21      <table class="arguments">
22        <thead>
23          <tr>
24            <td width="15" />
25<th>Name</th>
26<td>Description</td>
27          </tr>
28        </thead>
29        <tr>
30<td>in</td>
31<th>bAsync</th>
32<td>Specify <CODE>true</CODE> to return from the process without waiting for the suspension to complete. Specify this when you do not need to know whether suspension has completed and want to quickly perform the next process. Normally, you should specify false.</td>
33        </tr> </table>
34    </div>
35<h2>Return Values</h2>
36<div class="section">Returns a value that indicates whether the function succeeded.<br /> <br />
37      <table class="arguments">
38        <thead>
39          <tr>
40<th>Value</th>
41<td>Description</td>
42          </tr>
43        </thead>
44        <tr>
45<th>ResultInvalidOperation</th>
46<td>There are too many suspend operations.</td>
47        </tr>
48      </table> </div>
49<h2>Description</h2>
50    <div class="section">
51<p>Suspends the daemon manager that handles scheduling for all network daemons.</p><p><B>Note</B>: This function halts all <CODE><a href="../../nn/ndm/CTR/Overview.html">CTR</a></CODE> background processing. Be fully aware of the side effects and give close attention to the timing of calling this function.<br /><br />Autonomous network connections and all autonomous daemon operations are suspended while scheduling is suspended. Any daemons currently connected to the network will be disconnected immediately. The requests to stop scheduling are managed by a counter, so they can be nested. This will halt all autonomous network processing. You should thus use <CODE><a href="../../nn/ndm/Suspend.html">Suspend</a></CODE> or <CODE><a href="../../nn/ndm/SuspendDaemons.html">SuspendDaemons</a></CODE> to halt one or more specific daemons unless you have strong reasons not to.</p><p>If you want to conduct communication in the foreground using an Internet connection (for example, <CODE>nn::ac::Connect</CODE> or <CODE>nn::friends::Login</CODE>), only call <CODE>SuspendScheduler</CODE> when needed, and when these connections have finished their processing. This will enable you to halt just the features you do not need, without wasted work or resources.<br /><br /><B>Note</B>: Calling <CODE> nn::friends::Login</CODE> immediately after calling <CODE>SuspendScheduler</CODE> will cause the system to log out from the friend server and then log back in over a short time frame, which violates the guideline.</p><!-- write here --></div>
52<h2>Revision History</h2>
53    <div class="section">
54      <dl class="history">
55        <dt>2010/08/16</dt>
56<dd>Initial version.<br />
57        </dd>
58      </dl>
59    </div>
60  <hr><p>CONFIDENTIAL</p></body>
61</html>