1 /*
2 * Copyright (c) 1995, 2007, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package java.net;
27
28 import java.io.FileDescriptor;
29 import java.io.FileOutputStream;
30 import java.io.IOException;
31 import java.nio.channels.FileChannel;
32
33 import sun.misc.IoTrace;
34
35 /**
36 * This stream extends FileOutputStream to implement a
37 * SocketOutputStream. Note that this class should <b>NOT</b> be
38 * public.
39 *
40 * @author Jonathan Payne
41 * @author Arthur van Hoff
42 */
43 class SocketOutputStream extends FileOutputStream
44 {
45 static {
46 init();
47 }
48
49 private AbstractPlainSocketImpl impl = null;
50 private byte temp[] = new byte[1];
51 private Socket socket = null;
52
53 /**
54 * Creates a new SocketOutputStream. Can only be called
55 * by a Socket. This method needs to hang on to the owner Socket so
56 * that the fd will not be closed.
57 * @param impl the socket output stream inplemented
58 */
59 SocketOutputStream(AbstractPlainSocketImpl impl) throws IOException {
60 super(impl.getFileDescriptor());
61 this.impl = impl;
62 socket = impl.getSocket();
63 }
64
65 /**
66 * Returns the unique {@link java.nio.channels.FileChannel FileChannel}
67 * object associated with this file output stream. </p>
68 *
69 * The <code>getChannel</code> method of <code>SocketOutputStream</code>
70 * returns <code>null</code> since it is a socket based stream.</p>
71 *
72 * @return the file channel associated with this file output stream
73 *
74 * @since 1.4
75 * @spec JSR-51
76 */
77 public final FileChannel getChannel() {
78 return null;
79 }
80
81 /**
82 * Writes to the socket.
83 * @param fd the FileDescriptor
84 * @param b the data to be written
85 * @param off the start offset in the data
86 * @param len the number of bytes that are written
87 * @exception IOException If an I/O error has occurred.
88 */
89 private native void socketWrite0(FileDescriptor fd, byte[] b, int off,
90 int len) throws IOException;
91
92 /**
93 * Writes to the socket with appropriate locking of the
94 * FileDescriptor.
95 * @param b the data to be written
96 * @param off the start offset in the data
97 * @param len the number of bytes that are written
98 * @exception IOException If an I/O error has occurred.
99 */
100 private void socketWrite(byte b[], int off, int len) throws IOException {
101
102 if (len <= 0 || off < 0 || off + len > b.length) {
103 if (len == 0) {
104 return;
105 }
106 throw new ArrayIndexOutOfBoundsException();
107 }
108
109 Object traceHandle = IoTrace.socketWriteBegin(impl.address, impl.port);
110 FileDescriptor fd = impl.acquireFD();
111 try {
112 socketWrite0(fd, b, off, len);
113 } catch (SocketException se) {
114 if (se instanceof sun.net.ConnectionResetException) {
115 impl.setConnectionResetPending();
116 se = new SocketException("Connection reset");
117 }
118 if (impl.isClosedOrPending()) {
119 throw new SocketException("Socket closed");
120 } else {
121 throw se;
122 }
123 } finally {
124 impl.releaseFD();
125 IoTrace.socketWriteEnd(traceHandle, len);
126 }
127 }
128
129 /**
130 * Writes a byte to the socket.
131 * @param b the data to be written
132 * @exception IOException If an I/O error has occurred.
133 */
134 public void write(int b) throws IOException {
135 temp[0] = (byte)b;
136 socketWrite(temp, 0, 1);
137 }
138
139 /**
140 * Writes the contents of the buffer <i>b</i> to the socket.
141 * @param b the data to be written
142 * @exception SocketException If an I/O error has occurred.
143 */
144 public void write(byte b[]) throws IOException {
145 socketWrite(b, 0, b.length);
146 }
147
148 /**
149 * Writes <i>length</i> bytes from buffer <i>b</i> starting at
150 * offset <i>len</i>.
151 * @param b the data to be written
152 * @param off the start offset in the data
153 * @param len the number of bytes that are written
154 * @exception SocketException If an I/O error has occurred.
155 */
156 public void write(byte b[], int off, int len) throws IOException {
157 socketWrite(b, off, len);
158 }
159
160 /**
161 * Closes the stream.
162 */
163 private boolean closing = false;
164 public void close() throws IOException {
165 // Prevent recursion. See BugId 4484411
166 if (closing)
167 return;
168 closing = true;
169 if (socket != null) {
170 if (!socket.isClosed())
171 socket.close();
172 } else
173 impl.close();
174 closing = false;
175 }
176
177 /**
178 * Overrides finalize, the fd is closed by the Socket.
179 */
180 protected void finalize() {}
181
182 /**
183 * Perform class load-time initializations.
184 */
185 private native static void init();
186
187 }