View Javadoc

1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.http.impl.io;
29  
30  import java.io.IOException;
31  import java.net.Socket;
32  
33  import org.apache.http.annotation.NotThreadSafe;
34  import org.apache.http.io.SessionOutputBuffer;
35  import org.apache.http.params.HttpParams;
36  
37  /**
38   * {@link SessionOutputBuffer} implementation bound to a {@link Socket}.
39   * <p>
40   * The following parameters can be used to customize the behavior of this
41   * class:
42   * <ul>
43   *  <li>{@link org.apache.http.params.CoreProtocolPNames#HTTP_ELEMENT_CHARSET}</li>
44   *  <li>{@link org.apache.http.params.CoreConnectionPNames#MIN_CHUNK_LIMIT}</li>
45   * </ul>
46   *
47   * @since 4.0
48   */
49  @NotThreadSafe
50  public class SocketOutputBuffer extends AbstractSessionOutputBuffer {
51  
52      /**
53       * Creates an instance of this class.
54       *
55       * @param socket the socket to write data to.
56       * @param buffersize the size of the internal buffer. If this number is less
57       *   than <code>0</code> it is set to the value of
58       *   {@link Socket#getSendBufferSize()}. If resultant number is less
59       *   than <code>1024</code> it is set to <code>1024</code>.
60       * @param params HTTP parameters.
61       */
62      public SocketOutputBuffer(
63              final Socket socket,
64              int buffersize,
65              final HttpParams params) throws IOException {
66          super();
67          if (socket == null) {
68              throw new IllegalArgumentException("Socket may not be null");
69          }
70          if (buffersize < 0) {
71              buffersize = socket.getSendBufferSize();
72          }
73          if (buffersize < 1024) {
74              buffersize = 1024;
75          }
76          init(socket.getOutputStream(), buffersize, params);
77      }
78  
79  }