SocketLogger.swift 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. //
  2. // SocketLogger.swift
  3. // Socket.IO-Client-Swift
  4. //
  5. // Created by Erik Little on 4/11/15.
  6. //
  7. // Permission is hereby granted, free of charge, to any person obtaining a copy
  8. // of this software and associated documentation files (the "Software"), to deal
  9. // in the Software without restriction, including without limitation the rights
  10. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11. // copies of the Software, and to permit persons to whom the Software is
  12. // furnished to do so, subject to the following conditions:
  13. //
  14. // The above copyright notice and this permission notice shall be included in
  15. // all copies or substantial portions of the Software.
  16. //
  17. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  23. // THE SOFTWARE.
  24. import Foundation
  25. /// Represents a class will log client events.
  26. public protocol SocketLogger : AnyObject {
  27. // MARK: Properties
  28. /// Whether to log or not
  29. var log: Bool { get set }
  30. // MARK: Methods
  31. /// Normal log messages
  32. ///
  33. /// - parameter message: The message being logged. Can include `%@` that will be replaced with `args`
  34. /// - parameter type: The type of entity that called for logging.
  35. /// - parameter args: Any args that should be inserted into the message. May be left out.
  36. func log(_ message: @autoclosure () -> String, type: String)
  37. /// Error Messages
  38. ///
  39. /// - parameter message: The message being logged. Can include `%@` that will be replaced with `args`
  40. /// - parameter type: The type of entity that called for logging.
  41. /// - parameter args: Any args that should be inserted into the message. May be left out.
  42. func error(_ message: @autoclosure () -> String, type: String)
  43. }
  44. public extension SocketLogger {
  45. /// Default implementation.
  46. func log(_ message: @autoclosure () -> String, type: String) {
  47. guard log else { return }
  48. abstractLog("LOG", message: message(), type: type)
  49. }
  50. /// Default implementation.
  51. func error(_ message: @autoclosure () -> String, type: String) {
  52. guard log else { return }
  53. abstractLog("ERROR", message: message(), type: type)
  54. }
  55. private func abstractLog(_ logType: String, message: @autoclosure () -> String, type: String) {
  56. NSLog("\(logType) \(type): %@", message())
  57. }
  58. }
  59. class DefaultSocketLogger : SocketLogger {
  60. static var Logger: SocketLogger = DefaultSocketLogger()
  61. var log = false
  62. }