blob: c613a04b75b63532c9fd079941176f25d7e10afe (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
// Copyright 2016 Yahoo Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.logserver.handlers;
import com.yahoo.log.LogMessage;
import java.util.List;
/**
* The LogHandler interface defines the interface used for all
* parts of the logserver which consume log messages.
*
* @author Bjorn Borud
*/
public interface LogHandler {
/**
* This is the entry point for the log handling. This method
* should return as quickly as possible in implementations
* so if you need to initiate time consuming processing you
* should look into some design alternatives.
*
* @param msg The log message
*/
void handle(LogMessage msg);
/**
* Instead of taking a single log message, this method can take
* a List of them. The List abstraction was chosen because the
* order needs to be preserved.
*
* @param messages a List containing zero or more LogMessage
* instances.
*/
void handle(List<LogMessage> messages);
/**
* Any log messages received so far should be dealt with
* before this method returns -- within reason ,of course.
* (<em>Within reason is loosely defined to be 2-5 seconds</em>)
*/
void flush();
/**
* Signals that we want to end logging and should close down the
* underlying logging mechanism -- whatever this maps to
* semantically for the underlying implementation. After this
* method has been called it is considered an error to submit more
* log messages to the handle() methods and an implementation
* may elect to throw runtime exceptions.
*/
void close();
}
|