1 /*- 2 * Copyright (c) 2013 Spectra Logic Corporation 3 * 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 * without modification. 11 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 12 * substantially similar to the "NO WARRANTY" disclaimer below 13 * ("Disclaimer") and any redistribution must be conditioned upon 14 * including a substantially similar Disclaimer requirement for further 15 * binary redistribution. 16 * 17 * NO WARRANTY 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 27 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28 * POSSIBILITY OF SUCH DAMAGES. 29 * 30 * Authors: Justin T. Gibbs (Spectra Logic Corporation) 31 * 32 * $FreeBSD$ 33 */ 34 35 /** 36 * \file devdctl_event_factory.h 37 */ 38 39 #ifndef _DEVDCTL_EVENT_FACTORY_H_ 40 #define _DEVDCTL_EVENT_FACTORY_H_ 41 42 /*============================ Namespace Control =============================*/ 43 namespace DevdCtl 44 { 45 46 /*============================= Class Definitions ============================*/ 47 /*------------------------------- EventFactory -------------------------------*/ 48 /** 49 * \brief Container for "event type" => "event object" creation methods. 50 */ 51 class EventFactory 52 { 53 public: 54 /** 55 * Event creation handlers are matched by event type and a 56 * string representing the system emitting the event. 57 */ 58 typedef std::pair<Event::Type, std::string> Key; 59 60 /** Map type for Factory method lookups. */ 61 typedef std::map<Key, Event::BuildMethod *> Registry; 62 63 /** Table record of factory methods to add to our registry. */ 64 struct Record 65 { 66 Event::Type m_type; 67 const char *m_subsystem; 68 Event::BuildMethod *m_buildMethod; 69 }; 70 71 const Registry &GetRegistry() const; 72 Event *Build(Event::Type type, NVPairMap &nvpairs, 73 const std::string eventString) const; 74 75 EventFactory(Event::BuildMethod *defaultBuildMethod = NULL); 76 77 void UpdateRegistry(Record regEntries[], size_t numEntries); 78 79 80 protected: 81 /** Registry of event factory methods providing O(log(n)) lookup. */ 82 Registry m_registry; 83 84 Event::BuildMethod *m_defaultBuildMethod; 85 }; 86 87 inline const EventFactory::Registry & 88 EventFactory::GetRegistry() const 89 { 90 return (m_registry); 91 } 92 93 } // namespace DevdCtl 94 #endif /*_DEVDCTL_EVENT_FACTORY_H_ */ 95