summaryrefslogtreecommitdiffstats
path: root/net/http/http_getzip_factory.h
blob: f7cced0b06bba7b9e9229b68f6655f429b65e78e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/**
 * Copyright (c) 2012, Code Aurora Forum. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other *materials provided
 *     with the distribution.
 *   * Neither the name of Code Aurora Forum, Inc. nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.

 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 **/

#ifndef HTTP_GETZIP_FACTORY_H_
#define HTTP_GETZIP_FACTORY_H_

#include "net/socket/client_socket.h"
#include <sys/types.h>
#include "base/basictypes.h"

namespace net
{

//forward declarations
class HttpRequestHeaders;
class HttpResponseHeaders;

typedef enum
{
  GETZIP_OK                  = 1,
  REQUEST_RETRY_NEEDED       = 2, //GETzip failure that requires last request retry
  NULL_ARGUMENT              = 3, //One of the passed argument was NULL
  NO_GETZIP_CONNECTION       = 4  //No GETzip connection was found
} GETZipDecompressionStatus;

//Main GetZip interface
class IGetZipManager
{
public:
  IGetZipManager();
  virtual void CompressRequestHeaders(HttpRequestHeaders&, ClientSocket*) = 0;
  virtual GETZipDecompressionStatus
      DecompressResponseHeaders(HttpResponseHeaders*, ClientSocket*) = 0;
  virtual void StopGetZipConnection(ClientSocket*) = 0;
  virtual void OpenGetZipConnection(ClientSocket*) = 0;
  virtual ~IGetZipManager() = 0;

private:
  DISALLOW_COPY_AND_ASSIGN(IGetZipManager);
};

//Simple, non private GetZip manager implementation
class GetZipManager: public IGetZipManager
{
public:

  GetZipManager();
  virtual ~GetZipManager()
  {
  }
  ;

  virtual void CompressRequestHeaders(HttpRequestHeaders&, ClientSocket*)
  {
  }
  ;
  virtual GETZipDecompressionStatus DecompressResponseHeaders(HttpResponseHeaders*, ClientSocket*)
  {
    return NO_GETZIP_CONNECTION;
  }
  ;
  virtual void StopGetZipConnection(ClientSocket*)
  {
  }
  ;
  virtual void OpenGetZipConnection(ClientSocket*)
  {
  }
  ;

private:
  DISALLOW_COPY_AND_ASSIGN(GetZipManager);
};

//This class is used to initialize GetZip manager
//First tries to initialize GetZipManager from proprietary library,
//if the library does not exist, creates GetZipManager
//Note: In the current implementation of network stack all the actions
//related to GetZipManager and GetZipFactory are carried out via IOThread
//hence, the implementation is not synchronized (this might change in the future).
class HttpGetZipFactory
{

public:

  //GetZipManager is kept within HttpGetZipFactory,
  //which is singleton.
  //This method is used to access the GetZipManager
  //Don't use it before initializing HttpGetZipFactory object.
  static IGetZipManager* GetGETZipManager();

  //Initialization must be called before accessing
  //GetZipManager for the first time.
  static void InitGETZipManager();

  void StopGETZipManager();

private:
  IGetZipManager* m_pMngr;
  static HttpGetZipFactory* s_pFactory;

  void* libHandle;

  HttpGetZipFactory();
  ~HttpGetZipFactory();

  DISALLOW_COPY_AND_ASSIGN(HttpGetZipFactory);
};

}; //end network
#endif /* HTTP_GETZIP_FACTORY_H_ */