1 /*
2  * Copyright (C) 2023 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.telephony.satellite;
18 
19 import android.annotation.FlaggedApi;
20 import android.annotation.NonNull;
21 import android.annotation.SystemApi;
22 
23 import com.android.internal.telephony.flags.Flags;
24 
25 import java.util.concurrent.Executor;
26 import java.util.function.Consumer;
27 
28 /**
29  * A callback class for listening to satellite datagrams.
30  * {@link SatelliteDatagramCallback} is registered to telephony when an app which invokes
31  * {@link SatelliteManager#registerForIncomingDatagram(Executor, SatelliteDatagramCallback)},
32  * and {@link #onSatelliteDatagramReceived(long, SatelliteDatagram, int, Consumer)} will be invoked
33  * when a new datagram is received from satellite.
34  *
35  * @hide
36  */
37 @SystemApi
38 @FlaggedApi(Flags.FLAG_OEM_ENABLED_SATELLITE_FLAG)
39 public interface SatelliteDatagramCallback {
40     /**
41      * Called when there is an incoming datagram to be received.
42      *
43      * @param datagramId An id that uniquely identifies incoming datagram.
44      * @param datagram Datagram to be received over satellite.
45      * @param pendingCount Number of datagrams yet to be received by the app.
46      * @param callback This callback will be used by datagram receiver app to inform Telephony
47      *                 that they received the datagram. If the callback is not received within
48      *                 five minutes, Telephony will resend the datagram.
49      */
50     @FlaggedApi(Flags.FLAG_OEM_ENABLED_SATELLITE_FLAG)
onSatelliteDatagramReceived(long datagramId, @NonNull SatelliteDatagram datagram, int pendingCount, @NonNull Consumer<Void> callback)51     void onSatelliteDatagramReceived(long datagramId, @NonNull SatelliteDatagram datagram,
52             int pendingCount, @NonNull Consumer<Void> callback);
53 }
54