Commit 023f652f authored by bozimmerman's avatar bozimmerman

tiny bit of javadoccing.

git-svn-id: svn://192.168.1.10/public/CoffeeMud@15468 0d6f1817-ed0e-0410-87c9-987e46238f29
parent 2806b939
......@@ -2033,28 +2033,44 @@ public interface DatabaseEngine extends CMLibrary
/**
* Table category: DBBACKLOG
*
* @param channelName
* @param entry
* Adds a CHANNEL message to the backlog table
* @see DatabaseEngine#getBackLogEntries(String, int, int)
* @see DatabaseEngine#trimBackLogEntries(String[], int, long)
* @param channelName the unique name of the channel
* @param entry message
*/
public void addBackLogEntry(String channelName, final String entry);
/**
* Table category: DBBACKLOG
* Returns a list of channel messages for the given channel and criteria.
* The list returned includes the message, and the timestamp of the
* message. The list is date-sorted, so list returns can ge "paged"
* by setting the number to skip and the number to return.
*
* @see DatabaseEngine#addBackLogEntry(String, String)
* @see DatabaseEngine#trimBackLogEntries(String[], int, long)
*
* @param channelName
* @param newestToSkip
* @param numToReturn
* @return
* @param channelName the unique name of the channel to return messages from
* @param newestToSkip the number of "newest" messages to skip
* @param numToReturn the number of total messages to return
* @return a list of applicable messages, coded as string,timestamp
*/
public List<Pair<String,Long>> getBackLogEntries(String channelName, final int newestToSkip, final int numToReturn);
/**
* Table category: DBBACKLOG
* This is a periodic maintenance method which will go through the
* list of unique channel names, and trim them according to the maximum
* number of messages to retain (absolute), and the oldest message
* to return (absolute timestamp -- no 0 nonsense). Both criteria
* will be used in the trimming.
* @see DatabaseEngine#getBackLogEntries(String, int, int)
* @see DatabaseEngine#addBackLogEntry(String, String)
*
* @param channels
* @param maxMessages
* @param oldestTime
* @param channels the list of channels to go through.
* @param maxMessages the maximum number of messages to retain
* @param oldestTime the oldest message to retain
*/
public void trimBackLogEntries(final String[] channels, final int maxMessages, final long oldestTime);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment