blob: fd8302952dc18745b1820692758229fdbe17eac0 [file] [log] [blame]
// Copyright (c) 2011 The Chromium OS 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 <map>
#include <string>
#include <base/memory/scoped_ptr.h>
#include <base/memory/singleton.h>
#include <gtest/gtest_prod.h> // for FRIEND_TEST
#include "shill/refptr_types.h"
namespace shill {
class ControlInterface;
class DHCPCDListener;
class EventDispatcher;
class GLib;
// DHCPProvider is a singleton providing the main DHCP configuration
// entrypoint. Once the provider is initialized through its Init method, DHCP
// configurations for devices can be obtained through its CreateConfig
// method. For example, a single DHCP configuration request can be initiated as:
// DHCPProvider::GetInstance()->CreateConfig(device_name)->Request();
class DHCPProvider {
// This is a singleton -- use DHCPProvider::GetInstance()->Foo()
static DHCPProvider *GetInstance();
// Initializes the provider singleton. This method hooks up a D-Bus signal
// listener that catches signals from spawned DHCP clients and dispatches them
// to the appropriate DHCP configuration instance.
void Init(ControlInterface *control_interface,
EventDispatcher *dispatcher,
GLib *glib);
// Creates a new DHCPConfig for |device_name|. The DHCP configuration for the
// device can then be initiated through DHCPConfig::Request and
// DHCPConfig::Renew.
DHCPConfigRefPtr CreateConfig(const std::string &device_name);
// Returns the DHCP configuration associated with DHCP client |pid|. Return
// NULL if |pid| is not bound to a configuration.
DHCPConfigRefPtr GetConfig(int pid);
// Binds a |pid| to a DHCP |config|. When a DHCP config spawns a new DHCP
// client, it binds itself to that client's |pid|.
void BindPID(int pid, const DHCPConfigRefPtr &config);
// Unbinds a |pid|. This method is used by a DHCP config to signal the
// provider that the DHCP client has been terminated. This may result in
// destruction of the DHCP config instance if its reference count goes to 0.
void UnbindPID(int pid);
friend struct DefaultSingletonTraits<DHCPProvider>;
friend class DHCPProviderTest;
friend class DeviceInfoTest;
friend class DeviceTest;
FRIEND_TEST(DHCPProviderTest, CreateConfig);
typedef std::map<int, DHCPConfigRefPtr> PIDConfigMap;
// Private to ensure that this behaves as a singleton.
virtual ~DHCPProvider();
// A single listener is used to catch signals from all DHCP clients and
// dispatch them to the appropriate DHCP configuration instance.
scoped_ptr<DHCPCDListener> listener_;
// A map that binds PIDs to DHCP configuration instances.
PIDConfigMap configs_;
ControlInterface *control_interface_;
EventDispatcher *dispatcher_;
GLib *glib_;
} // namespace shill