151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/* 246805d66f32e857c885434b4fa8cb6b32dcc4bf7Shubham Ajmera * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved. 351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is free software; you can redistribute it and/or modify it 651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * under the terms of the GNU General Public License version 2 only, as 751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * published by the Free Software Foundation. Oracle designates this 851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * particular file as subject to the "Classpath" exception as provided 951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * by Oracle in the LICENSE file that accompanied this code. 1051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is distributed in the hope that it will be useful, but WITHOUT 1251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * version 2 for more details (a copy is included in the LICENSE file that 1551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * accompanied this code). 1651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * You should have received a copy of the GNU General Public License version 1851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2 along with this work; if not, write to the Free Software Foundation, 1951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or visit www.oracle.com if you need additional information or have any 2351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * questions. 2451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 2551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipackage java.nio.channels; 2751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.io.IOException; 2951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.nio.channels.spi.*; 3051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 3151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 3251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/** 3351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * A pair of channels that implements a unidirectional pipe. 3451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 3551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> A pipe consists of a pair of channels: A writable {@link 3646805d66f32e857c885434b4fa8cb6b32dcc4bf7Shubham Ajmera * Pipe.SinkChannel sink} channel and a readable {@link Pipe.SourceChannel source} 3746805d66f32e857c885434b4fa8cb6b32dcc4bf7Shubham Ajmera * channel. Once some bytes are written to the sink channel they can be read 3846805d66f32e857c885434b4fa8cb6b32dcc4bf7Shubham Ajmera * from source channel in exactlyAthe order in which they were written. 3951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 4051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Whether or not a thread writing bytes to a pipe will block until another 4151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * thread reads those bytes, or some previously-written bytes, from the pipe is 4251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * system-dependent and therefore unspecified. Many pipe implementations will 4351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * buffer up to a certain number of bytes between the sink and source channels, 4451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * but such buffering should not be assumed. </p> 4551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 4651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 4751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @author Mark Reinhold 4851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @author JSR-51 Expert Group 4951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.4 5051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 5151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 5251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipublic abstract class Pipe { 5351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 5451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 5546805d66f32e857c885434b4fa8cb6b32dcc4bf7Shubham Ajmera * A channel representing the readable end of a {@link Pipe}. 5651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 5751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.4 5851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 5951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static abstract class SourceChannel 6051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski extends AbstractSelectableChannel 6151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski implements ReadableByteChannel, ScatteringByteChannel 6251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski { 6351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 6451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Constructs a new instance of this class. 6546805d66f32e857c885434b4fa8cb6b32dcc4bf7Shubham Ajmera * 6646805d66f32e857c885434b4fa8cb6b32dcc4bf7Shubham Ajmera * @param provider 6746805d66f32e857c885434b4fa8cb6b32dcc4bf7Shubham Ajmera * The selector provider 6851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 6951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected SourceChannel(SelectorProvider provider) { 7051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski super(provider); 7151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 7251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 7351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 7451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns an operation set identifying this channel's supported 7551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * operations. 7651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 7751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Pipe-source channels only support reading, so this method 7851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * returns {@link SelectionKey#OP_READ}. </p> 7951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 8051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return The valid-operation set 8151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 8251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final int validOps() { 8351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return SelectionKey.OP_READ; 8451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 8551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 8651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 8751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 8851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 8946805d66f32e857c885434b4fa8cb6b32dcc4bf7Shubham Ajmera * A channel representing the writable end of a {@link Pipe}. 9051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 9151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.4 9251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 9351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static abstract class SinkChannel 9451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski extends AbstractSelectableChannel 9551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski implements WritableByteChannel, GatheringByteChannel 9651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski { 9751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 9851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Initializes a new instance of this class. 9946805d66f32e857c885434b4fa8cb6b32dcc4bf7Shubham Ajmera * 10046805d66f32e857c885434b4fa8cb6b32dcc4bf7Shubham Ajmera * @param provider 10146805d66f32e857c885434b4fa8cb6b32dcc4bf7Shubham Ajmera * The selector provider 10251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 10351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected SinkChannel(SelectorProvider provider) { 10451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski super(provider); 10551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 10651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 10751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 10851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns an operation set identifying this channel's supported 10951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * operations. 11051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 11151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Pipe-sink channels only support writing, so this method returns 11251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link SelectionKey#OP_WRITE}. </p> 11351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 11451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return The valid-operation set 11551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 11651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final int validOps() { 11751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return SelectionKey.OP_WRITE; 11851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 11951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 12051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 12151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 12251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 12351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Initializes a new instance of this class. 12451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 12551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected Pipe() { } 12651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 12751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 12846805d66f32e857c885434b4fa8cb6b32dcc4bf7Shubham Ajmera * Returns this pipe's source channel. 12951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 13051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return This pipe's source channel 13151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 13251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public abstract SourceChannel source(); 13351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 13451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 13546805d66f32e857c885434b4fa8cb6b32dcc4bf7Shubham Ajmera * Returns this pipe's sink channel. 13651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 13751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return This pipe's sink channel 13851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 13951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public abstract SinkChannel sink(); 14051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 14151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 14251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Opens a pipe. 14351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 14451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The new pipe is created by invoking the {@link 14551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * java.nio.channels.spi.SelectorProvider#openPipe openPipe} method of the 14651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * system-wide default {@link java.nio.channels.spi.SelectorProvider} 14751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * object. </p> 14851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 14951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return A new pipe 15051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 15151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IOException 15251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If an I/O error occurs 15351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 15451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static Pipe open() throws IOException { 15551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return SelectorProvider.provider().openPipe(); 15651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 15751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 15851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski} 159