(file) Return to HTTPConnector.h CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Pegasus / Common

  1 martin 1.27 //%LICENSE////////////////////////////////////////////////////////////////
  2 martin 1.28 //
  3 martin 1.27 // 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 martin 1.28 //
 10 martin 1.27 // 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 martin 1.28 //
 17 martin 1.27 // The above copyright notice and this permission notice shall be included
 18             // in all copies or substantial portions of the Software.
 19 martin 1.28 //
 20 martin 1.27 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 21 martin 1.28 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 22 martin 1.27 // 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 martin 1.28 //
 28 martin 1.27 //////////////////////////////////////////////////////////////////////////
 29 mike   1.2  //
 30             //%/////////////////////////////////////////////////////////////////////////////
 31             
 32             #ifndef Pegasus_HTTPConnector_h
 33             #define Pegasus_HTTPConnector_h
 34             
 35             #include <Pegasus/Common/Config.h>
 36             #include <Pegasus/Common/Monitor.h>
 37             #include <Pegasus/Common/String.h>
 38             #include <Pegasus/Common/TLS.h>
 39 kumpf  1.13 #include <Pegasus/Common/Linkage.h>
 40 mike   1.2  
 41             PEGASUS_NAMESPACE_BEGIN
 42             
 43             struct HTTPConnectorRep;
 44 dj.gorey 1.18 
 45 mike     1.2  class HTTPConnection;
 46               
 47               /** This class is used by clients to establish a connection with a
 48                   server. For each established connection, a HTTPConnection object
 49                   is created.
 50               */
 51 kumpf    1.26 class PEGASUS_COMMON_LINKAGE HTTPConnector
 52 mike     1.2  {
 53 kumpf    1.24 public:
 54               
 55                   /** Constructor.
 56                       @param monitor pointer to monitor object which this class uses to
 57                       solicit SocketMessages on the server port (socket).
 58                   */
 59                   HTTPConnector(Monitor* monitor);
 60               
 61                   HTTPConnector(Monitor* monitor, SSLContext * sslcontext);
 62               
 63                   /** Destructor. */
 64                   ~HTTPConnector();
 65               
 66                   /** Establishes a new connection and creates an HTTPConnection object
 67                       to represent it.
 68               
 69                       @param host indicates host to connect to
 70                       @param portNumber indicates port number to use
 71                       @param sslContext Specifies the SSL context to use for this connection
 72 kumpf    1.25         @param timeoutMilliseconds Specifies the connection timeout.
 73                           If a socket is non-blocking and a connection is in progress after
 74                           the initial attempt, the connection will be attempted until the
 75                           specified timeout is reached.  If the specified timeout is zero,
 76                           the connection will not be re-attempted.  The timeout is not
 77                           applicable for a blocking socket.
 78 kumpf    1.24         @param outputMessageQueue output message queue for the HTTPConnection
 79                       that will be created.
 80                       @exception InvalidLocatorException
 81                       @exception CannotCreateSocketException
 82                       @exception CannotConnectException
 83                   */
 84                   HTTPConnection* connect(
 85                       const String& host,
 86                       const Uint32 portNumber,
 87                       SSLContext * sslContext,
 88 kumpf    1.25         Uint32 timeoutMilliseconds,
 89 kumpf    1.24         MessageQueue* outputMessageQueue);
 90               
 91                   /** Close the specified connection. */
 92                   void disconnect(HTTPConnection* connection);
 93               
 94               private:
 95               
 96                   Monitor* _monitor;
 97                   HTTPConnectorRep* _rep;
 98               
 99                   SSLContext* _sslcontext;
100 dj.gorey 1.18 };
101               
102 mike     1.2  PEGASUS_NAMESPACE_END
103               
104               #endif /* Pegasus_HTTPConnector_h */

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2