एक्सचेंज का डेटा

डिवाइसों के बीच कनेक्शन बनने के बाद, आपके पास Payload ऑब्जेक्ट को भेजने और पाने का विकल्प होता है. एक Payload, बाइट की एक सामान्य रेंज को दिखा सकता है, जैसे कि एक छोटा टेक्स्ट मैसेज; कोई फ़ाइल, जैसे कि कोई फ़ोटो या वीडियो; या एक स्ट्रीम, जैसे कि डिवाइस के माइक्रोफ़ोन से आने वाली ऑडियो स्ट्रीम.

पेलोड sendPayload() तरीके का इस्तेमाल करके भेजे जाते हैं और ये PayloadCallback को लागू करने पर मिलते हैं, जो acceptConnection() को पास हो जाता है, जैसा कि कनेक्शन मैनेज करें में बताया गया है.

ध्यान दें: PayloadCallback.onPayloadReceived() को तब कॉल किया जाता है, जब पेलोड का पहला बाइट मिलता है; यह इस बात का संकेत नहीं देता कि पूरा पेलोड मिल गया है. PayloadCallback.onPayloadTransferUpdate() को जब PayloadTransferUpdate.Status.SUCCESS की स्थिति (या किसी गड़बड़ी के मामले में PayloadTransferUpdate.Status.ERROR) की स्थिति में कॉल किया जाता है, तो ट्रांसफ़र पूरा हो जाता है. इसका अपवाद BYTES प्रकार के पेलोड है; बाइट सेक्शन में ज़्यादा पढ़ें.

पेलोड के टाइप

बाइट

बाइट पेलोड सबसे आसान पेलोड होते हैं. वे संदेश या मेटाडेटा जैसे आसान डेटा को Connections.MAX_BYTES_DATA_SIZE के अधिकतम आकार तक भेजने के लिए उपयुक्त हैं. यहां BYTES पेलोड भेजने का उदाहरण दिया गया है:

Payload bytesPayload = Payload.fromBytes(new byte[] {0xa, 0xb, 0xc, 0xd});
Nearby.getConnectionsClient(context).sendPayload(toEndpointId, bytesPayload);

acceptConnection() को भेजे गए PayloadCallback के onPayloadReceived() तरीके को लागू करके, BYTES का पेलोड पाएं.

static class ReceiveBytesPayloadListener extends PayloadCallback {

  @Override
  public void onPayloadReceived(String endpointId, Payload payload) {
    // This always gets the full data of the payload. Is null if it's not a BYTES payload.
    if (payload.getType() == Payload.Type.BYTES) {
      byte[] receivedBytes = payload.asBytes();
    }
  }

  @Override
  public void onPayloadTransferUpdate(String endpointId, PayloadTransferUpdate update) {
    // Bytes payloads are sent as a single chunk, so you'll receive a SUCCESS update immediately
    // after the call to onPayloadReceived().
  }
}

FILE और STREAM पेलोड के उलट, BYTES पेलोड को एक डेटा के रूप में भेजा जाता है, इसलिए SUCCESS अपडेट के लिए इंतज़ार करने की ज़रूरत नहीं होती है. हालांकि, यह onPayloadReceived() को कॉल किए जाने के तुरंत बाद डिलीवर किया जाएगा. इसके बजाय, onPayloadReceived() को कॉल करते ही, पेलोड का पूरा डेटा पाने के लिए, आप payload.asBytes() को सुरक्षित तरीके से कॉल कर सकते हैं.

फ़ाइल

फ़ाइल पेलोड, लोकल डिवाइस पर सेव की गई फ़ाइल, जैसे कि कोई फ़ोटो या वीडियो फ़ाइल से बनाए जाते हैं. यहां FILE पेलोड भेजने का एक उदाहरण दिया गया है:

File fileToSend = new File(context.getFilesDir(), "hello.txt");
try {
  Payload filePayload = Payload.fromFile(fileToSend);
  Nearby.getConnectionsClient(context).sendPayload(toEndpointId, filePayload);
} catch (FileNotFoundException e) {
  Log.e("MyApp", "File not found", e);
}

उपलब्ध होने पर, FILES पेलोड बनाने के लिए ParcelFileDescriptor का इस्तेमाल करना ज़्यादा बेहतर हो सकता है, जैसे कि ContentResolver से. इससे फ़ाइल की बाइट की कॉपी कम हो जाती है:

ParcelFileDescriptor pfd = getContentResolver().openFileDescriptor(uri, "r");
filePayload = Payload.fromFile(pfd);

जब फ़ाइल मिल जाती है, तो वह फ़ाइल पाने वाले के डिवाइस पर, डाउनलोड फ़ोल्डर (DIRECTORY_DOWNLOADS) में सेव हो जाती है. इसके लिए, फ़ाइल का कोई सामान्य नाम, जिसमें एक्सटेंशन मौजूद नहीं होता है. ट्रांसफ़र पूरा होने के बाद, PayloadTransferUpdate.Status.SUCCESS के साथ onPayloadTransferUpdate() को किए गए कॉल से पता चलता है कि File ऑब्जेक्ट को वापस लाया जा सकता है. अगर आपका ऐप्लिकेशन < Q डिवाइसों को टारगेट करता है, तो:

File payloadFile = filePayload.asFile().asJavaFile();

// Rename the file.
payloadFile.renameTo(new File(payloadFile.getParentFile(), filename));

अगर आपका ऐप्लिकेशन, Q डिवाइसों को टारगेट कर रहा है, तो पिछले कोड का इस्तेमाल जारी रखने के लिए, मेनिफ़ेस्ट के ऐप्लिकेशन एलिमेंट में android:requestLegacyExternalStorage="true" जोड़ा जा सकता है. नहीं तो, Q+ के लिए आपको Scoped Storage नियमों का पालन करना होगा और सेवा से भेजे गए uri का इस्तेमाल करके पाई गई फ़ाइल को ऐक्सेस करना होगा.

// Because of https://developer.android.com/preview/privacy/scoped-storage, we are not
// allowed to access filepaths from another process directly. Instead, we must open the
// uri using our ContentResolver.
Uri uri = filePayload.asFile().asUri();
try {
  // Copy the file to a new location.
  InputStream in = context.getContentResolver().openInputStream(uri);
  copyStream(in, new FileOutputStream(new File(context.getCacheDir(), filename)));
} catch (IOException e) {
  // Log the error.
} finally {
  // Delete the original file.
  context.getContentResolver().delete(uri, null, null);
}

ज़्यादा मुश्किल उदाहरण में, ACTION_OPEN_DOCUMENT इंटेंट, उपयोगकर्ता से फ़ाइल चुनने का अनुरोध करता है और ParcelFileDescriptor का इस्तेमाल करके, फ़ाइल को पेलोड के तौर पर असरदार तरीके से भेजा जाता है. इस फ़ाइल का नाम BYTES पेलोड के तौर पर भी भेजा जाता है.

private static final int READ_REQUEST_CODE = 42;
private static final String ENDPOINT_ID_EXTRA = "com.foo.myapp.EndpointId";

/**
 * Fires an intent to spin up the file chooser UI and select an image for sending to endpointId.
 */
private void showImageChooser(String endpointId) {
  Intent intent = new Intent(Intent.ACTION_OPEN_DOCUMENT);
  intent.addCategory(Intent.CATEGORY_OPENABLE);
  intent.setType("image/*");
  intent.putExtra(ENDPOINT_ID_EXTRA, endpointId);
  startActivityForResult(intent, READ_REQUEST_CODE);
}

@Override
public void onActivityResult(int requestCode, int resultCode, Intent resultData) {
  super.onActivityResult(requestCode, resultCode, resultData);
  if (requestCode == READ_REQUEST_CODE
      && resultCode == Activity.RESULT_OK
      && resultData != null) {
    String endpointId = resultData.getStringExtra(ENDPOINT_ID_EXTRA);

    // The URI of the file selected by the user.
    Uri uri = resultData.getData();

    Payload filePayload;
    try {
      // Open the ParcelFileDescriptor for this URI with read access.
      ParcelFileDescriptor pfd = getContentResolver().openFileDescriptor(uri, "r");
      filePayload = Payload.fromFile(pfd);
    } catch (FileNotFoundException e) {
      Log.e("MyApp", "File not found", e);
      return;
    }

    // Construct a simple message mapping the ID of the file payload to the desired filename.
    String filenameMessage = filePayload.getId() + ":" + uri.getLastPathSegment();

    // Send the filename message as a bytes payload.
    Payload filenameBytesPayload =
        Payload.fromBytes(filenameMessage.getBytes(StandardCharsets.UTF_8));
    Nearby.getConnectionsClient(context).sendPayload(endpointId, filenameBytesPayload);

    // Finally, send the file payload.
    Nearby.getConnectionsClient(context).sendPayload(endpointId, filePayload);
  }
}

फ़ाइल का नाम पेलोड के तौर पर भेजा गया था. इसलिए, पेमेंट पाने वाले को फ़ाइल की जगह बदलने या उसका नाम बदलने की अनुमति है, ताकि वह सही एक्सटेंशन के साथ काम कर सके:

static class ReceiveFilePayloadCallback extends PayloadCallback {
  private final Context context;
  private final SimpleArrayMap<Long, Payload> incomingFilePayloads = new SimpleArrayMap<>();
  private final SimpleArrayMap<Long, Payload> completedFilePayloads = new SimpleArrayMap<>();
  private final SimpleArrayMap<Long, String> filePayloadFilenames = new SimpleArrayMap<>();

  public ReceiveFilePayloadCallback(Context context) {
    this.context = context;
  }

  @Override
  public void onPayloadReceived(String endpointId, Payload payload) {
    if (payload.getType() == Payload.Type.BYTES) {
      String payloadFilenameMessage = new String(payload.asBytes(), StandardCharsets.UTF_8);
      long payloadId = addPayloadFilename(payloadFilenameMessage);
      processFilePayload(payloadId);
    } else if (payload.getType() == Payload.Type.FILE) {
      // Add this to our tracking map, so that we can retrieve the payload later.
      incomingFilePayloads.put(payload.getId(), payload);
    }
  }

  /**
   * Extracts the payloadId and filename from the message and stores it in the
   * filePayloadFilenames map. The format is payloadId:filename.
   */
  private long addPayloadFilename(String payloadFilenameMessage) {
    String[] parts = payloadFilenameMessage.split(":");
    long payloadId = Long.parseLong(parts[0]);
    String filename = parts[1];
    filePayloadFilenames.put(payloadId, filename);
    return payloadId;
  }

  private void processFilePayload(long payloadId) {
    // BYTES and FILE could be received in any order, so we call when either the BYTES or the FILE
    // payload is completely received. The file payload is considered complete only when both have
    // been received.
    Payload filePayload = completedFilePayloads.get(payloadId);
    String filename = filePayloadFilenames.get(payloadId);
    if (filePayload != null && filename != null) {
      completedFilePayloads.remove(payloadId);
      filePayloadFilenames.remove(payloadId);

      // Get the received file (which will be in the Downloads folder)
      // Because of https://developer.android.com/preview/privacy/scoped-storage, we are not
      // allowed to access filepaths from another process directly. Instead, we must open the
      // uri using our ContentResolver.
      Uri uri = filePayload.asFile().asUri();
      try {
        // Copy the file to a new location.
        InputStream in = context.getContentResolver().openInputStream(uri);
        copyStream(in, new FileOutputStream(new File(context.getCacheDir(), filename)));
      } catch (IOException e) {
        // Log the error.
      } finally {
        // Delete the original file.
        context.getContentResolver().delete(uri, null, null);
      }
    }
  }

  // add removed tag back to fix b/183037922
  private void processFilePayload2(long payloadId) {
    // BYTES and FILE could be received in any order, so we call when either the BYTES or the FILE
    // payload is completely received. The file payload is considered complete only when both have
    // been received.
    Payload filePayload = completedFilePayloads.get(payloadId);
    String filename = filePayloadFilenames.get(payloadId);
    if (filePayload != null && filename != null) {
      completedFilePayloads.remove(payloadId);
      filePayloadFilenames.remove(payloadId);

      // Get the received file (which will be in the Downloads folder)
      if (VERSION.SDK_INT >= VERSION_CODES.Q) {
        // Because of https://developer.android.com/preview/privacy/scoped-storage, we are not
        // allowed to access filepaths from another process directly. Instead, we must open the
        // uri using our ContentResolver.
        Uri uri = filePayload.asFile().asUri();
        try {
          // Copy the file to a new location.
          InputStream in = context.getContentResolver().openInputStream(uri);
          copyStream(in, new FileOutputStream(new File(context.getCacheDir(), filename)));
        } catch (IOException e) {
          // Log the error.
        } finally {
          // Delete the original file.
          context.getContentResolver().delete(uri, null, null);
        }
      } else {
        File payloadFile = filePayload.asFile().asJavaFile();

        // Rename the file.
        payloadFile.renameTo(new File(payloadFile.getParentFile(), filename));
      }
    }
  }

  @Override
  public void onPayloadTransferUpdate(String endpointId, PayloadTransferUpdate update) {
    if (update.getStatus() == PayloadTransferUpdate.Status.SUCCESS) {
      long payloadId = update.getPayloadId();
      Payload payload = incomingFilePayloads.remove(payloadId);
      completedFilePayloads.put(payloadId, payload);
      if (payload.getType() == Payload.Type.FILE) {
        processFilePayload(payloadId);
      }
    }
  }

  /** Copies a stream from one location to another. */
  private static void copyStream(InputStream in, OutputStream out) throws IOException {
    try {
      byte[] buffer = new byte[1024];
      int read;
      while ((read = in.read(buffer)) != -1) {
        out.write(buffer, 0, read);
      }
      out.flush();
    } finally {
      in.close();
      out.close();
    }
  }
}

Stream

स्ट्रीम पेलोड आपके लिए तब काम करते हैं, जब आपको ज़्यादा मात्रा में डेटा भेजना हो, जैसे कि ऑडियो स्ट्रीम. Payload.fromStream() या InputStream में पास करके या ParcelFileDescriptor में कॉल करके, STREAM पेलोड बनाएं. उदाहरण के लिए :

URL url = new URL("https://developers.google.com/nearby/connections/android/exchange-data");
Payload streamPayload = Payload.fromStream(url.openStream());
Nearby.getConnectionsClient(context).sendPayload(toEndpointId, streamPayload);

पाने वाले व्यक्ति पर, payload.asStream().asInputStream() या payload.asStream().asParcelFileDescriptor() को सफल onPayloadTransferUpdate कॉलबैक में कॉल करें:

static class ReceiveStreamPayloadCallback extends PayloadCallback {
  private final SimpleArrayMap<Long, Thread> backgroundThreads = new SimpleArrayMap<>();

  private static final long READ_STREAM_IN_BG_TIMEOUT = 5000;

  @Override
  public void onPayloadTransferUpdate(String endpointId, PayloadTransferUpdate update) {
    if (backgroundThreads.containsKey(update.getPayloadId())
        && update.getStatus() != PayloadTransferUpdate.Status.IN_PROGRESS) {
      backgroundThreads.get(update.getPayloadId()).interrupt();
    }
  }

  @Override
  public void onPayloadReceived(String endpointId, Payload payload) {
    if (payload.getType() == Payload.Type.STREAM) {
      // Read the available bytes in a while loop to free the stream pipe in time. Otherwise, the
      // bytes will block the pipe and slow down the throughput.
      Thread backgroundThread =
          new Thread() {
            @Override
            public void run() {
              InputStream inputStream = payload.asStream().asInputStream();
              long lastRead = SystemClock.elapsedRealtime();
              while (!Thread.interrupted()) {
                if ((SystemClock.elapsedRealtime() - lastRead) >= READ_STREAM_IN_BG_TIMEOUT) {
                  Log.e("MyApp", "Read data from stream but timed out.");
                  break;
                }

                try {
                  int availableBytes = inputStream.available();
                  if (availableBytes > 0) {
                    byte[] bytes = new byte[availableBytes];
                    if (inputStream.read(bytes) == availableBytes) {
                      lastRead = SystemClock.elapsedRealtime();
                      // Do something with is here...
                    }
                  } else {
                    // Sleep or just continue.
                  }
                } catch (IOException e) {
                  Log.e("MyApp", "Failed to read bytes from InputStream.", e);
                  break;
                } // try-catch
              } // while
            }
          };
      backgroundThread.start();
      backgroundThreads.put(payload.getId(), backgroundThread);
    }
  }
}

एक से ज़्यादा पेलोड के साथ ऑर्डर करना

एक ही तरह के पेलोड उसी क्रम में मिलते हैं जिस क्रम में उन्हें भेजा गया था. हालांकि, इस बात की कोई गारंटी नहीं है कि ऑर्डर अलग-अलग पेलोड में सुरक्षित रहेंगे. उदाहरण के लिए, अगर भेजने वाला FILE पेलोड भेजता है जिसके बाद BYTE पेलोड आता है, तो पाने वाले को पहले BYTE पेलोड मिल सकता है, जिसके बाद FILE पेलोड हो सकता है.

प्रगति से जुड़े अपडेट

onPayloadTransferUpdate() वाला तरीका, इनकमिंग और आउटगोइंग पेलोड, दोनों की प्रोग्रेस के बारे में अपडेट देता है. दोनों ही मामलों में, इससे उपयोगकर्ता को ट्रांसफ़र की प्रोग्रेस दिखाने का मौका मिलता है. जैसे, प्रगति बार में. इनकमिंग पेलोड के लिए, अपडेट यह भी बताते हैं कि नया डेटा कब मिला.

यह सैंपल कोड, सूचनाओं के ज़रिए इनकमिंग और आउटगोइंग पेलोड की प्रोग्रेस दिखाने का एक तरीका दिखाता है:

class ReceiveWithProgressCallback extends PayloadCallback {
  private final SimpleArrayMap<Long, NotificationCompat.Builder> incomingPayloads =
      new SimpleArrayMap<>();
  private final SimpleArrayMap<Long, NotificationCompat.Builder> outgoingPayloads =
      new SimpleArrayMap<>();

  NotificationManager notificationManager =
      (NotificationManager) context.getSystemService(Context.NOTIFICATION_SERVICE);

  private void sendPayload(String endpointId, Payload payload) {
    if (payload.getType() == Payload.Type.BYTES) {
      // No need to track progress for bytes.
      return;
    }

    // Build and start showing the notification.
    NotificationCompat.Builder notification = buildNotification(payload, /*isIncoming=*/ false);
    notificationManager.notify((int) payload.getId(), notification.build());

    // Add it to the tracking list so we can update it.
    outgoingPayloads.put(payload.getId(), notification);
  }

  private NotificationCompat.Builder buildNotification(Payload payload, boolean isIncoming) {
    NotificationCompat.Builder notification =
        new NotificationCompat.Builder(context)
            .setContentTitle(isIncoming ? "Receiving..." : "Sending...");
    boolean indeterminate = false;
    if (payload.getType() == Payload.Type.STREAM) {
      // We can only show indeterminate progress for stream payloads.
      indeterminate = true;
    }
    notification.setProgress(100, 0, indeterminate);
    return notification;
  }

  @Override
  public void onPayloadReceived(String endpointId, Payload payload) {
    if (payload.getType() == Payload.Type.BYTES) {
      // No need to track progress for bytes.
      return;
    }

    // Build and start showing the notification.
    NotificationCompat.Builder notification = buildNotification(payload, true /*isIncoming*/);
    notificationManager.notify((int) payload.getId(), notification.build());

    // Add it to the tracking list so we can update it.
    incomingPayloads.put(payload.getId(), notification);
  }

  @Override
  public void onPayloadTransferUpdate(String endpointId, PayloadTransferUpdate update) {
    long payloadId = update.getPayloadId();
    NotificationCompat.Builder notification = null;
    if (incomingPayloads.containsKey(payloadId)) {
      notification = incomingPayloads.get(payloadId);
      if (update.getStatus() != PayloadTransferUpdate.Status.IN_PROGRESS) {
        // This is the last update, so we no longer need to keep track of this notification.
        incomingPayloads.remove(payloadId);
      }
    } else if (outgoingPayloads.containsKey(payloadId)) {
      notification = outgoingPayloads.get(payloadId);
      if (update.getStatus() != PayloadTransferUpdate.Status.IN_PROGRESS) {
        // This is the last update, so we no longer need to keep track of this notification.
        outgoingPayloads.remove(payloadId);
      }
    }

    if (notification == null) {
      return;
    }

    switch (update.getStatus()) {
      case PayloadTransferUpdate.Status.IN_PROGRESS:
        long size = update.getTotalBytes();
        if (size == -1) {
          // This is a stream payload, so we don't need to update anything at this point.
          return;
        }
        int percentTransferred =
            (int) (100.0 * (update.getBytesTransferred() / (double) update.getTotalBytes()));
        notification.setProgress(100, percentTransferred, /* indeterminate= */ false);
        break;
      case PayloadTransferUpdate.Status.SUCCESS:
        // SUCCESS always means that we transferred 100%.
        notification
            .setProgress(100, 100, /* indeterminate= */ false)
            .setContentText("Transfer complete!");
        break;
      case PayloadTransferUpdate.Status.FAILURE:
      case PayloadTransferUpdate.Status.CANCELED:
        notification.setProgress(0, 0, false).setContentText("Transfer failed");
        break;
      default:
        // Unknown status.
    }

    notificationManager.notify((int) payloadId, notification.build());
  }
}