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
|
// Copyright 2014 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_SIGNALING_SIGNAL_STRATEGY_H_
#define REMOTING_SIGNALING_SIGNAL_STRATEGY_H_
#include <memory>
#include <string>
#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 {
public:
enum State {
// Connection is being established.
CONNECTING,
// Signalling is connected.
CONNECTED,
// Connection is closed due to an error or because Disconnect()
// was called.
DISCONNECTED,
};
enum Error {
OK,
AUTHENTICATION_FAILED,
NETWORK_ERROR,
PROTOCOL_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 {
public:
~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() {}
SignalStrategy(const SignalStrategy&) = delete;
SignalStrategy& operator=(const SignalStrategy&) = delete;
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 sent.
virtual bool SendStanza(std::unique_ptr<jingle_xmpp::XmlElement> stanza) = 0;
// Sends a ChromotingMessage. Returns false if the message couldn't be sent.
virtual bool SendMessage(const SignalingAddress& destination_address,
const ftl::ChromotingMessage& message) = 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
#endif // REMOTING_SIGNALING_SIGNAL_STRATEGY_H_
|