host_link_base.h revision 938774101712ba48f54521aff2c1b7aa21d4a123 
1/*
2 * Copyright (C) 2017 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef CHRE_PLATFORM_SLPI_HOST_LINK_BASE_H_
18#define CHRE_PLATFORM_SLPI_HOST_LINK_BASE_H_
19
20#include "timer.h"
21
22namespace chre {
23
24class HostLinkBase {
25 public:
26  /**
27   * Blocks the current thread until the host has retrieved all messages pending
28   * in the outbound queue, or a timeout occurs. For proper function, it should
29   * not be possible for new messages to be added to the queue at the point when
30   * this is called.
31   *
32   * @return true if the outbound queue was successfully emptied
33   */
34  static bool flushOutboundQueue();
35
36  /**
37   * Attempts to flush the outbound queue and gracefully inform the host that we
38   * are exiting.
39   */
40  static void shutdown();
41
42 private:
43  static constexpr time_timetick_type kPollingIntervalUsec = 5000;
44};
45
46/**
47 * Requests that the HostLink send the log buffer to the host.
48 */
49void requestHostLinkLogBufferFlush();
50
51/**
52 * Sends a request to the host for a time sync message.
53 */
54void sendTimeSyncRequest();
55
56}  // namespace chre
57
58#endif  // CHRE_PLATFORM_SLPI_HOST_LINK_BASE_H_
59