Home | History | Annotate | Download | only in adb
      1 /*
      2  * Copyright (C) 2015 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 _ADB_CLIENT_H_
     18 #define _ADB_CLIENT_H_
     19 
     20 #include "adb.h"
     21 #include "sysdeps.h"
     22 #include "transport.h"
     23 
     24 #include <string>
     25 
     26 // Connect to adb, connect to the named service, and return a valid fd for
     27 // interacting with that service upon success or a negative number on failure.
     28 int adb_connect(const std::string& service, std::string* _Nonnull error);
     29 
     30 // Kill the currently running adb server, if it exists.
     31 bool adb_kill_server();
     32 
     33 // Connect to adb, connect to the named service, returns true if the connection
     34 // succeeded AND the service returned OKAY. Outputs any returned error otherwise.
     35 bool adb_command(const std::string& service);
     36 
     37 // Connects to the named adb service and fills 'result' with the response.
     38 // Returns true on success; returns false and fills 'error' on failure.
     39 bool adb_query(const std::string& service, std::string* _Nonnull result,
     40                std::string* _Nonnull error);
     41 
     42 // Set the preferred transport to connect to.
     43 void adb_set_transport(TransportType type, const char* _Nullable serial, TransportId transport_id);
     44 void adb_get_transport(TransportType* _Nullable type, const char* _Nullable* _Nullable serial,
     45                        TransportId* _Nullable transport_id);
     46 
     47 // Set the socket specification for the adb server.
     48 // This function can only be called once, and the argument must live to the end of the process.
     49 void adb_set_socket_spec(const char* _Nonnull socket_spec);
     50 
     51 // Send commands to the current emulator instance. Will fail if there is not
     52 // exactly one emulator connected (or if you use -s <serial> with a <serial>
     53 // that does not designate an emulator).
     54 int adb_send_emulator_command(int argc, const char* _Nonnull* _Nonnull argv,
     55                               const char* _Nullable serial);
     56 
     57 // Reads a standard adb status response (OKAY|FAIL) and returns true in the
     58 // event of OKAY, false in the event of FAIL or protocol error.
     59 bool adb_status(int fd, std::string* _Nonnull error);
     60 
     61 // Create a host command corresponding to selected transport type/serial.
     62 std::string format_host_command(const char* _Nonnull command);
     63 
     64 // Get the feature set of the current preferred transport.
     65 bool adb_get_feature_set(FeatureSet* _Nonnull feature_set, std::string* _Nonnull error);
     66 
     67 #endif
     68