NSObject(FMDatabasePoolDelegate).html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>NSObject(FMDatabasePoolDelegate) Category Reference</title>
  5. <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
  6. <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
  7. <meta charset='utf-8'>
  8. <script src="../js/jquery.min.js" defer></script>
  9. <script src="../js/jazzy.js" defer></script>
  10. </head>
  11. <body>
  12. <a name="//apple_ref/objc/Extension/NSObject(FMDatabasePoolDelegate)" class="dashAnchor"></a>
  13. <a title="NSObject(FMDatabasePoolDelegate) Category Reference"></a>
  14. <header>
  15. <div class="content-wrapper">
  16. <p><a href="../index.html">FMDB 2.7.7 Docs</a> (89% documented)</p>
  17. <p class="header-right"><a href="https://github.com/ccgus/fmdb"><img src="../img/gh.png"/>View on GitHub</a></p>
  18. </div>
  19. </header>
  20. <div class="content-wrapper">
  21. <p id="breadcrumbs">
  22. <a href="../index.html">FMDB Reference</a>
  23. <img id="carat" src="../img/carat.png" />
  24. NSObject(FMDatabasePoolDelegate) Category Reference
  25. </p>
  26. </div>
  27. <div class="content-wrapper">
  28. <nav class="sidebar">
  29. <ul class="nav-groups">
  30. <li class="nav-group-name">
  31. <a href="../Categories.html">Categories</a>
  32. <ul class="nav-group-tasks">
  33. <li class="nav-group-task">
  34. <a href="../Categories/NSObject%28FMDatabasePoolDelegate%29.html">NSObject(FMDatabasePoolDelegate)</a>
  35. </li>
  36. </ul>
  37. </li>
  38. <li class="nav-group-name">
  39. <a href="../Classes.html">Classes</a>
  40. <ul class="nav-group-tasks">
  41. <li class="nav-group-task">
  42. <a href="../Classes/FMDatabase.html">FMDatabase</a>
  43. </li>
  44. <li class="nav-group-task">
  45. <a href="../Classes/FMDatabasePool.html">FMDatabasePool</a>
  46. </li>
  47. <li class="nav-group-task">
  48. <a href="../Classes/FMDatabaseQueue.html">FMDatabaseQueue</a>
  49. </li>
  50. <li class="nav-group-task">
  51. <a href="../Classes/FMResultSet.html">FMResultSet</a>
  52. </li>
  53. <li class="nav-group-task">
  54. <a href="../Classes/FMStatement.html">FMStatement</a>
  55. </li>
  56. </ul>
  57. </li>
  58. <li class="nav-group-name">
  59. <a href="../Constants.html">Constants</a>
  60. <ul class="nav-group-tasks">
  61. <li class="nav-group-task">
  62. <a href="../Constants.html#/c:@FMDBVersionNumber">FMDBVersionNumber</a>
  63. </li>
  64. <li class="nav-group-task">
  65. <a href="../Constants.html#/c:@FMDBVersionString">FMDBVersionString</a>
  66. </li>
  67. </ul>
  68. </li>
  69. <li class="nav-group-name">
  70. <a href="../Enums.html">Enumerations</a>
  71. <ul class="nav-group-tasks">
  72. <li class="nav-group-task">
  73. <a href="../Enums/FMDBCheckpointMode.html">FMDBCheckpointMode</a>
  74. </li>
  75. <li class="nav-group-task">
  76. <a href="../Enums/SqliteValueType.html">SqliteValueType</a>
  77. </li>
  78. </ul>
  79. </li>
  80. <li class="nav-group-name">
  81. <a href="../Type%20Definitions.html">Type Definitions</a>
  82. <ul class="nav-group-tasks">
  83. <li class="nav-group-task">
  84. <a href="../Type%20Definitions.html#/c:FMDatabase.h@T@FMDBExecuteStatementsCallbackBlock">FMDBExecuteStatementsCallbackBlock</a>
  85. </li>
  86. </ul>
  87. </li>
  88. </ul>
  89. </nav>
  90. <article class="main-content">
  91. <section>
  92. <section class="section">
  93. <h1>NSObject(FMDatabasePoolDelegate)</h1>
  94. <div class="declaration">
  95. <div class="language">
  96. <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">NSObject</span> <span class="p">(</span><span class="nl">FMDatabasePoolDelegate</span><span class="p">)</span></code></pre>
  97. </div>
  98. </div>
  99. <p>FMDatabasePool delegate category</p>
  100. <p>This is a category that defines the protocol for the FMDatabasePool delegate</p>
  101. </section>
  102. <section class="section task-group-section">
  103. <div class="task-group">
  104. <ul>
  105. <li class="item">
  106. <div>
  107. <code>
  108. <a name="/c:objc(cs)NSObject(im)databasePool:shouldAddDatabaseToPool:"></a>
  109. <a name="//apple_ref/objc/Method/-databasePool:shouldAddDatabaseToPool:" class="dashAnchor"></a>
  110. <a class="token" href="#/c:objc(cs)NSObject(im)databasePool:shouldAddDatabaseToPool:">-databasePool:<wbr>shouldAddDatabaseToPool:<wbr></a>
  111. </code>
  112. </div>
  113. <div class="height-container">
  114. <div class="pointer-container"></div>
  115. <section class="section">
  116. <div class="pointer"></div>
  117. <div class="abstract">
  118. <p>Asks the delegate whether database should be added to the pool. </p>
  119. </div>
  120. <div class="declaration">
  121. <h4>Declaration</h4>
  122. <div class="language">
  123. <p class="aside-title">Objective-C</p>
  124. <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">databasePool</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/FMDatabasePool.html">FMDatabasePool</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">pool</span>
  125. <span class="nf">shouldAddDatabaseToPool</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/FMDatabase.html">FMDatabase</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">database</span><span class="p">;</span></code></pre>
  126. </div>
  127. <div class="language">
  128. <p class="aside-title">Swift</p>
  129. <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">databasePool</span><span class="p">(</span><span class="n">_</span> <span class="nv">pool</span><span class="p">:</span> <span class="kt"><a href="../Classes/FMDatabasePool.html">FMDatabasePool</a></span><span class="p">,</span> <span class="n">shouldAddDatabaseToPool</span> <span class="nv">database</span><span class="p">:</span> <span class="kt"><a href="../Classes/FMDatabase.html">FMDatabase</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
  130. </div>
  131. </div>
  132. <div>
  133. <h4>Parameters</h4>
  134. <table class="graybox">
  135. <tbody>
  136. <tr>
  137. <td>
  138. <code>
  139. <em>pool</em>
  140. </code>
  141. </td>
  142. <td>
  143. <div>
  144. <p>The <code><a href="../Classes/FMDatabasePool.html">FMDatabasePool</a></code> object.</p>
  145. </div>
  146. </td>
  147. </tr>
  148. <tr>
  149. <td>
  150. <code>
  151. <em>database</em>
  152. </code>
  153. </td>
  154. <td>
  155. <div>
  156. <p>The <code><a href="../Classes/FMDatabase.html">FMDatabase</a></code> object.</p>
  157. </div>
  158. </td>
  159. </tr>
  160. </tbody>
  161. </table>
  162. </div>
  163. <div>
  164. <h4>Return Value</h4>
  165. <p><code>YES</code> if it should add database to pool; <code>NO</code> if not.</p>
  166. </div>
  167. </section>
  168. </div>
  169. </li>
  170. <li class="item">
  171. <div>
  172. <code>
  173. <a name="/c:objc(cs)NSObject(im)databasePool:didAddDatabase:"></a>
  174. <a name="//apple_ref/objc/Method/-databasePool:didAddDatabase:" class="dashAnchor"></a>
  175. <a class="token" href="#/c:objc(cs)NSObject(im)databasePool:didAddDatabase:">-databasePool:<wbr>didAddDatabase:<wbr></a>
  176. </code>
  177. </div>
  178. <div class="height-container">
  179. <div class="pointer-container"></div>
  180. <section class="section">
  181. <div class="pointer"></div>
  182. <div class="abstract">
  183. <p>Tells the delegate that database was added to the pool.</p>
  184. </div>
  185. <div class="declaration">
  186. <h4>Declaration</h4>
  187. <div class="language">
  188. <p class="aside-title">Objective-C</p>
  189. <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">databasePool</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/FMDatabasePool.html">FMDatabasePool</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">pool</span>
  190. <span class="nf">didAddDatabase</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/FMDatabase.html">FMDatabase</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">database</span><span class="p">;</span></code></pre>
  191. </div>
  192. <div class="language">
  193. <p class="aside-title">Swift</p>
  194. <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">databasePool</span><span class="p">(</span><span class="n">_</span> <span class="nv">pool</span><span class="p">:</span> <span class="kt"><a href="../Classes/FMDatabasePool.html">FMDatabasePool</a></span><span class="p">,</span> <span class="n">didAdd</span> <span class="nv">database</span><span class="p">:</span> <span class="kt"><a href="../Classes/FMDatabase.html">FMDatabase</a></span><span class="p">)</span></code></pre>
  195. </div>
  196. </div>
  197. <div>
  198. <h4>Parameters</h4>
  199. <table class="graybox">
  200. <tbody>
  201. <tr>
  202. <td>
  203. <code>
  204. <em>pool</em>
  205. </code>
  206. </td>
  207. <td>
  208. <div>
  209. <p>The <code><a href="../Classes/FMDatabasePool.html">FMDatabasePool</a></code> object.</p>
  210. </div>
  211. </td>
  212. </tr>
  213. <tr>
  214. <td>
  215. <code>
  216. <em>database</em>
  217. </code>
  218. </td>
  219. <td>
  220. <div>
  221. <p>The <code><a href="../Classes/FMDatabase.html">FMDatabase</a></code> object.</p>
  222. </div>
  223. </td>
  224. </tr>
  225. </tbody>
  226. </table>
  227. </div>
  228. </section>
  229. </div>
  230. </li>
  231. </ul>
  232. </div>
  233. </section>
  234. </section>
  235. <section id="footer">
  236. <p>&copy; 2020 <a class="link" href="https://github.com/ccgus/fmdb" target="_blank" rel="external">Gus Mueller, Flying Meat</a>. All rights reserved. (Last updated: 2020-05-09)</p>
  237. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  238. </section>
  239. </article>
  240. </div>
  241. </body>
  242. </div>
  243. </html>