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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef REMOTING_PROTOCOL_JINGLE_MESSAGES_H_
#define REMOTING_PROTOCOL_JINGLE_MESSAGES_H_
#include <list>
#include <memory>
#include <string>
#include "remoting/protocol/errors.h"
#include "third_party/libjingle_xmpp/xmllite/xmlelement.h"
#include "third_party/webrtc/p2p/base/candidate.h"
namespace remoting {
namespace protocol {
class ContentDescription;
// Represents an address of a Chromoting endpoint and its routing channel.
// TODO(kelvinp): Move the struct to remoting/signaling. Potentially we could
// update SignalStrategy interface to use this instead of jid for addressing.
class SignalingAddress {
public:
enum class Channel { LCS, XMPP };
SignalingAddress();
SignalingAddress(const std::string& jid);
SignalingAddress(const std::string& jid,
const std::string& endpoint_id,
Channel channel);
const std::string& jid() const { return jid_; }
const std::string& endpoint_id() const { return endpoint_id_; }
Channel channel() const { return channel_; }
const std::string& id() const {
return (channel_ == Channel::LCS) ? endpoint_id_ : jid_;
}
bool empty() const { return jid_.empty(); }
bool operator==(const SignalingAddress& other) const;
bool operator!=(const SignalingAddress& other) const;
private:
// Represents the |to| or |from| field in an IQ stanza.
std::string jid_;
// Represents the identifier of an endpoint. In LCS, this is the LCS address
// encoded in a JID like format. In XMPP, it is empty.
std::string endpoint_id_;
Channel channel_;
};
struct JingleMessage {
enum ActionType {
UNKNOWN_ACTION,
SESSION_INITIATE,
SESSION_ACCEPT,
SESSION_TERMINATE,
SESSION_INFO,
TRANSPORT_INFO,
};
enum Reason {
UNKNOWN_REASON,
SUCCESS,
DECLINE,
CANCEL,
EXPIRED,
GENERAL_ERROR,
FAILED_APPLICATION,
INCOMPATIBLE_PARAMETERS,
};
JingleMessage();
JingleMessage(const SignalingAddress& to,
ActionType action_value,
const std::string& sid_value);
~JingleMessage();
// Caller keeps ownership of |stanza|.
static bool IsJingleMessage(const buzz::XmlElement* stanza);
static std::string GetActionName(ActionType action);
// Caller keeps ownership of |stanza|. |error| is set to debug error
// message when parsing fails.
bool ParseXml(const buzz::XmlElement* stanza, std::string* error);
// Adds an XmlElement into |attachments|. This function implicitly creates
// |attachments| if it's empty, and |attachment| should not be an empty
// unique_ptr.
void AddAttachment(std::unique_ptr<buzz::XmlElement> attachment);
std::unique_ptr<buzz::XmlElement> ToXml() const;
SignalingAddress from;
SignalingAddress to;
ActionType action = UNKNOWN_ACTION;
std::string sid;
std::string initiator;
std::unique_ptr<ContentDescription> description;
std::unique_ptr<buzz::XmlElement> transport_info;
// Content of session-info messages.
std::unique_ptr<buzz::XmlElement> info;
// Content of plugin message. The node is read or written by all plugins, and
// ActionType independent.
std::unique_ptr<buzz::XmlElement> attachments;
// Value from the <reason> tag if it is present in the
// message. Useful mainly for session-terminate messages, but Jingle
// spec allows it in any message.
Reason reason = UNKNOWN_REASON;
// Value from the <google:remoting:error-code> tag if it is present in the
// message. Useful mainly for session-terminate messages. If it's UNKNOWN,
// or reason is UNKNOWN_REASON, this field will be ignored in the xml output.
ErrorCode error_code = UNKNOWN_ERROR;
};
struct JingleMessageReply {
enum ReplyType {
REPLY_RESULT,
REPLY_ERROR,
};
enum ErrorType {
NONE,
BAD_REQUEST,
NOT_IMPLEMENTED,
INVALID_SID,
UNEXPECTED_REQUEST,
UNSUPPORTED_INFO,
};
JingleMessageReply();
JingleMessageReply(ErrorType error);
JingleMessageReply(ErrorType error, const std::string& text);
~JingleMessageReply();
// Formats reply stanza for the specified |request_stanza|. Id and
// recepient as well as other information needed to generate a valid
// reply are taken from |request_stanza|.
std::unique_ptr<buzz::XmlElement> ToXml(
const buzz::XmlElement* request_stanza) const;
ReplyType type;
ErrorType error_type;
std::string text;
};
struct IceTransportInfo {
IceTransportInfo();
~IceTransportInfo();
struct NamedCandidate {
NamedCandidate() = default;
NamedCandidate(const std::string& name,
const cricket::Candidate& candidate);
std::string name;
cricket::Candidate candidate;
};
struct IceCredentials {
IceCredentials() = default;
IceCredentials(std::string channel,
std::string ufrag,
std::string password);
std::string channel;
std::string ufrag;
std::string password;
};
// Caller keeps ownership of |stanza|. |error| is set to debug error
// message when parsing fails.
bool ParseXml(const buzz::XmlElement* stanza);
std::unique_ptr<buzz::XmlElement> ToXml() const;
std::list<IceCredentials> ice_credentials;
std::list<NamedCandidate> candidates;
};
} // protocol
} // remoting
#endif // REMOTING_PROTOCOL_JINGLE_MESSAGES_H_
|
