Home | History | Annotate | Download | only in fastboot
      1 /*
      2  * Copyright (C) 2016 The Android Open Source Project
      3  * All rights reserved.
      4  *
      5  * Redistribution and use in source and binary forms, with or without
      6  * modification, are permitted provided that the following conditions
      7  * are met:
      8  *  * Redistributions of source code must retain the above copyright
      9  *    notice, this list of conditions and the following disclaimer.
     10  *  * Redistributions in binary form must reproduce the above copyright
     11  *    notice, this list of conditions and the following disclaimer in
     12  *    the documentation and/or other materials provided with the
     13  *    distribution.
     14  *
     15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
     18  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
     19  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
     20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
     21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
     22  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
     23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
     24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
     25  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     26  * SUCH DAMAGE.
     27  */
     28 
     29 #ifndef TCP_H_
     30 #define TCP_H_
     31 
     32 #include <memory>
     33 #include <string>
     34 
     35 #include <android-base/macros.h>
     36 
     37 #include "socket.h"
     38 #include "transport.h"
     39 
     40 namespace tcp {
     41 
     42 constexpr int kDefaultPort = 5554;
     43 
     44 // Returns a newly allocated Transport object connected to |hostname|:|port|. On failure, |error| is
     45 // filled and nullptr is returned.
     46 std::unique_ptr<Transport> Connect(const std::string& hostname, int port, std::string* error);
     47 
     48 // Internal namespace for test use only.
     49 namespace internal {
     50 
     51 // Creates a TCP Transport object but using a given Socket instead of connecting to a hostname.
     52 // Used for unit tests to create a Transport object that uses a SocketMock.
     53 std::unique_ptr<Transport> Connect(std::unique_ptr<Socket> sock, std::string* error);
     54 
     55 }  // namespace internal
     56 
     57 }  // namespace tcp
     58 
     59 #endif  // TCP_H_
     60