Home | History | Annotate | Download | only in websockets 
      1 /*
      2  * Copyright (C) 2012 Google Inc.  All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions are
      6  * met:
      7  *
      8  *     * Redistributions of source code must retain the above copyright
      9  * notice, this list of conditions and the following disclaimer.
     10  *     * Redistributions in binary form must reproduce the above
     11  * copyright notice, this list of conditions and the following disclaimer
     12  * in the documentation and/or other materials provided with the
     13  * distribution.
     14  *     * Neither the name of Google Inc. nor the names of its
     15  * contributors may be used to endorse or promote products derived from
     16  * this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 #ifndef WebSocketDeflateFramer_h
     32 #define WebSocketDeflateFramer_h
     33 
     34 #include "modules/websockets/WebSocketDeflater.h"
     35 #include "modules/websockets/WebSocketExtensionProcessor.h"
     36 #include "modules/websockets/WebSocketFrame.h"
     37 #include "wtf/OwnPtr.h"
     38 #include "wtf/PassOwnPtr.h"
     39 
     40 namespace WebCore {
     41 
     42 class WebSocketDeflateFramer;
     43 
     44 class DeflateResultHolder {
     45     WTF_MAKE_FAST_ALLOCATED;
     46 public:
     47     static PassOwnPtr<DeflateResultHolder> create(WebSocketDeflateFramer* framer)
     48     {
     49         return adoptPtr(new DeflateResultHolder(framer));
     50     }
     51 
     52     ~DeflateResultHolder();
     53 
     54     bool succeeded() const { return m_succeeded; }
     55     String failureReason() const { return m_failureReason; }
     56 
     57     void fail(const String& failureReason);
     58 
     59 private:
     60     explicit DeflateResultHolder(WebSocketDeflateFramer*);
     61 
     62     WebSocketDeflateFramer* m_framer;
     63     bool m_succeeded;
     64     String m_failureReason;
     65 };
     66 
     67 class InflateResultHolder {
     68     WTF_MAKE_FAST_ALLOCATED;
     69 public:
     70     static PassOwnPtr<InflateResultHolder> create(WebSocketDeflateFramer* framer)
     71     {
     72         return adoptPtr(new InflateResultHolder(framer));
     73     }
     74 
     75     ~InflateResultHolder();
     76 
     77     bool succeeded() const { return m_succeeded; }
     78     String failureReason() const { return m_failureReason; }
     79 
     80     void fail(const String& failureReason);
     81 
     82 private:
     83     explicit InflateResultHolder(WebSocketDeflateFramer*);
     84 
     85     WebSocketDeflateFramer* m_framer;
     86     bool m_succeeded;
     87     String m_failureReason;
     88 };
     89 
     90 class WebSocketDeflateFramer {
     91 public:
     92     WebSocketDeflateFramer();
     93 
     94     PassOwnPtr<WebSocketExtensionProcessor> createExtensionProcessor();
     95 
     96     bool enabled() const { return m_enabled; }
     97 
     98     PassOwnPtr<DeflateResultHolder> deflate(WebSocketFrame&);
     99     void resetDeflateContext();
    100     PassOwnPtr<InflateResultHolder> inflate(WebSocketFrame&);
    101     void resetInflateContext();
    102 
    103     void didFail();
    104 
    105     void enableDeflate(int windowBits, WebSocketDeflater::ContextTakeOverMode);
    106 
    107 private:
    108     bool m_enabled;
    109     OwnPtr<WebSocketDeflater> m_deflater;
    110     OwnPtr<WebSocketInflater> m_inflater;
    111 };
    112 
    113 }
    114 
    115 #endif // WebSocketDeflateFramer_h
    116