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
|
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//
// Utility methods for MCS interactions.
#ifndef GOOGLE_APIS_GCM_BASE_MCS_UTIL_H_
#define GOOGLE_APIS_GCM_BASE_MCS_UTIL_H_
#include <stdint.h>
#include <memory>
#include <string>
#include <vector>
#include "google_apis/gcm/base/gcm_export.h"
#include "google_apis/gcm/protocol/mcs.pb.h"
namespace base {
class Clock;
}
namespace gcm {
// MCS Message tags.
// WARNING: the order of these tags must remain the same, as the tag values
// must be consistent with those used on the server.
enum MCSProtoTag {
kHeartbeatPingTag = 0,
kHeartbeatAckTag,
kLoginRequestTag,
kLoginResponseTag,
kCloseTag,
kMessageStanzaTag,
kPresenceStanzaTag,
kIqStanzaTag,
kDataMessageStanzaTag,
kBatchPresenceStanzaTag,
kStreamErrorStanzaTag,
kHttpRequestTag,
kHttpResponseTag,
kBindAccountRequestTag,
kBindAccountResponseTag,
kTalkMetadataTag,
kNumProtoTypes,
};
enum MCSIqStanzaExtension {
kSelectiveAck = 12,
kStreamAck = 13,
};
// Builds a LoginRequest with the hardcoded local data.
GCM_EXPORT std::unique_ptr<mcs_proto::LoginRequest> BuildLoginRequest(
uint64_t auth_id,
uint64_t auth_token,
const std::string& version_string);
// Builds a StreamAck IqStanza message.
GCM_EXPORT std::unique_ptr<mcs_proto::IqStanza> BuildStreamAck();
GCM_EXPORT std::unique_ptr<mcs_proto::IqStanza> BuildSelectiveAck(
const std::vector<std::string>& acked_ids);
// Utility methods for building and identifying MCS protobufs.
GCM_EXPORT std::unique_ptr<google::protobuf::MessageLite> BuildProtobufFromTag(
uint8_t tag);
GCM_EXPORT int GetMCSProtoTag(const google::protobuf::MessageLite& message);
// RMQ utility methods for extracting/setting common data from/to protobufs.
GCM_EXPORT std::string GetPersistentId(
const google::protobuf::MessageLite& message);
GCM_EXPORT void SetPersistentId(
const std::string& persistent_id,
google::protobuf::MessageLite* message);
GCM_EXPORT uint32_t
GetLastStreamIdReceived(const google::protobuf::MessageLite& protobuf);
GCM_EXPORT void SetLastStreamIdReceived(
uint32_t last_stream_id_received,
google::protobuf::MessageLite* protobuf);
// Returns whether the TTL (time to live) for this message has expired, based
// on the |sent| timestamps and base::TimeTicks::Now(). If |protobuf| is not
// for a DataMessageStanza or the TTL is 0, will return false.
GCM_EXPORT bool HasTTLExpired(const google::protobuf::MessageLite& protobuf,
base::Clock* clock);
GCM_EXPORT int GetTTL(const google::protobuf::MessageLite& protobuf);
// Returns whether the message was sent with an immediate ack request.
GCM_EXPORT bool IsImmediateAckRequested(
const google::protobuf::MessageLite& protobuf);
} // namespace gcm
#endif // GOOGLE_APIS_GCM_BASE_MCS_UTIL_H_
|
