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