inspector/InspectorAgentBase.h

   1 /*
   2  * Copyright (C) 2013 Apple Inc. All Rights Reserved.
   3  * Copyright (C) 2011 Google Inc. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef InspectorAgentBase_h
  28 #define InspectorAgentBase_h
  29
  30 #include <wtf/text/WTFString.h>
  31
  32 namespace Inspector {
  33
  34 class BackendDispatcher;
  35 class FrontendChannel;
  36
  37 enum class DisconnectReason {
  38     InspectedTargetDestroyed,
  39     InspectorDestroyed
  40 };
  41
  42 class InspectorAgentBase {
  43 public:
  44     virtual ~InspectorAgentBase() { }
  45
  46     String domainName() const { return m_name; }
  47
  48     virtual void didCreateFrontendAndBackend(FrontendChannel*, BackendDispatcher*) = 0;
  49     virtual void willDestroyFrontendAndBackend(DisconnectReason) = 0;
  50     virtual void discardAgent() { }
  51
  52 protected:
  53     InspectorAgentBase(const String& name)
  54         : m_name(name)
  55     {
  56     }
  57
  58     String m_name;
  59 };
  60
  61 } // namespace Inspector
  62
  63 #endif // !defined(InspectorAgentBase_h)