1 karl  1.22 //%2006////////////////////////////////////////////////////////////////////////

  2 mike  1.2  //

  3 karl  1.19 // 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.17 // IBM Corp.; EMC Corporation, The Open Group.

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

  9 karl  1.21 // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 10            // EMC Corporation; VERITAS Software Corporation; The Open Group.

 11 karl  1.22 // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 12            // EMC Corporation; Symantec Corporation; The Open Group.

 13 mike  1.2  //
 14            // Permission is hereby granted, free of charge, to any person obtaining a copy

 15 kumpf 1.11 // of this software and associated documentation files (the "Software"), to
 16            // deal in the Software without restriction, including without limitation the
 17            // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

 18 mike  1.2  // sell copies of the Software, and to permit persons to whom the Software is
 19            // furnished to do so, subject to the following conditions:
 20            // 

 21 kumpf 1.11 // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN

 22 mike  1.2  // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
 23            // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT

 24 kumpf 1.11 // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 25            // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 26            // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

 27 mike  1.2  // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 28            // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 29            //
 30            //==============================================================================
 31            //
 32            //%/////////////////////////////////////////////////////////////////////////////
 33            
 34            #ifndef Pegasus_HTTPConnector_h
 35            #define Pegasus_HTTPConnector_h
 36            
 37            #include <Pegasus/Common/Config.h>

 38 kumpf 1.23 #include <Pegasus/Common/MessageQueue.h>

 39 mike  1.2  #include <Pegasus/Common/Monitor.h>
 40            #include <Pegasus/Common/String.h>
 41            #include <Pegasus/Common/TLS.h>

 42 kumpf 1.13 #include <Pegasus/Common/Linkage.h>

 43 mike  1.2  
 44            PEGASUS_NAMESPACE_BEGIN
 45            
 46            struct HTTPConnectorRep;

 47 dj.gorey 1.18 

 48 mike     1.2  class HTTPConnection;
 49               
 50               /** This class is used by clients to establish a connection with a
 51                   server. For each established connection, a HTTPConnection object
 52                   is created.
 53               */

 54 kumpf    1.23 class PEGASUS_COMMON_LINKAGE HTTPConnector : public MessageQueue

 55 mike     1.2  {

 56 kumpf    1.24 public:
 57               
 58                   typedef MessageQueue Base;
 59               
 60                   /** Constructor.
 61                       @param monitor pointer to monitor object which this class uses to
 62                       solicit SocketMessages on the server port (socket).
 63                       @param outputMessageQueue ouptut message queue for connections
 64                       created by this connector.
 65                   */
 66                   HTTPConnector(Monitor* monitor);
 67               
 68                   HTTPConnector(Monitor* monitor, SSLContext * sslcontext);
 69               
 70                   /** Destructor. */
 71                   ~HTTPConnector();
 72               
 73                   /** This method is called whenever a SocketMessage is enqueued
 74                       on the input queue of the HTTPConnector object.
 75                   */
 76               
 77 kumpf    1.24     virtual void handleEnqueue(Message *);
 78                   virtual void handleEnqueue();
 79               
 80                   /** Establishes a new connection and creates an HTTPConnection object
 81                       to represent it.
 82               
 83                       @param host indicates host to connect to
 84                       @param portNumber indicates port number to use
 85                       @param sslContext Specifies the SSL context to use for this connection

 86 kumpf    1.25         @param timeoutMilliseconds Specifies the connection timeout.
 87                           If a socket is non-blocking and a connection is in progress after
 88                           the initial attempt, the connection will be attempted until the
 89                           specified timeout is reached.  If the specified timeout is zero,
 90                           the connection will not be re-attempted.  The timeout is not
 91                           applicable for a blocking socket.

 92 kumpf    1.24         @param outputMessageQueue output message queue for the HTTPConnection
 93                       that will be created.
 94                       @exception InvalidLocatorException
 95                       @exception CannotCreateSocketException
 96                       @exception CannotConnectException
 97                   */
 98                   HTTPConnection* connect(
 99                       const String& host,
100                       const Uint32 portNumber,
101                       SSLContext * sslContext,

102 kumpf    1.25         Uint32 timeoutMilliseconds,

103 kumpf    1.24         MessageQueue* outputMessageQueue);
104               
105                   /** Destroys all the connections created by this connector. */
106                   void destroyConnections();
107               
108                   /** Close the specified connection. */
109                   void disconnect(HTTPConnection* connection);
110               
111               private:
112               
113                   /** Delete the specified connection. */
114                   void _deleteConnection(HTTPConnection* httpConnection);
115               
116                   Monitor* _monitor;
117                   HTTPConnectorRep* _rep;
118               
119                   SSLContext* _sslcontext;
120                   int _entry_index;

121 dj.gorey 1.18 };
122               

123 mike     1.2  PEGASUS_NAMESPACE_END
124               
125               #endif /* Pegasus_HTTPConnector_h */