blob: 2c16f8dc8be1b3c05203646f8bd34470408595bc [file] [log] [blame]
// Copyright 2014 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.
#include <memory>
#include <string>
#include "base/macros.h"
#include "base/observer_list_types.h"
namespace jingle_xmpp {
class XmlElement;
} // namespace jingle_xmpp
namespace remoting {
namespace ftl {
class ChromotingMessage;
class Id;
} // namespace ftl
class SignalingAddress;
class SignalStrategy {
enum State {
// Connection is being established.
// Signalling is connected.
// Connection is closed due to an error or because Disconnect()
// was called.
enum Error {
// Callback interface for signaling event. Event handlers are not
// allowed to destroy SignalStrategy, but may add or remove other
// listeners.
class Listener : public base::CheckedObserver {
~Listener() override {}
// Called after state of the connection has changed. If the state
// is DISCONNECTED, then GetError() can be used to get the reason
// for the disconnection.
virtual void OnSignalStrategyStateChange(State state) = 0;
// Must return true if the stanza was handled, false
// otherwise. The signal strategy must not be deleted from a
// handler of this message.
virtual bool OnSignalStrategyIncomingStanza(
const jingle_xmpp::XmlElement* stanza) = 0;
// This method is similar to OnSignalStrategyIncomingStanza(). It will be
// called by signal strategy that supports ChromotingMessage (i.e.
// FtlSignalStrategy) before OnSignalStrategyIncomingStanza() is called.
// Must return true if the message was handled, false
// otherwise. The signal strategy must not be deleted from a
// handler of this message.
// TODO(yuweih): Remove OnSignalStrategyIncomingStanza() and make this
// method pure virtual.
virtual bool OnSignalStrategyIncomingMessage(
const ftl::Id& sender_id,
const std::string& sender_registration_id,
const ftl::ChromotingMessage& message);
SignalStrategy() {}
virtual ~SignalStrategy() {}
// Starts connection attempt. If connection is currently active
// disconnects it and opens a new connection (implicit disconnect
// triggers CLOSED notification). Connection is finished
// asynchronously.
virtual void Connect() = 0;
// Disconnects current connection if connected. Triggers CLOSED
// notification.
virtual void Disconnect() = 0;
// Returns current state.
virtual State GetState() const = 0;
// Returns the last error. Set when state changes to DISCONNECT.
virtual Error GetError() const = 0;
// Local address. An empty value is returned when not connected.
virtual const SignalingAddress& GetLocalAddress() const = 0;
// Add a |listener| that can listen to all incoming
// messages. Doesn't take ownership of the |listener|. All listeners
// must be removed before this object is destroyed.
virtual void AddListener(Listener* listener) = 0;
// Remove a |listener| previously added with AddListener().
virtual void RemoveListener(Listener* listener) = 0;
// Sends a raw XMPP stanza. Returns false if the stanza couldn't be send.
virtual bool SendStanza(std::unique_ptr<jingle_xmpp::XmlElement> stanza) = 0;
// Returns new ID that should be used for the next outgoing IQ
// request.
virtual std::string GetNextId() = 0;
// Returns true if the signal strategy gets into an error state when it tries
// to sign in. You can get back the actual error by calling GetError().
// The default implementation always returns false.
virtual bool IsSignInError() const;
} // namespace remoting