File: PriorityDumper.h

package info (click to toggle)
android-platform-tools 34.0.5-12
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 150,900 kB
  • sloc: cpp: 805,786; java: 293,500; ansic: 128,288; xml: 127,491; python: 41,481; sh: 14,245; javascript: 9,665; cs: 3,846; asm: 2,049; makefile: 1,917; yacc: 440; awk: 368; ruby: 183; sql: 140; perl: 88; lex: 67
file content (68 lines) | stat: -rw-r--r-- 2,525 bytes parent folder | download | duplicates (5)
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/*
 * Copyright (C) 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.
 */

#ifndef ANDROID_UTILS_PRIORITYDUMPER_H
#define ANDROID_UTILS_PRIORITYDUMPER_H

#include <utils/Errors.h>
#include <utils/String16.h>
#include <utils/Vector.h>

namespace android {

// Helper class to parse common arguments responsible for splitting dumps into
// various priority buckets and changing the output format of the dump.
class PriorityDumper {
public:
    static const char16_t PRIORITY_ARG[];
    static const char16_t PRIORITY_ARG_CRITICAL[];
    static const char16_t PRIORITY_ARG_HIGH[];
    static const char16_t PRIORITY_ARG_NORMAL[];
    static const char16_t PROTO_ARG[];

    // Parses the argument list searching for --dump_priority with a priority type
    // (HIGH, CRITICAL or NORMAL) and --proto. Matching arguments are stripped.
    // If a valid priority type is found, the associated PriorityDumper
    // method is called otherwise all supported sections are dumped.
    // If --proto is found, the dumpAsProto flag is set to dump sections in proto
    // format.
    status_t priorityDump(int fd, const Vector<String16>& args);

    // Dumps CRITICAL priority sections.
    virtual status_t dumpCritical(int /*fd*/, const Vector<String16>& /*args*/, bool /*asProto*/) {
        return OK;
    }

    // Dumps HIGH priority sections.
    virtual status_t dumpHigh(int /*fd*/, const Vector<String16>& /*args*/, bool /*asProto*/) {
        return OK;
    }

    // Dumps normal priority sections.
    virtual status_t dumpNormal(int /*fd*/, const Vector<String16>& /*args*/, bool /*asProto*/) {
        return OK;
    }

    // Dumps all sections.
    // This method is called when priorityDump is called without priority
    // arguments. By default, it calls all three dump methods.
    virtual status_t dumpAll(int fd, const Vector<String16>& args, bool asProto);
    virtual ~PriorityDumper() = default;
};

} // namespace android

#endif // ANDROID_UTILS_PRIORITYDUMPER_H