blob: 2be2dfbb35c210096d876252be305e40aa4cfdf8 [file] [log] [blame]
// Copyright 2015 The Weave 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 <string>
#include <base/callback.h>
#include <weave/error.h>
#include <weave/stream.h>
namespace weave {
namespace provider {
// This interface should be implemented by the user of libweave and
// provided during device creation in Device::Create(...)
// libweave will use this interface to create and interact with network
// sockets, implementing XMPP push notifications channel.
// There are 2 main parts of this interface. One part is used to check network
// connection status and sign up for notification if connection status changes.
// Implementation of GetConnectionState() should return current network
// connection state (enum Network::State).
// Implementation of AddConnectionChangedCallback() should remember callback
// and invoke it network connection status changes.
// Second part of the interface is used to create new secure (SSL) socket and
// provide functionality to read/write data into sockets.
// Implementation of OpenSslSocket() should create SSL socket using whatever
// underlying mechanism is available on the current platform. It should also
// wrap read / write / disconnect functionality into Stream interface
// (include/weave/stream.h) and call OpenSslSocketCallback() callback
// with pointer to the Stream interface implementation.
// Reading data from the socket will be done through InputStream::Read()
// function. Writing to socket - through OutputStream::Write().
// Interface with methods to detect network connectivity and opening network
// connections.
class Network {
enum class State {
kOffline = 0,
// Callback type for AddConnectionChangedCallback.
using ConnectionChangedCallback = base::Closure;
// Callback type for OpenSslSocket.
using OpenSslSocketCallback =
base::Callback<void(std::unique_ptr<Stream> stream, ErrorPtr error)>;
// Subscribes to notification about changes in network connectivity. Changes
// may include but not limited: interface up or down, new IP was assigned,
// cable is disconnected.
virtual void AddConnectionChangedCallback(
const ConnectionChangedCallback& callback) = 0;
// Returns current Internet connectivity state
virtual State GetConnectionState() const = 0;
// Opens bidirectional sockets and returns attached stream.
virtual void OpenSslSocket(const std::string& host,
uint16_t port,
const OpenSslSocketCallback& callback) = 0;
virtual ~Network() {}
} // namespace provider
} // namespace weave