Merge "Improve keepalive offload documentation and error handling" am: a0b880c9e8

am: 4a91c73e67

Change-Id: Iae2c4dfcfa2695a57ed54eb93c64eac54f18cf98
This commit is contained in:
Junyu Lai
2019-03-11 22:30:39 -07:00
committed by android-build-merger
3 changed files with 17 additions and 9 deletions

View File

@@ -45,13 +45,14 @@ final class TcpSocketKeepalive extends SocketKeepalive {
* - The application must not write to or read from the socket after calling this method, until * - The application must not write to or read from the socket after calling this method, until
* onDataReceived, onStopped, or onError are called. If it does, the keepalive will fail * onDataReceived, onStopped, or onError are called. If it does, the keepalive will fail
* with {@link #ERROR_SOCKET_NOT_IDLE}, or {@code #ERROR_INVALID_SOCKET} if the socket * with {@link #ERROR_SOCKET_NOT_IDLE}, or {@code #ERROR_INVALID_SOCKET} if the socket
* experienced an error (as in poll(2) returned POLLERR); if this happens, the data received * experienced an error (as in poll(2) returned POLLERR or POLLHUP); if this happens, the data
* from the socket may be invalid, and the socket can't be recovered. * received from the socket may be invalid, and the socket can't be recovered.
* - If the socket has data in the send or receive buffer, then this call will fail with * - If the socket has data in the send or receive buffer, then this call will fail with
* {@link #ERROR_SOCKET_NOT_IDLE} and can be retried after the data has been processed. * {@link #ERROR_SOCKET_NOT_IDLE} and can be retried after the data has been processed.
* An app could ensure this by using an application-layer protocol where it can receive * An app could ensure this by using an application-layer protocol to receive acknowledgement
* acknowledgement that it will go into keepalive mode. It could then go into keepalive * that indicates all data has been delivered to server, e.g. HTTP 200 OK.
* mode after having read the acknowledgement, draining the socket. * Then the app could go into keepalive mode after reading all remaining data within the
* acknowledgement.
*/ */
@Override @Override
void startImpl(int intervalSec) { void startImpl(int intervalSec) {

View File

@@ -239,7 +239,12 @@ public class KeepaliveTracker {
.sendMessage(CMD_START_SOCKET_KEEPALIVE, slot, mInterval, mPacket); .sendMessage(CMD_START_SOCKET_KEEPALIVE, slot, mInterval, mPacket);
break; break;
case TYPE_TCP: case TYPE_TCP:
mTcpController.startSocketMonitor(mFd, this, mSlot); try {
mTcpController.startSocketMonitor(mFd, this, mSlot);
} catch (InvalidSocketException e) {
handleStopKeepalive(mNai, mSlot, ERROR_INVALID_SOCKET);
return;
}
mNai.asyncChannel mNai.asyncChannel
.sendMessage(CMD_ADD_KEEPALIVE_PACKET_FILTER, slot, 0 /* Unused */, .sendMessage(CMD_ADD_KEEPALIVE_PACKET_FILTER, slot, 0 /* Unused */,
mPacket); mPacket);

View File

@@ -215,18 +215,20 @@ public class TcpKeepaliveController {
* Start monitoring incoming packets. * Start monitoring incoming packets.
* *
* @param fd socket fd to monitor. * @param fd socket fd to monitor.
* @param messenger a callback to notify socket status. * @param ki a {@link KeepaliveInfo} that tracks information about a socket keepalive.
* @param slot keepalive slot. * @param slot keepalive slot.
*/ */
public void startSocketMonitor(@NonNull final FileDescriptor fd, public void startSocketMonitor(@NonNull final FileDescriptor fd,
@NonNull final KeepaliveInfo ki, final int slot) { @NonNull final KeepaliveInfo ki, final int slot)
throws IllegalArgumentException, InvalidSocketException {
synchronized (mListeners) { synchronized (mListeners) {
if (null != mListeners.get(slot)) { if (null != mListeners.get(slot)) {
throw new IllegalArgumentException("This slot is already taken"); throw new IllegalArgumentException("This slot is already taken");
} }
for (int i = 0; i < mListeners.size(); ++i) { for (int i = 0; i < mListeners.size(); ++i) {
if (fd.equals(mListeners.valueAt(i))) { if (fd.equals(mListeners.valueAt(i))) {
throw new IllegalArgumentException("This fd is already registered"); Log.e(TAG, "This fd is already registered.");
throw new InvalidSocketException(ERROR_INVALID_SOCKET);
} }
} }
mFdHandlerQueue.addOnFileDescriptorEventListener(fd, FD_EVENTS, (readyFd, events) -> { mFdHandlerQueue.addOnFileDescriptorEventListener(fd, FD_EVENTS, (readyFd, events) -> {