junyulai | 352dc2f | 2019-01-08 20:04:33 +0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2019 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 | package android.net; |
| 18 | |
| 19 | import android.annotation.NonNull; |
junyulai | 0c66697 | 2019-03-04 22:45:36 +0800 | [diff] [blame] | 20 | import android.os.ParcelFileDescriptor; |
junyulai | 352dc2f | 2019-01-08 20:04:33 +0800 | [diff] [blame] | 21 | import android.os.RemoteException; |
| 22 | import android.util.Log; |
| 23 | |
| 24 | import java.io.FileDescriptor; |
junyulai | 352dc2f | 2019-01-08 20:04:33 +0800 | [diff] [blame] | 25 | import java.util.concurrent.Executor; |
| 26 | |
| 27 | /** @hide */ |
| 28 | final class TcpSocketKeepalive extends SocketKeepalive { |
| 29 | |
junyulai | 352dc2f | 2019-01-08 20:04:33 +0800 | [diff] [blame] | 30 | TcpSocketKeepalive(@NonNull IConnectivityManager service, |
| 31 | @NonNull Network network, |
junyulai | 0c66697 | 2019-03-04 22:45:36 +0800 | [diff] [blame] | 32 | @NonNull ParcelFileDescriptor pfd, |
junyulai | 352dc2f | 2019-01-08 20:04:33 +0800 | [diff] [blame] | 33 | @NonNull Executor executor, |
| 34 | @NonNull Callback callback) { |
junyulai | 0c66697 | 2019-03-04 22:45:36 +0800 | [diff] [blame] | 35 | super(service, network, pfd, executor, callback); |
junyulai | 352dc2f | 2019-01-08 20:04:33 +0800 | [diff] [blame] | 36 | } |
| 37 | |
| 38 | /** |
| 39 | * Starts keepalives. {@code mSocket} must be a connected TCP socket. |
| 40 | * |
| 41 | * - The application must not write to or read from the socket after calling this method, until |
| 42 | * onDataReceived, onStopped, or onError are called. If it does, the keepalive will fail |
| 43 | * with {@link #ERROR_SOCKET_NOT_IDLE}, or {@code #ERROR_INVALID_SOCKET} if the socket |
junyulai | 1d5cd19 | 2019-03-04 11:49:17 +0800 | [diff] [blame] | 44 | * experienced an error (as in poll(2) returned POLLERR or POLLHUP); if this happens, the data |
| 45 | * received from the socket may be invalid, and the socket can't be recovered. |
junyulai | 352dc2f | 2019-01-08 20:04:33 +0800 | [diff] [blame] | 46 | * - If the socket has data in the send or receive buffer, then this call will fail with |
| 47 | * {@link #ERROR_SOCKET_NOT_IDLE} and can be retried after the data has been processed. |
junyulai | 1d5cd19 | 2019-03-04 11:49:17 +0800 | [diff] [blame] | 48 | * An app could ensure this by using an application-layer protocol to receive acknowledgement |
| 49 | * that indicates all data has been delivered to server, e.g. HTTP 200 OK. |
| 50 | * Then the app could go into keepalive mode after reading all remaining data within the |
| 51 | * acknowledgement. |
junyulai | 352dc2f | 2019-01-08 20:04:33 +0800 | [diff] [blame] | 52 | */ |
| 53 | @Override |
| 54 | void startImpl(int intervalSec) { |
junyulai | 7c46917 | 2019-01-16 20:23:34 +0800 | [diff] [blame] | 55 | mExecutor.execute(() -> { |
| 56 | try { |
junyulai | 0c66697 | 2019-03-04 22:45:36 +0800 | [diff] [blame] | 57 | final FileDescriptor fd = mPfd.getFileDescriptor(); |
junyulai | 7c46917 | 2019-01-16 20:23:34 +0800 | [diff] [blame] | 58 | mService.startTcpKeepalive(mNetwork, fd, intervalSec, mCallback); |
| 59 | } catch (RemoteException e) { |
| 60 | Log.e(TAG, "Error starting packet keepalive: ", e); |
| 61 | throw e.rethrowFromSystemServer(); |
| 62 | } |
| 63 | }); |
junyulai | 352dc2f | 2019-01-08 20:04:33 +0800 | [diff] [blame] | 64 | } |
| 65 | |
| 66 | @Override |
| 67 | void stopImpl() { |
junyulai | 7c46917 | 2019-01-16 20:23:34 +0800 | [diff] [blame] | 68 | mExecutor.execute(() -> { |
| 69 | try { |
| 70 | if (mSlot != null) { |
| 71 | mService.stopKeepalive(mNetwork, mSlot); |
| 72 | } |
| 73 | } catch (RemoteException e) { |
| 74 | Log.e(TAG, "Error stopping packet keepalive: ", e); |
| 75 | throw e.rethrowFromSystemServer(); |
junyulai | 352dc2f | 2019-01-08 20:04:33 +0800 | [diff] [blame] | 76 | } |
junyulai | 7c46917 | 2019-01-16 20:23:34 +0800 | [diff] [blame] | 77 | }); |
junyulai | 352dc2f | 2019-01-08 20:04:33 +0800 | [diff] [blame] | 78 | } |
| 79 | } |