1 s.kodali 1.1 //%LICENSE////////////////////////////////////////////////////////////////
 2              //
 3              // Licensed to The Open Group (TOG) under one or more contributor license
 4              // agreements.  Refer to the OpenPegasusNOTICE.txt file distributed with
 5              // this work for additional information regarding copyright ownership.
 6              // Each contributor licenses this file to you under the OpenPegasus Open
 7              // Source License; you may not use this file except in compliance with the
 8              // License.
 9              //
10              // Permission is hereby granted, free of charge, to any person obtaining a
11              // copy of this software and associated documentation files (the "Software"),
12              // to deal in the Software without restriction, including without limitation
13              // the rights to use, copy, modify, merge, publish, distribute, sublicense,
14              // and/or sell copies of the Software, and to permit persons to whom the
15              // Software is furnished to do so, subject to the following conditions:
16              //
17              // The above copyright notice and this permission notice shall be included
18              // in all copies or substantial portions of the Software.
19              //
20              // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
21              // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 s.kodali 1.1 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23              // IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
24              // CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
25              // TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
26              // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27              //
28              //////////////////////////////////////////////////////////////////////////
29              //
30              //%/////////////////////////////////////////////////////////////////////////////
31              
32              #ifndef Pegasus_ProviderManagerRouter_h
33              #define Pegasus_ProviderManagerRouter_h
34              
35              #include <Pegasus/Common/Config.h>
36              #include <Pegasus/Common/Message.h>
37              #include <Pegasus/ProviderManagerRouter/Linkage.h>
38              
39              PEGASUS_NAMESPACE_BEGIN
40              
41              class PEGASUS_PMR_LINKAGE ProviderManagerRouter
42              {
43 s.kodali 1.1 public:
44                  ProviderManagerRouter();
45                  virtual ~ProviderManagerRouter();
46              
47                  /**
48                      Process the specified message by routing it to the appropriate
49                      ProviderManager.  Note: This operation may take a long time to
50                      complete and should be called on a non-critical thread.
51                   */
52                  virtual Message* processMessage(Message* message) = 0;
53              
54                  /**

55 karl     1.2         Cleanup idle providers and disconnected client requests in all

56 s.kodali 1.1         active ProviderManagers.
57                      Note: This operation may take a long time to complete and should
58                      be called on a non-critical thread.
59                   */
60                  virtual void idleTimeCleanup() = 0;
61              

62 karl     1.2     /*
63                      Cleanup enumerationContexts that have timed out with incomplete
64                      responses from the providers.
65                      @param contextId String defining the contextId to cleanup.  Note
66                      that the contextId is also the request messageId.
67                  */
68                  virtual void enumerationContextCleanup(const String& contextId) = 0;
69              

70 s.kodali 1.1     /**
71                      Sets the SubscriptionInitComplete flag indicating whether the Indication
72                      Service has completed its initialization.
73                   */
74                  virtual void setSubscriptionInitComplete
75                      (Boolean subscriptionInitComplete);
76              
77              protected:
78                  /**
79                      Indicates whether the Indication Service has completed initialization.
80                      During initialization, the Indication Service processes all active
81                      subscriptions from the repository, sending Create Subscription requests
82                      to the appropriate indication providers, and the providers'
83                      enableIndications method must be called only after all the Create
84                      Subscription requests have been processed.  Once Indication Service
85                      initialization is complete, the Indication Service sends the Provider
86                      Manager Service a Subscription Initialization Complete request message.
87                      At that time, the enableIndications method must be called on each
88                      provider with current subscriptions.  Subsequently, the
89                      enableIndications method must be called only after the first
90                      subscription is created for a provider, and the disableIndications
91 s.kodali 1.1         method must be called when the last subscription is deleted for a
92                      provider.
93                   */
94                  Boolean _subscriptionInitComplete;
95              };
96              
97              PEGASUS_NAMESPACE_END
98              
99              #endif