Thanks to visit codestin.com
Credit goes to github.com

Skip to content

new endpoint LXManuallyRotatingFileEndpoint #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

new endpoint LXManuallyRotatingFileEndpoint #15

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d025e76
addec LXManuallyRotatingFileEndpoint
rabidaudio Feb 16, 2016
7d3d327
added notification listener for rotates
rabidaudio Feb 16, 2016
c0d9aa2
fix some notifiation issues
rabidaudio Feb 16, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 82 additions & 23 deletions Source/FileEndpoints.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,13 @@ This notification is send _after_ the rotation occurs, but _before_ any pending
*/
public let LXFileEndpointDidRotateFilesNotification: String = "info.logkit.endpoint.fileEndpoint.didRotateFiles"

/**
This notification clients can post which will cause any `LXManuallyRotatingFileEndpoint` instances to rotate immediately.

The notification's `object` and `userInfo` fields are ignored.
*/
public let LXFileEndpointCauseRotationNotification: String = "info.logkit.endpoint.fileEndpoint.rotate"

/// The value found at this key is the `NSURL` of the sender's previous log file.
public let LXFileEndpointRotationPreviousURLKey: String = "info.logkit.endpoint.fileEndpoint.previousURL"

Expand Down Expand Up @@ -303,36 +310,41 @@ public class LXRotatingFileEndpoint: LXEndpoint {
if let data = string.dataUsingEncoding(NSUTF8StringEncoding) {
//TODO: might pass test but file fills before write
if let nextFile = self.rotateToFileBeforeWritingDataWithLength(data.length) {
//TODO: Move these notifications into property observers, if the properties can be made non-lazy.
//TODO: Getting `nextURL` from `nextFile`, instead of calculating it again, might be more robust.
NSNotificationCenter.defaultCenter().postNotificationName(
LXFileEndpointWillRotateFilesNotification,
object: self,
userInfo: [
LXFileEndpointRotationCurrentURLKey: self.currentURL,
LXFileEndpointRotationNextURLKey: self.nextURL
]
)

let previousURL = self.currentURL
self.currentFile = nextFile
self.currentIndex = self.nextIndex

NSNotificationCenter.defaultCenter().postNotificationName(
LXFileEndpointDidRotateFilesNotification,
object: self,
userInfo: [
LXFileEndpointRotationCurrentURLKey: self.currentURL,
LXFileEndpointRotationPreviousURLKey: previousURL
]
)
rotateTo(nextFile)
}
self.currentFile?.writeData(data)
} else {
assertionFailure("Failure to create data from entry string")
}
}

/// Sets the current file to the next index and notifies about rotation
private func rotateTo(nextFile: LXLogFile) {
//TODO: Move these notifications into property observers, if the properties can be made non-lazy.
//TODO: Getting `nextURL` from `nextFile`, instead of calculating it again, might be more robust.
NSNotificationCenter.defaultCenter().postNotificationName(
LXFileEndpointWillRotateFilesNotification,
object: self,
userInfo: [
LXFileEndpointRotationCurrentURLKey: self.currentURL,
LXFileEndpointRotationNextURLKey: self.nextURL
]
)

let previousURL = self.currentURL
self.currentFile = nextFile
self.currentIndex = self.nextIndex

NSNotificationCenter.defaultCenter().postNotificationName(
LXFileEndpointDidRotateFilesNotification,
object: self,
userInfo: [
LXFileEndpointRotationCurrentURLKey: self.currentURL,
LXFileEndpointRotationPreviousURLKey: previousURL
]
)
}

/// Clears the currently selected file and begins writing again at its beginning.
public func resetCurrentFile() {
self.currentFile?.reset()
Expand All @@ -359,6 +371,53 @@ public class LXRotatingFileEndpoint: LXEndpoint {
}


//MARK: Manually Rotated File Endpoint

/**
A version of LXRotatingFileEndpoint which can be manually rotated. Setting the max file size to 0 causes it to only rotate when
told to do so.
*/
public class LXManuallyRotatingFileEndpoint: LXRotatingFileEndpoint {

// Same as super initializer, except that the default file size is 0 (don't rotate)
public override init?(
baseURL: NSURL? = defaultLogFileURL,
numberOfFiles: UInt = 5,
maxFileSizeKiB: UInt = 0,
minimumPriorityLevel: LXPriorityLevel = .All,
dateFormatter: LXDateFormatter = LXDateFormatter.standardFormatter(),
entryFormatter: LXEntryFormatter = LXEntryFormatter.standardFormatter()
) {
super.init(baseURL: baseURL, numberOfFiles: numberOfFiles, maxFileSizeKiB: maxFileSizeKiB, minimumPriorityLevel: minimumPriorityLevel, dateFormatter: dateFormatter, entryFormatter: entryFormatter)
/// Listen for rotation notifications
NSNotificationCenter.defaultCenter().addObserver(self, selector: "rotateNotification:", name: LXFileEndpointCauseRotationNotification, object: nil)
}

@objc private func rotateNotification(notification: NSNotification){
rotate()
}

/**
Attempt to rotate to the next file in the cycle.
*/
public func rotate() {
//TODO: Should it throw if unable to rotate?
if let nextFile = LXLogFile(URL: self.nextURL, shouldAppend: false) {
rotateTo(nextFile)
}
}

/// Don't rotate before writing if the maximum file size is non-positive
override private func rotateToFileBeforeWritingDataWithLength(length: Int) -> LXLogFile? {
if self.maxFileSizeBytes <= 0 {
return nil
}else{
return super.rotateToFileBeforeWritingDataWithLength(length)
}
}
}


//MARK: File Endpoint

/// An Endpoint that writes Log Entries to a specified file.
Expand Down