View Javadoc

1   //
2   //  ========================================================================
3   //  Copyright (c) 1995-2016 Mort Bay Consulting Pty. Ltd.
4   //  ------------------------------------------------------------------------
5   //  All rights reserved. This program and the accompanying materials
6   //  are made available under the terms of the Eclipse Public License v1.0
7   //  and Apache License v2.0 which accompanies this distribution.
8   //
9   //      The Eclipse Public License is available at
10  //      http://www.eclipse.org/legal/epl-v10.html
11  //
12  //      The Apache License v2.0 is available at
13  //      http://www.opensource.org/licenses/apache2.0.php
14  //
15  //  You may elect to redistribute this code under either of these licenses.
16  //  ========================================================================
17  //
18  
19  package org.eclipse.jetty.websocket.client.masks;
20  
21  import org.eclipse.jetty.websocket.common.WebSocketFrame;
22  
23  /**
24   * Interface for various Masker implementations.
25   */
26  public interface Masker
27  {
28      /**
29       * Set the mask on the provided {@link WebSocketFrame}.
30       * <p>
31       * Implementations MUST set the mask on the frame.
32       * 
33       * @param frame
34       *            the frame to set the mask on.
35       */
36      void setMask(WebSocketFrame frame);
37  }