Skip to content
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

Jump to bottom

Improve LAPinger documentation for clarity #1910

Merged
merged 2 commits into from Sep 13, 2017
Merged

Improve LAPinger documentation for clarity #1910

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06aeb5c
Improve LAPinger documentation for clarity
farmdawgnation Aug 31, 2017
77c2e9a
Further iteration on LAPinger doc
farmdawgnation Sep 13, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 5 additions & 2 deletions core/actor/src/main/scala/net/liftweb/actor/LAPinger.scala
View file
Open in desktop
Expand Up @@ -34,8 +34,8 @@ object ThreadPoolRules {
}

/**
* The ActorPing object schedules an actor to be ping-ed with a given message at specific intervals.
* The schedule methods return a ScheduledFuture object which can be cancelled if necessary
* The LAPinger object schedules a LiftActor to be pinged "delay" miliseconds in the future.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original phrasing seems clearer to me here (class names aside). delay doesn't really have a meaning at the level of the singleton that I can see.

* The schedule method return a ScheduledFuture object which can be cancelled if necessary.
*/
object LAPinger {

Expand All @@ -60,6 +60,9 @@ object LAPinger {
/**
* Schedules the sending of a message to occur after the specified delay.
*
* @param to The LiftActor to send the message to.
* @param msg The message to send.
* @param delay The number of milliseconds to delay before sending msg
* @return a <code>ScheduledFuture</code> which sends the <code>msg</code> to
* the <code>to<code> Actor after the specified TimeSpan <code>delay</code>.
*/
Expand Down