| David Pursell | 4601c97 | 2016-02-05 15:35:09 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2015 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 UDP_H_ |
| 30 | #define UDP_H_ |
| 31 | |
| 32 | #include <memory> |
| 33 | #include <string> |
| 34 | |
| 35 | #include "socket.h" |
| 36 | #include "transport.h" |
| 37 | |
| 38 | namespace udp { |
| 39 | |
| 40 | constexpr int kDefaultPort = 5554; |
| 41 | |
| 42 | // Returns a newly allocated Transport object connected to |hostname|:|port|. On failure, |error| is |
| 43 | // filled and nullptr is returned. |
| 44 | std::unique_ptr<Transport> Connect(const std::string& hostname, int port, std::string* error); |
| 45 | |
| 46 | // Internal namespace for test use only. |
| 47 | namespace internal { |
| 48 | |
| 49 | constexpr uint16_t kProtocolVersion = 1; |
| 50 | |
| 51 | // This will be negotiated with the device so may end up being smaller. |
| 52 | constexpr uint16_t kHostMaxPacketSize = 8192; |
| 53 | |
| 54 | // Retransmission constants. Retransmission timeout must be at least 500ms, and the host must |
| 55 | // attempt to send packets for at least 1 minute once the device has connected. See |
| 56 | // fastboot_protocol.txt for more information. |
| 57 | constexpr int kResponseTimeoutMs = 500; |
| 58 | constexpr int kMaxConnectAttempts = 4; |
| 59 | constexpr int kMaxTransmissionAttempts = 60 * 1000 / kResponseTimeoutMs; |
| 60 | |
| 61 | enum Id : uint8_t { |
| 62 | kIdError = 0x00, |
| 63 | kIdDeviceQuery = 0x01, |
| 64 | kIdInitialization = 0x02, |
| 65 | kIdFastboot = 0x03 |
| 66 | }; |
| 67 | |
| 68 | enum Flag : uint8_t { |
| 69 | kFlagNone = 0x00, |
| 70 | kFlagContinuation = 0x01 |
| 71 | }; |
| 72 | |
| 73 | // Creates a UDP Transport object using a given Socket. Used for unit tests to create a Transport |
| 74 | // object that uses a SocketMock. |
| 75 | std::unique_ptr<Transport> Connect(std::unique_ptr<Socket> sock, std::string* error); |
| 76 | |
| 77 | } // namespace internal |
| 78 | |
| 79 | } // namespace udp |
| 80 | |
| 81 | #endif // UDP_H_ |