platform_system_core/logcat/logcat.h
Elliott Hughes 66680bd8a8 logcat: tidy "logcat.h".
Bug: N/A
Test: builds
Change-Id: Ibe434221060b2e1fb0973d1c840d943ad3a4ee8d
2018-06-18 10:16:46 -07:00

60 lines
2.3 KiB
C

/*
* Copyright (C) 2005-2017 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#pragma once
#include <stdio.h>
/*
* The opaque context
*/
typedef struct android_logcat_context_internal* android_logcat_context;
/* Creates a context associated with this logcat instance
*
* Returns a pointer to the context, or a NULL on error.
*/
android_logcat_context create_android_logcat();
/* Collects and outputs the logcat data to output and error file descriptors
*
* Will block, performed in-thread and in-process
*
* The output file descriptor variable, if greater than or equal to 0, is
* where the output (ie: stdout) will be sent. The file descriptor is closed
* on android_logcat_destroy which terminates the instance, or when an -f flag
* (output redirect to a file) is present in the command. The error file
* descriptor variable, if greater than or equal to 0, is where the error
* stream (ie: stderr) will be sent, also closed on android_logcat_destroy.
* The error file descriptor can be set to equal to the output file descriptor,
* which will mix output and error stream content, and will defer closure of
* the file descriptor on -f flag redirection. Negative values for the file
* descriptors will use stdout and stderr FILE references respectively
* internally, and will not close the references as noted above.
*
* Return value is 0 for success, non-zero for errors.
*/
int android_logcat_run_command(android_logcat_context ctx, int output, int error, int argc,
char* const* argv, char* const* envp);
/* Finished with context
*
* Kill the command thread ASAP (if any), and free up all associated resources.
*
* Return value is the result of the android_logcat_run_command, or
* non-zero for any errors.
*/
int android_logcat_destroy(android_logcat_context* ctx);