Merge "Cleanup satellite messaging pipeline." into udc-dev (383e2a17) · Commits · e / os / android_frameworks_opt_telephony

src/java/com/android/internal/telephony/satellite/DatagramController.java

+18 −16

Original line number	Diff line number	Diff line
		@@ -19,8 +19,8 @@ package com.android.internal.telephony.satellite;
		import android.annotation.NonNull;
		import android.annotation.Nullable;
		import android.content.Context;
		import android.os.Looper;
		import android.os.Message;
		import android.os.ResultReceiver;
		import android.telephony.Rlog;
		import android.telephony.satellite.ISatelliteDatagramCallback;
		import android.telephony.satellite.SatelliteDatagram;
		@@ -28,6 +28,8 @@ import android.telephony.satellite.SatelliteManager;

		import com.android.internal.telephony.Phone;

		import java.util.function.Consumer;

		/**
		* Datagram controller used for sending and receiving satellite datagrams.
		*/
		@@ -38,6 +40,7 @@ public class DatagramController {
		@NonNull private final Context mContext;
		@NonNull private final DatagramDispatcher mDatagramDispatcher;
		@NonNull private final DatagramReceiver mDatagramReceiver;
		public static final long MAX_DATAGRAM_ID = (long) Math.pow(2, 16);

		/**
		* @return The singleton instance of DatagramController.
		@@ -52,11 +55,12 @@ public class DatagramController {
		/**
		* Create the DatagramController singleton instance.
		* @param context The Context to use to create the DatagramController.
		* @param looper The looper for the handler.
		* @return The singleton instance of DatagramController.
		*/
		public static DatagramController make(@NonNull Context context) {
		public static DatagramController make(@NonNull Context context, @NonNull Looper looper) {
		if (sInstance == null) {
		sInstance = new DatagramController(context);
		sInstance = new DatagramController(context, looper);
		}
		return sInstance;
		}
		@@ -65,16 +69,17 @@ public class DatagramController {
		* Create a DatagramController to send and receive satellite datagrams.
		*
		* @param context The Context for the DatagramController.
		* @param looper The looper for the handler.
		*/
		private DatagramController(@NonNull Context context) {
		private DatagramController(@NonNull Context context, @NonNull Looper looper) {
		mContext = context;
		// Create the DatagramDispatcher singleton,
		// which is used to send satellite datagrams.
		mDatagramDispatcher = DatagramDispatcher.make(mContext);
		mDatagramDispatcher = DatagramDispatcher.make(mContext, looper);

		// Create the DatagramReceiver singleton,
		// which is used to receive satellite datagrams.
		mDatagramReceiver = DatagramReceiver.make(mContext);
		mDatagramReceiver = DatagramReceiver.make(mContext, looper);
		}

		/**
		@@ -112,7 +117,7 @@ public class DatagramController {
		* This method requests modem to check if there are any pending datagrams to be received over
		* satellite. If there are any incoming datagrams, they will be received via
		* {@link android.telephony.satellite.SatelliteDatagramCallback
		* #onSatelliteDatagramReceived(long, SatelliteDatagram, int, ISatelliteDatagramReceiverAck)}
		* #onSatelliteDatagramReceived(long, SatelliteDatagram, int, ILongConsumer)}
		*
		*/
		public void pollPendingSatelliteDatagrams(@NonNull Message message, @Nullable Phone phone) {
		@@ -127,7 +132,6 @@ public class DatagramController {
		* input to this method. Datagram received here will be passed down to modem without any
		* encoding or encryption.
		*
		* @param datagramId An id that uniquely identifies datagram requested to be sent.
		* @param datagramType datagram type indicating whether the datagram is of type
		* SOS_SMS or LOCATION_SHARING.
		* @param datagram encoded gateway datagram which is encrypted by the caller.
		@@ -135,16 +139,14 @@ public class DatagramController {
		* @param needFullScreenPointingUI this is used to indicate pointingUI app to open in
		* full screen mode.
		* @param isSatelliteDemoModeEnabled True if satellite demo mode is enabled
		* @param result The result receiver that returns datagramId if datagram is sent successfully
		* or {@link SatelliteManager.SatelliteError} of the request if it is failed.
		* @param callback The callback to get {@link SatelliteManager.SatelliteError} of the request.
		*/
		public void sendSatelliteDatagram(long datagramId,
		@SatelliteManager.DatagramType int datagramType, @NonNull SatelliteDatagram datagram,
		boolean needFullScreenPointingUI, boolean isSatelliteDemoModeEnabled,
		@NonNull ResultReceiver result) {
		public void sendSatelliteDatagram(@SatelliteManager.DatagramType int datagramType,
		@NonNull SatelliteDatagram datagram, boolean needFullScreenPointingUI,
		boolean isSatelliteDemoModeEnabled, @NonNull Consumer<Integer> callback) {
		// TODO: set modemTransferState = SATELLITE_DATAGRAM_TRANSFER_STATE_SENDING
		mDatagramDispatcher.sendSatelliteDatagram(datagramId, datagramType, datagram,
		needFullScreenPointingUI, isSatelliteDemoModeEnabled, result);
		mDatagramDispatcher.sendSatelliteDatagram(datagramType, datagram,
		needFullScreenPointingUI, isSatelliteDemoModeEnabled, callback);
		}

		private static void logd(@NonNull String log) {

src/java/com/android/internal/telephony/satellite/DatagramDispatcher.java

+61 −35

Original line number	Diff line number	Diff line
		@@ -20,10 +20,9 @@ import android.annotation.NonNull;
		import android.annotation.Nullable;
		import android.content.Context;
		import android.os.AsyncResult;
		import android.os.Bundle;
		import android.os.Handler;
		import android.os.Looper;
		import android.os.Message;
		import android.os.ResultReceiver;
		import android.telephony.Rlog;
		import android.telephony.satellite.SatelliteDatagram;
		import android.telephony.satellite.SatelliteManager;
		@@ -34,6 +33,8 @@ import com.android.internal.telephony.Phone;
		import java.util.LinkedHashMap;
		import java.util.Map.Entry;
		import java.util.Set;
		import java.util.concurrent.atomic.AtomicLong;
		import java.util.function.Consumer;

		/**
		* Datagram dispatcher used to send satellite datagrams.
		@@ -47,6 +48,8 @@ public class DatagramDispatcher extends Handler {
		@NonNull private static DatagramDispatcher sInstance;
		@NonNull private final Context mContext;

		private static AtomicLong mNextDatagramId = new AtomicLong(0);

		private final Object mLock = new Object();

		@GuardedBy("mLock")
		@@ -71,11 +74,12 @@ public class DatagramDispatcher extends Handler {
		/**
		* Create the DatagramDispatcher singleton instance.
		* @param context The Context to use to create the DatagramDispatcher.
		* @param looper The looper for the handler.
		* @return The singleton instance of DatagramDispatcher.
		*/
		public static DatagramDispatcher make(@NonNull Context context) {
		public static DatagramDispatcher make(@NonNull Context context, @NonNull Looper looper) {
		if (sInstance == null) {
		sInstance = new DatagramDispatcher(context);
		sInstance = new DatagramDispatcher(context, looper);
		}
		return sInstance;
		}
		@@ -84,9 +88,10 @@ public class DatagramDispatcher extends Handler {
		* Create a DatagramDispatcher to send satellite datagrams.
		*
		* @param context The Context for the DatagramDispatcher.
		* @param looper The looper for the handler.
		*/
		private DatagramDispatcher(@NonNull Context context) {
		super(context.getMainLooper());
		private DatagramDispatcher(@NonNull Context context, @NonNull Looper looper) {
		super(looper);
		mContext = context;
		synchronized (mLock) {
		mSendingDatagramInProgress = false;
		@@ -113,18 +118,18 @@ public class DatagramDispatcher extends Handler {
		public @NonNull SatelliteDatagram datagram;
		public boolean needFullScreenPointingUI;
		public boolean isSatelliteDemoModeEnabled;
		public @NonNull ResultReceiver result;
		public @NonNull Consumer<Integer> callback;

		SendSatelliteDatagramArgument(long datagramId,
		@SatelliteManager.DatagramType int datagramType,
		SatelliteDatagram datagram, boolean needFullScreenPointingUI,
		boolean isSatelliteDemoModeEnabled, ResultReceiver result) {
		@NonNull SatelliteDatagram datagram, boolean needFullScreenPointingUI,
		boolean isSatelliteDemoModeEnabled, @NonNull Consumer<Integer> callback) {
		this.datagramId = datagramId;
		this.datagramType = datagramType;
		this.datagram = datagram;
		this.needFullScreenPointingUI = needFullScreenPointingUI;
		this.isSatelliteDemoModeEnabled = isSatelliteDemoModeEnabled;
		this.result = result;
		this.callback = callback;
		}
		}

		@@ -153,8 +158,7 @@ public class DatagramDispatcher extends Handler {
		argument.needFullScreenPointingUI);
		} else {
		loge("sendSatelliteDatagram: No phone object");
		argument.result.send(
		SatelliteManager.SATELLITE_INVALID_TELEPHONY_STATE, null);
		argument.callback.accept(SatelliteManager.SATELLITE_INVALID_TELEPHONY_STATE);
		}
		break;
		}
		@@ -162,18 +166,16 @@ public class DatagramDispatcher extends Handler {
		case EVENT_SEND_SATELLITE_DATAGRAM_DONE: {
		ar = (AsyncResult) msg.obj;
		request = (DatagramDispatcherHandlerRequest) ar.userObj;
		int error = SatelliteServiceUtils.getSatelliteError(ar,
		"sendSatelliteDatagram", false);
		int error = SatelliteServiceUtils.getSatelliteError(ar, "sendSatelliteDatagram");
		SendSatelliteDatagramArgument argument =
		(SendSatelliteDatagramArgument) request.argument;

		synchronized (mLock) {
		mSendingDatagramInProgress = false;
		}
		Bundle bundle = new Bundle();
		if (error == SatelliteManager.SATELLITE_ERROR_NONE) {
		// TODO: set modemTransferState = SATELLITE_DATAGRAM_TRANSFER_STATE_SEND_SUCCESS
		bundle.putLong(SatelliteManager.KEY_SEND_SATELLITE_DATAGRAM,
		argument.datagramId);

		// Send response for current datagram
		argument.callback.accept(error);
		synchronized (mLock) {
		if (argument.datagramType == SatelliteManager.DATAGRAM_TYPE_SOS_MESSAGE) {
		mPendingEmergencyDatagramsMap.remove(argument.datagramId);
		@@ -181,12 +183,17 @@ public class DatagramDispatcher extends Handler {
		mPendingNonEmergencyDatagramsMap.remove(argument.datagramId);
		}
		}

		// Handle pending datagrams
		if (error == SatelliteManager.SATELLITE_ERROR_NONE) {
		sendPendingDatagrams();
		} else {
		// TODO: set modemTransferState = SATELLITE_DATAGRAM_TRANSFER_STATE_SEND_FAILED.
		// TODO: send error code for all pending messages
		sendErrorCodeAndCleanupPendingDatagrams(mPendingEmergencyDatagramsMap,
		SatelliteManager.SATELLITE_REQUEST_ABORTED);
		sendErrorCodeAndCleanupPendingDatagrams(mPendingNonEmergencyDatagramsMap,
		SatelliteManager.SATELLITE_REQUEST_ABORTED);
		}
		argument.result.send(error, bundle);
		break;
		}

		@@ -203,7 +210,6 @@ public class DatagramDispatcher extends Handler {
		* input to this method. Datagram received here will be passed down to modem without any
		* encoding or encryption.
		*
		* @param datagramId An id that uniquely identifies datagram requested to be sent.
		* @param datagramType datagram type indicating whether the datagram is of type
		* SOS_SMS or LOCATION_SHARING.
		* @param datagram encoded gateway datagram which is encrypted by the caller.
		@@ -211,18 +217,18 @@ public class DatagramDispatcher extends Handler {
		* @param needFullScreenPointingUI this is used to indicate pointingUI app to open in
		* full screen mode.
		* @param isSatelliteDemoModeEnabled True if satellite demo mode is enabled
		* @param result The result receiver that returns datagramId if datagram is sent successfully
		* or {@link SatelliteManager.SatelliteError} of the request if it is failed.
		* @param callback The callback to get {@link SatelliteManager.SatelliteError} of the request.
		*/
		public void sendSatelliteDatagram(long datagramId,
		@SatelliteManager.DatagramType int datagramType, @NonNull SatelliteDatagram datagram,
		boolean needFullScreenPointingUI, boolean isSatelliteDemoModeEnabled,
		@NonNull ResultReceiver result) {
		public void sendSatelliteDatagram(@SatelliteManager.DatagramType int datagramType,
		@NonNull SatelliteDatagram datagram, boolean needFullScreenPointingUI,
		boolean isSatelliteDemoModeEnabled, @NonNull Consumer<Integer> callback) {
		Phone phone = SatelliteServiceUtils.getPhone();

		long datagramId = mNextDatagramId.getAndUpdate(
		n -> ((n + 1) % DatagramController.MAX_DATAGRAM_ID));
		SendSatelliteDatagramArgument datagramArgs = new SendSatelliteDatagramArgument(datagramId,
		datagramType, datagram, needFullScreenPointingUI, isSatelliteDemoModeEnabled,
		result);
		callback);

		synchronized (mLock) {
		if (datagramType == SatelliteManager.DATAGRAM_TYPE_SOS_MESSAGE) {
		@@ -260,6 +266,26 @@ public class DatagramDispatcher extends Handler {
		}
		}

		/**
		* Send error code to all the pending datagrams
		* @param errorCode error code to be returned.
		*/
		private void sendErrorCodeAndCleanupPendingDatagrams(
		LinkedHashMap<Long, SendSatelliteDatagramArgument> pendingDatagramsMap,
		@SatelliteManager.SatelliteError int errorCode) {
		synchronized (mLock) {
		// Send error code to all the pending datagrams
		for (Entry<Long, SendSatelliteDatagramArgument> entry :
		pendingDatagramsMap.entrySet()) {
		SendSatelliteDatagramArgument argument = entry.getValue();
		argument.callback.accept(errorCode);
		}

		// Clear pending datagram maps
		pendingDatagramsMap.clear();
		}
		}

		/**
		* Posts the specified command to be executed on the main thread and returns immediately.
		*