satellite_client/src/android/telephony/satellite/wrapper/SatelliteDatagramCallbackWrapper.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

/*
 * Copyright (C) 2023 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.telephony.satellite.wrapper;

import android.annotation.NonNull;
import java.util.function.Consumer;

/** A callback class for listening to satellite datagrams. */
public interface SatelliteDatagramCallbackWrapper {
  /**
   * Called when there is an incoming datagram to be received.
   *
   * @param datagramId An id that uniquely identifies incoming datagram.
   * @param datagram Datagram to be received over satellite.
   * @param pendingCount Number of datagrams yet to be received by the app.
   * @param callback This callback will be used by datagram receiver app to inform Telephony that
   *     they received the datagram. If the callback is not received within five minutes, Telephony
   *     will resend the datagram.
   */
  void onSatelliteDatagramReceived(
      long datagramId,
      @NonNull SatelliteDatagramWrapper datagram,
      int pendingCount,
      @NonNull Consumer<Void> callback);
}