1 karl  1.9 //%2004////////////////////////////////////////////////////////////////////////

  2 kumpf 1.1 //

  3 karl  1.9 // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
  4           // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
  5           // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;

  6 karl  1.8 // IBM Corp.; EMC Corporation, The Open Group.

  7 karl  1.9 // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
  8           // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.

  9 kumpf 1.1 //
 10           // Permission is hereby granted, free of charge, to any person obtaining a copy
 11           // of this software and associated documentation files (the "Software"), to
 12           // deal in the Software without restriction, including without limitation the
 13           // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 14           // sell copies of the Software, and to permit persons to whom the Software is
 15           // furnished to do so, subject to the following conditions:

 16 kumpf 1.2 // 

 17 kumpf 1.1 // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
 18           // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
 19           // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 20           // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 21           // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 22           // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 23           // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 24           // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 25           //
 26           //==============================================================================
 27           //

 28 tony  1.6 // Author: Dong Xiang, EMC Corporation (xiang_dong@emc.com)

 29 kumpf 1.1 //
 30           // Modified By:
 31           //
 32           //%/////////////////////////////////////////////////////////////////////////////
 33           
 34           #ifndef Pegasus_Listener_h
 35           #define Pegasus_Listener_h
 36           
 37           #include <Pegasus/Common/Config.h>

 38 chuck 1.3 #include <Pegasus/Listener/Linkage.h>

 39 kumpf 1.1 
 40           PEGASUS_NAMESPACE_BEGIN
 41           

 42 tony  1.6 class SSLContext;
 43           class CIMIndicationConsumer;

 44 kumpf 1.1 

 45 karl  1.7 
 46           /** CIMListener provides the interfaces that allows CIMListeners to be
 47               created and managed. CIMListeners are the receivers for cim/xml indications.
 48               ATTN: KS needs to be completed.TBD
 49           */

 50 kumpf 1.1 class PEGASUS_LISTENER_LINKAGE CIMListener
 51           {
 52           public:

 53 tony  1.6 	/**
 54           	 * Constructs a CIMListener object.
 55           	 * 
 56           	 * @param portNumber	the specified socket port the listener will listen to
 57              * @param sslContext	the specifed SSL context 
 58           	 */
 59           	CIMListener(Uint32 portNumber, SSLContext* sslContext=NULL);
 60           	/**
 61           	 * Destructor of a CIMLIstener object.
 62           	 */

 63 kumpf 1.1     ~CIMListener();
 64           

 65 tony  1.6 	/**
 66           	 * Returns the socket port number
 67           	 *
 68           	 * @return the socket port number.
 69               */
 70           	Uint32 getPortNumber() const;
 71           
 72           	/**
 73           	 * Returns the SSL context
 74           	 *
 75           	 * @return the SSL context.
 76               */
 77           	SSLContext* getSSLContext() const;
 78           
 79           	/** 
 80           	 * Sets the SSL context
 81           	 *
 82           	 * @param the SSL context.
 83               */
 84           	void setSSLContext(SSLContext* sslContext);
 85           
 86 tony  1.6 	/** 
 87           	 * Starts for listening.
 88               */
 89           	void start();
 90           
 91           	/**
 92           	 * Stops listening
 93               */
 94           	void stop();
 95           
 96           	/**
 97           	 * Returns if the listener is active
 98           	 *
 99           	 * @return true if the listener is active;
100           	 *				 false otherwise.
101               */
102           	Boolean isAlive();
103           
104           	/** 
105           	 * Adds a CIMIndicationConsumer to the listener
106              *
107 tony  1.6 	 * @param the CIMIndicationConsumer to add.
108           	 * @return true if the indication consumer has been added successfully
109           	 *				 false otherwise.
110           	 */
111           	Boolean addConsumer(CIMIndicationConsumer* consumer);
112           	/** 
113           	 * Removes a CIMIndicationConsumer from the listener.
114           	 *
115           	 * @param the CIMIndicationConsumer to remove.
116           	 * @return true if the indication consumer has been removed successfully
117           	 *				 false otherwise.
118           	 */
119           	Boolean removeConsumer(CIMIndicationConsumer* consumer);

120 kumpf 1.1 
121           private:

122 tony  1.6 	void* _rep;

123 kumpf 1.1 };
124           
125           PEGASUS_NAMESPACE_END
126           
127           #endif /* Pegasus_Listener_h */