src/include/common/http/TransportAgent.h

00001 /*
00002  * Funambol is a mobile platform developed by Funambol, Inc. 
00003  * Copyright (C) 2003 - 2007 Funambol, Inc.
00004  * 
00005  * This program is free software; you can redistribute it and/or modify it under
00006  * the terms of the GNU Affero General Public License version 3 as published by
00007  * the Free Software Foundation with the addition of the following permission 
00008  * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
00009  * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 
00010  * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
00011  * 
00012  * This program is distributed in the hope that it will be useful, but WITHOUT
00013  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00014  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
00015  * details.
00016  * 
00017  * You should have received a copy of the GNU Affero General Public License 
00018  * along with this program; if not, see http://www.gnu.org/licenses or write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
00020  * MA 02110-1301 USA.
00021  * 
00022  * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 
00023  * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
00024  * 
00025  * The interactive user interfaces in modified source and object code versions
00026  * of this program must display Appropriate Legal Notices, as required under
00027  * Section 5 of the GNU Affero General Public License version 3.
00028  * 
00029  * In accordance with Section 7(b) of the GNU Affero General Public License
00030  * version 3, these Appropriate Legal Notices must retain the display of the
00031  * "Powered by Funambol" logo. If the display of the logo is not reasonably 
00032  * feasible for technical reasons, the Appropriate Legal Notices must display
00033  * the words "Powered by Funambol".
00034  */
00035 
00036 #ifndef INCL_TRANSPORT_AGENT
00037     #define INCL_TRANSPORT_AGENT
00038 
00040     #include "base/fscapi.h"
00041 
00042     #include "http/URL.h"
00043     #include "http/Proxy.h"
00044 
00045     //
00046     // number of seconds of waiting response timeout.
00047     //
00048     #define DEFAULT_MAX_TIMEOUT 300
00049 
00050     //
00051     // The max_msg_size parameter. Default is 512k.
00052     // The value is expressed in byte
00053     //
00054     #define DEFAULT_MAX_MSG_SIZE 512000
00055 
00056     //
00057     // This is the default value for the size of the buffer used to store the
00058     // incoming stram from server. It is expressed in byte
00059     //
00060     #define DEFAULT_INTERNET_READ_BUFFER_SIZE  4096
00061 
00062     /*
00063      * This class is the transport agent responsible for messages exchange
00064      * over an HTTP connection.
00065      * This is a generic abtract class which is not bound to any paltform
00066      */
00067 
00068     class TransportAgent {
00069 
00070     protected:
00071         URL url;
00072         Proxy proxy;
00073 
00074         unsigned int timeout;
00075         unsigned int maxmsgsize;
00076         unsigned int readBufferSize;
00077         char userAgent[128];
00078         BOOL compression;
00079 
00080     public:
00081         TransportAgent();
00082         TransportAgent(URL& url,
00083                        Proxy& proxy,
00084                        unsigned int responseTimeout = DEFAULT_MAX_TIMEOUT,
00085                        unsigned int maxmsgsize = DEFAULT_MAX_MSG_SIZE);
00086 
00087         virtual ~TransportAgent();
00088 
00089         /*
00090          * Change the URL the subsequent calls to setMessage() should
00091          * use as target url.
00092          *
00093          * @param url the new target url
00094          */
00095         virtual void setURL(URL& newURL);
00096 
00097         /*
00098          * Returns the url.
00099          */
00100         virtual URL& getURL();
00101 
00107         virtual void setTimeout(unsigned int t);
00108 
00112         virtual unsigned int getTimeout();
00113 
00119         virtual void setMaxMsgSize(unsigned int t);
00120 
00124         virtual unsigned int getMaxMsgSize();
00125 
00131         virtual void setReadBufferSize(unsigned int t);
00132 
00133         virtual void setUserAgent(const char*  ua);
00134 
00135         virtual void setCompression(BOOL newCompression);
00136         virtual BOOL getCompression();
00137 
00138         virtual const char* getUserAgent();
00139 
00143         virtual unsigned int getReadBufferSize();
00144 
00145 
00146         /*
00147          * Sends the given SyncML message to the server specified
00148          * by the install property 'url'. Returns the server's response.
00149          * The response string has to be freed with delete [].
00150          * In case of an error, NULL is returned and lastErrorCode/Msg
00151          * is set.
00152          */
00153         virtual char*  sendMessage(const char*  msg) = 0;
00154 
00155     };
00156 
00158 #endif

Generated on Mon Feb 4 09:50:47 2008 for Funambol Outlook Plug-in Library by  doxygen 1.5.2