-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2b344d5
commit 6ecc83d
Showing
44 changed files
with
5,001 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,65 @@ | ||
| # AdvancedLogger | ||
| We create logger for our app | ||
| We create logger for our app. This framework in developing! | ||
| All operation execution in orher queue and you shouldnt think about manage queue | ||
|
|
||
| # Usage | ||
|
|
||
| ## Standart use | ||
|
|
||
| 1) Import in project | ||
|
|
||
| ```swift | ||
| import AdvancedLogger | ||
| ``` | ||
|
|
||
| 2) For write log use this with [model of log](Structs.html#/s:14AdvancedLogger0aB5ModelV) with [type of log](Enums/AdvancedLoggerEvent.html) | ||
|
|
||
| ```swift | ||
| AdvancedLogger.shared.addNew(log: *MODEL OF LOG*, type: *TYPE OF LOG) | ||
| ``` | ||
|
|
||
| 3) For read log in AdvancedLoggerModel use this | ||
|
|
||
| ```swift | ||
| AdvancedLogger.shared.getLogs { (model) in } | ||
| ``` | ||
| where [model](Structs.html#/s:14AdvancedLogger0aB5ModelV) - array of logs | ||
|
|
||
| 4) For read in JSON Encoding Data fromat use | ||
|
|
||
| ```swift | ||
| AdvancedLogger.shared.getJSONDataLogs { (model) in } | ||
| ``` | ||
| where model - Data encoding JSON array of logs | ||
|
|
||
| 5) For clean logs use | ||
|
|
||
| ```swift | ||
| AdvancedLogger.shared.cleanLogs() | ||
| ``` | ||
|
|
||
| ## Crypto | ||
|
|
||
| Our framework support crypto encode\decode | ||
| For use crypto in logs set crypto to enable | ||
|
|
||
| ```swift | ||
| AdvancedLogger.shared.encryptData = true | ||
| ``` | ||
|
|
||
| For use custom keys use this: | ||
|
|
||
| ```swift | ||
| AdvancedLogger.shared.aesCryptoKeys = ALAESCryptoInitModel(cryptoKey: *YOUR KEY*, initialVector: *YOUR VALUE*) | ||
| ``` | ||
|
|
||
| ## Memory usage | ||
|
|
||
| All logs stored on FileManager of devices. And it use auto clean logs (on FIFO principle). | ||
|
|
||
| You can set custom size of logs in byte count format | ||
|
|
||
| ```swift | ||
| AdvancedLogger.shared.logFileSize = 1024 | ||
| ``` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <title>Enumerations Reference</title> | ||
| <link rel="stylesheet" type="text/css" href="css/jazzy.css" /> | ||
| <link rel="stylesheet" type="text/css" href="css/highlight.css" /> | ||
| <meta charset='utf-8'> | ||
| <script src="js/jquery.min.js" defer></script> | ||
| <script src="js/jazzy.js" defer></script> | ||
|
|
||
| </head> | ||
| <body> | ||
| <a name="//apple_ref/swift/Section/Enumerations" class="dashAnchor"></a> | ||
| <a title="Enumerations Reference"></a> | ||
| <header> | ||
| <div class="content-wrapper"> | ||
| <p><a href="index.html">AdvancedLogger 1.0.0 Docs</a> (97% documented)</p> | ||
| </div> | ||
| </header> | ||
| <div class="content-wrapper"> | ||
| <p id="breadcrumbs"> | ||
| <a href="index.html">AdvancedLogger Reference</a> | ||
| <img id="carat" src="img/carat.png" /> | ||
| Enumerations Reference | ||
| </p> | ||
| </div> | ||
| <div class="content-wrapper"> | ||
| <nav class="sidebar"> | ||
| <ul class="nav-groups"> | ||
| <li class="nav-group-name"> | ||
| <a href="Enums.html">Enumerations</a> | ||
| <ul class="nav-group-tasks"> | ||
| <li class="nav-group-task"> | ||
| <a href="Enums/AdvancedLoggerEvent.html">AdvancedLoggerEvent</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li class="nav-group-name"> | ||
| <a href="Protocols.html">Protocols</a> | ||
| <ul class="nav-group-tasks"> | ||
| <li class="nav-group-task"> | ||
| <a href="Protocols/AdvancedLoggerProtocol.html">AdvancedLoggerProtocol</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li class="nav-group-name"> | ||
| <a href="Structs.html">Structures</a> | ||
| <ul class="nav-group-tasks"> | ||
| <li class="nav-group-task"> | ||
| <a href="Structs/ALAESCryptoInitModel.html">ALAESCryptoInitModel</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Structs/AdvancedLogger.html">AdvancedLogger</a> | ||
| </li> | ||
| <li class="nav-group-task"> | ||
| <a href="Structs.html#/s:14AdvancedLogger0aB5ModelV">AdvancedLoggerModel</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </nav> | ||
| <article class="main-content"> | ||
| <section> | ||
| <section class="section"> | ||
| <h1>Enumerations</h1> | ||
| <p>The following enumerations are available globally.</p> | ||
|
|
||
| </section> | ||
| <section class="section task-group-section"> | ||
| <div class="task-group"> | ||
| <ul> | ||
| <li class="item"> | ||
| <div> | ||
| <code> | ||
| <a name="/s:14AdvancedLogger0aB5EventO"></a> | ||
| <a name="//apple_ref/swift/Enum/AdvancedLoggerEvent" class="dashAnchor"></a> | ||
| <a class="token" href="#/s:14AdvancedLogger0aB5EventO">AdvancedLoggerEvent</a> | ||
| </code> | ||
| </div> | ||
| <div class="height-container"> | ||
| <div class="pointer-container"></div> | ||
| <section class="section"> | ||
| <div class="pointer"></div> | ||
| <div class="abstract"> | ||
| <p>Log type for write. Containt different event like warning\crash\etc</p> | ||
|
|
||
| <a href="Enums/AdvancedLoggerEvent.html" class="slightly-smaller">See more</a> | ||
| </div> | ||
| <div class="declaration"> | ||
| <h4>Declaration</h4> | ||
| <div class="language"> | ||
| <p class="aside-title">Swift</p> | ||
| <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">AdvancedLoggerEvent</span></code></pre> | ||
| <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">AdvancedLoggerEvent</span><span class="p">:</span> <span class="kt">Codable</span></code></pre> | ||
|
|
||
| </div> | ||
| </div> | ||
| </section> | ||
| </div> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| </section> | ||
| </section> | ||
| <section id="footer"> | ||
| <p>© 2020 <a class="link" href="https://github.com/ESKARIA/AdvancedLogger.git" target="_blank" rel="external">Dmitriy Toropkin</a>. All rights reserved. (Last updated: 2020-04-30)</p> | ||
| <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> | ||
| </section> | ||
| </article> | ||
| </div> | ||
| </body> | ||
| </div> | ||
| </html> |
Oops, something went wrong.