Back to index

lightning-sunbird  0.9+nobinonly
nsSOCKSSocketProvider.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is mozilla.org code.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corporation.
00020  * Portions created by the Initial Developer are Copyright (C) 1998
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *   Justin Bradford <jab@atdot.org>
00025  *   Darin Fisher <darin@meer.net>
00026  *
00027  * Alternatively, the contents of this file may be used under the terms of
00028  * either the GNU General Public License Version 2 or later (the "GPL"), or
00029  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00030  * in which case the provisions of the GPL or the LGPL are applicable instead
00031  * of those above. If you wish to allow use of your version of this file only
00032  * under the terms of either the GPL or the LGPL, and not to allow others to
00033  * use your version of this file under the terms of the MPL, indicate your
00034  * decision by deleting the provisions above and replace them with the notice
00035  * and other provisions required by the GPL or the LGPL. If you do not delete
00036  * the provisions above, a recipient may use your version of this file under
00037  * the terms of any one of the MPL, the GPL or the LGPL.
00038  *
00039  * ***** END LICENSE BLOCK ***** */
00040 
00041 #ifndef nsSOCKSSocketProvider_h__
00042 #define nsSOCKSSocketProvider_h__
00043 
00044 #include "nsISocketProvider.h"
00045 
00046 // values for ctor's |version| argument
00047 enum {
00048     NS_SOCKS_VERSION_4 = 4,
00049     NS_SOCKS_VERSION_5 = 5
00050 };
00051 
00052 class nsSOCKSSocketProvider : public nsISocketProvider
00053 {
00054 public:
00055     NS_DECL_ISUPPORTS
00056     NS_DECL_NSISOCKETPROVIDER
00057     
00058     nsSOCKSSocketProvider(PRUint32 version) : mVersion(version) {}
00059     virtual ~nsSOCKSSocketProvider() {}
00060     
00061     static NS_METHOD CreateV4(nsISupports *, REFNSIID aIID, void **aResult);
00062     static NS_METHOD CreateV5(nsISupports *, REFNSIID aIID, void **aResult);
00063     
00064 private:
00065     PRUint32 mVersion; // NS_SOCKS_VERSION_4 or 5
00066 };
00067 
00068 #endif /* nsSOCKSSocketProvider_h__ */