remoting/host/it2me/it2me_constants.h

// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef REMOTING_HOST_IT2ME_IT2ME_CONSTANTS_H_
#define REMOTING_HOST_IT2ME_IT2ME_CONSTANTS_H_

#include "remoting/host/native_messaging/native_messaging_constants.h"

namespace remoting {

// These state values are defined in the website client as well.  Remember to
// update both enums when making changes.
enum class It2MeHostState {
  kDisconnected,
  kStarting,
  kRequestedAccessCode,
  kReceivedAccessCode,
  kConnecting,
  kConnected,
  kError,
  kInvalidDomainError,
};

// Indicates that an OAuth access token can be provided to the host which will
// use it for service requests (e.g. ICE config, signaling, host registration).
extern const char kFeatureAccessTokenAuth[];

// Indicates that the host supports delegated signaling (i.e. allow the client
// to act as a signaling proxy).
extern const char kFeatureDelegatedSignaling[];

// Sent from the client to the host to begin the connection process.
extern const char kConnectMessage[];
// Connect message parameters.
extern const char kUserName[];
extern const char kAuthServiceWithToken[];
extern const char kLocalJid[];
extern const char kDirectoryBotJidValue[];
extern const char kIsEnterpriseAdminUser[];
extern const char kSuppressUserDialogs[];
extern const char kSuppressNotifications[];
extern const char kCurtainLocalUserSession[];
extern const char kTerminateUponInput[];
extern const char kUseElevatedHost[];
extern const char kUseSignalingProxy[];
extern const char kIceConfig[];
// Response sent back to the client after the Connect message has been handled.
extern const char kConnectResponse[];

// Message sent from the host to the client when the connection state changes.
// No response from the client is returned for this message.
extern const char kHostStateChangedMessage[];
// HostStateChanged message parameters.
extern const char kState[];
// Host state values which are associated with the |kState| field of the
// HostStateChanged message.
extern const char kHostStateError[];
extern const char kHostStateStarting[];
extern const char kHostStateRequestedAccessCode[];
extern const char kHostStateDomainError[];
extern const char kHostStateReceivedAccessCode[];
extern const char kHostStateDisconnected[];
extern const char kHostStateConnecting[];
extern const char kHostStateConnected[];
// Included in the message sent for the ReceivedAccessCode state.
extern const char kAccessCode[];
extern const char kAccessCodeLifetime[];
// Included in the message sent for the Connected state.
extern const char kClient[];
// Included in the message sent for the Disconnected state.
extern const char kDisconnectReason[];

// Sent from the client to the host to disconnect the current connection.
extern const char kDisconnectMessage[];
// Response sent to the client after the Disconnect message has been handled.
extern const char kDisconnectResponse[];

// Sent from the client to the host when an IQ stanza has been received over the
// signaling channel. Only applies when a signaling proxy is used.
extern const char kIncomingIqMessage[];
// Response sent to the client after the incoming iq message has been handled.
extern const char kIncomingIqResponse[];

// Message sent from the host to the client when an IQ stanza is ready to be
// sent to the other end of the signaling channel. Only applies when a signaling
// proxy is used. No response from the client is returned for this message.
extern const char kSendOutgoingIqMessage[];

// Parameter used for both incoming and outgoing IQ messages.
extern const char kIq[];

// Generic message sent from the host to the client when an error occurs.
extern const char kErrorMessage[];
extern const char kErrorMessageCode[];
extern const char kErrorMessageDescription[];

// Sent from the host when there is a change in the NAT traversal policies.
extern const char kNatPolicyChangedMessage[];
extern const char kNatPolicyChangedMessageNatEnabled[];
extern const char kNatPolicyChangedMessageRelayEnabled[];

// Sent from the host when there is a problem reading the local policy.
extern const char kPolicyErrorMessage[];

}  // namespace remoting

#endif  // REMOTING_HOST_IT2ME_IT2ME_CONSTANTS_H_