com.facebook.buck.logd.client

Interface LogDaemonClient

All Known Implementing Classes:

LogdClient

public interface LogDaemonClient

Interface for LogD Client.

Method Summary

Modifier and Type	Method and Description
int	createLogFile(String logFilePath, com.facebook.buck.logd.proto.LogType logType) Client calls this method to request LogD to create a log file in file-system and/or storage.
io.grpc.stub.StreamObserver<com.facebook.buck.logd.proto.LogMessage>	openLog(int logFileId, String logMessage) Client calls this method to acquire a StreamObserver object which listens for incoming logs.
void	shutdown() close all existing channels to logD server

Method Detail

createLogFile

int createLogFile(String logFilePath,
                  com.facebook.buck.logd.proto.LogType logType)
           throws LogDaemonException

Client calls this method to request LogD to create a log file in file-system and/or storage.

Returns:

a file identifier logFileId corresponding to the created file by LogD server

Throws:

LogDaemonException

openLog

io.grpc.stub.StreamObserver<com.facebook.buck.logd.proto.LogMessage> openLog(int logFileId,
                                                                             String logMessage)
                                                                      throws LogDaemonException

Client calls this method to acquire a StreamObserver object which listens for incoming logs. Upon receiving the StreamObserver, client uses it to stream log messages to locations identified by logFileId

Parameters:

logFileId - log file identifier generated by LogD server

logMessage - log message to be streamed to LogD

Returns:

a StreamObserver which observers and processes incoming logs from client

Throws:

LogDaemonException

shutdown

void shutdown()

close all existing channels to logD server