File: transfer_metadata.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (99 lines) | stat: -rw-r--r-- 2,925 bytes parent folder | download | duplicates (4)
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_NEARBY_SHARING_TRANSFER_METADATA_H_
#define CHROME_BROWSER_NEARBY_SHARING_TRANSFER_METADATA_H_

#include <optional>
#include <string>

#include "chrome/browser/ui/webui/nearby_share/nearby_share.mojom.h"

// Metadata about an ongoing transfer. Wraps transient data like status and
// progress. This is used to refresh the UI with error messages and show
// notifications so additions should be explicitly handled on the frontend.
class TransferMetadata {
 public:
  enum class Status {
    kUnknown,
    kConnecting,
    kAwaitingLocalConfirmation,
    kAwaitingRemoteAcceptance,
    kAwaitingRemoteAcceptanceFailed,
    kInProgress,
    kComplete,
    kFailed,
    kRejected,
    kCancelled,
    kTimedOut,
    kMediaUnavailable,
    kMediaDownloading,
    kNotEnoughSpace,
    kUnsupportedAttachmentType,
    kExternalProviderLaunched,
    kDecodeAdvertisementFailed,
    kMissingTransferUpdateCallback,
    kMissingShareTarget,
    kMissingEndpointId,
    kMissingPayloads,
    kPairedKeyVerificationFailed,
    kInvalidIntroductionFrame,
    kIncompletePayloads,
    kFailedToCreateShareTarget,
    kFailedToInitiateOutgoingConnection,
    kFailedToReadOutgoingConnectionResponse,
    kUnexpectedDisconnection,
    kMaxValue = kUnexpectedDisconnection
  };

  enum class Result {
    kIndeterminate,
    kSuccess,
    kFailure,
    kMaxValue = kFailure
  };

  static bool IsFinalStatus(Status status);

  static Result ToResult(Status status);

  static std::string StatusToString(TransferMetadata::Status status);

  static nearby_share::mojom::TransferStatus StatusToMojo(Status status);

  TransferMetadata(Status status,
                   float progress,
                   std::optional<std::string> token,
                   bool is_original,
                   bool is_final_status);
  ~TransferMetadata();
  TransferMetadata(const TransferMetadata&);
  TransferMetadata& operator=(const TransferMetadata&);

  Status status() const { return status_; }

  // Returns transfer progress as percentage.
  float progress() const { return progress_; }

  // Represents the UKey2 token from Nearby Connection. std::nullopt if no
  // UKey2 comparison is needed for this transfer.
  const std::optional<std::string>& token() const { return token_; }

  // True if this |TransferMetadata| has not been seen.
  bool is_original() const { return is_original_; }

  // True if this |TransferMetadata| is the last status for this transfer.
  bool is_final_status() const { return is_final_status_; }

  nearby_share::mojom::TransferMetadataPtr ToMojo() const;

 private:
  Status status_;
  float progress_;
  std::optional<std::string> token_;
  bool is_original_;
  bool is_final_status_;
};

#endif  // CHROME_BROWSER_NEARBY_SHARING_TRANSFER_METADATA_H_