1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski package com.sun.star.comp.connections; 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski import com.sun.star.comp.loader.FactoryHelper; 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski import com.sun.star.connection.XConnection; 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski import com.sun.star.lang.XMultiServiceFactory; 32*b1cdbd2cSJim Jagielski import com.sun.star.lang.XSingleServiceFactory; 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski import com.sun.star.registry.XRegistryKey; 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski /** 37*b1cdbd2cSJim Jagielski * The PipedConnection is a component that implements the 38*b1cdbd2cSJim Jagielski * <code>XConnection</code> Interface. 39*b1cdbd2cSJim Jagielski * It is useful for <code>Thread</code> communication 40*b1cdbd2cSJim Jagielski * in one Process. 41*b1cdbd2cSJim Jagielski * <p> 42*b1cdbd2cSJim Jagielski * @version $Revision: 1.3 $ $ $Date: 2008-04-11 11:09:30 $ 43*b1cdbd2cSJim Jagielski * @author Kay Ramme 44*b1cdbd2cSJim Jagielski * @see com.sun.star.connections.XConnection 45*b1cdbd2cSJim Jagielski * @see com.sun.star.loader.JavaLoader 46*b1cdbd2cSJim Jagielski * @since UDK1.0 47*b1cdbd2cSJim Jagielski */ 48*b1cdbd2cSJim Jagielski public class PipedConnection implements XConnection { 49*b1cdbd2cSJim Jagielski /** 50*b1cdbd2cSJim Jagielski * When set to true, enables various debugging output. 51*b1cdbd2cSJim Jagielski */ 52*b1cdbd2cSJim Jagielski public static final boolean DEBUG = false; 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski /** 55*b1cdbd2cSJim Jagielski * The name of the service, the <code>JavaLoader</code> acceses this through reflection. 56*b1cdbd2cSJim Jagielski */ 57*b1cdbd2cSJim Jagielski static private final String __serviceName = "com.sun.star.connection.PipedConnection"; 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski /** 60*b1cdbd2cSJim Jagielski * Gives a factory for creating the service. 61*b1cdbd2cSJim Jagielski * This method is called by the <code>JavaLoader</code> 62*b1cdbd2cSJim Jagielski * <p> 63*b1cdbd2cSJim Jagielski * @return returns a <code>XSingleServiceFactory</code> for creating the component 64*b1cdbd2cSJim Jagielski * @param implName the name of the implementation for which a service is desired 65*b1cdbd2cSJim Jagielski * @param multiFactory the service manager to be uses if needed 66*b1cdbd2cSJim Jagielski * @param regKey the registryKey 67*b1cdbd2cSJim Jagielski * @see com.sun.star.comp.loader.JavaLoader 68*b1cdbd2cSJim Jagielski */ __getServiceFactory(String implName, XMultiServiceFactory multiFactory, XRegistryKey regKey)69*b1cdbd2cSJim Jagielski public static XSingleServiceFactory __getServiceFactory(String implName, 70*b1cdbd2cSJim Jagielski XMultiServiceFactory multiFactory, 71*b1cdbd2cSJim Jagielski XRegistryKey regKey) 72*b1cdbd2cSJim Jagielski { 73*b1cdbd2cSJim Jagielski XSingleServiceFactory xSingleServiceFactory = null; 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski if (implName.equals(PipedConnection.class.getName()) ) 76*b1cdbd2cSJim Jagielski xSingleServiceFactory = FactoryHelper.getServiceFactory(PipedConnection.class, 77*b1cdbd2cSJim Jagielski __serviceName, 78*b1cdbd2cSJim Jagielski multiFactory, 79*b1cdbd2cSJim Jagielski regKey); 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski return xSingleServiceFactory; 82*b1cdbd2cSJim Jagielski } 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski /** 85*b1cdbd2cSJim Jagielski * The amount of time in milliseconds, to wait to 86*b1cdbd2cSJim Jagielski * see check the buffers. 87*b1cdbd2cSJim Jagielski */ 88*b1cdbd2cSJim Jagielski protected static final int __waitTime = 10000; 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski protected byte _buffer[] = new byte[4096]; 91*b1cdbd2cSJim Jagielski protected int _in, 92*b1cdbd2cSJim Jagielski _out; 93*b1cdbd2cSJim Jagielski protected boolean _closed; 94*b1cdbd2cSJim Jagielski protected PipedConnection _otherSide; 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski /** 97*b1cdbd2cSJim Jagielski * Constructs a new <code>PipedConnection</code>, sees if there 98*b1cdbd2cSJim Jagielski * is an other side, which it should be connected to. 99*b1cdbd2cSJim Jagielski * <p> 100*b1cdbd2cSJim Jagielski * @param args Another side could be in index 0. 101*b1cdbd2cSJim Jagielski */ PipedConnection(Object args[])102*b1cdbd2cSJim Jagielski public PipedConnection(Object args[]) throws com.sun.star.uno.RuntimeException { 103*b1cdbd2cSJim Jagielski if (DEBUG) System.err.println("##### " + getClass().getName() + " - instantiated"); 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski _otherSide = (args.length == 1) ? (PipedConnection)args[0] : null; 106*b1cdbd2cSJim Jagielski if(_otherSide != null) { 107*b1cdbd2cSJim Jagielski if(_otherSide == this) 108*b1cdbd2cSJim Jagielski throw new RuntimeException("can not connect to myself"); 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski _otherSide._otherSide = this; 111*b1cdbd2cSJim Jagielski } 112*b1cdbd2cSJim Jagielski } 113*b1cdbd2cSJim Jagielski 114*b1cdbd2cSJim Jagielski /** 115*b1cdbd2cSJim Jagielski * This is a private method, used to cummunicate 116*b1cdbd2cSJim Jagielski * internal in the pipe. 117*b1cdbd2cSJim Jagielski */ receive(byte aData[])118*b1cdbd2cSJim Jagielski private synchronized void receive(byte aData[]) throws com.sun.star.io.IOException { 119*b1cdbd2cSJim Jagielski int bytesWritten = 0; 120*b1cdbd2cSJim Jagielski 121*b1cdbd2cSJim Jagielski if(DEBUG) System.err.println("##### PipedConnection.receive - bytes:" + aData.length + " at:" + _out); 122*b1cdbd2cSJim Jagielski 123*b1cdbd2cSJim Jagielski while(bytesWritten < aData.length) { 124*b1cdbd2cSJim Jagielski // wait until it is not full anymore 125*b1cdbd2cSJim Jagielski while(_out == (_in - 1) || (_in == 0 && _out == _buffer.length - 1)) { 126*b1cdbd2cSJim Jagielski try { 127*b1cdbd2cSJim Jagielski notify(); // the buffer is full, signal it 128*b1cdbd2cSJim Jagielski 129*b1cdbd2cSJim Jagielski wait(__waitTime); 130*b1cdbd2cSJim Jagielski } 131*b1cdbd2cSJim Jagielski catch(InterruptedException interruptedException) { 132*b1cdbd2cSJim Jagielski throw new com.sun.star.io.IOException(interruptedException.toString()); 133*b1cdbd2cSJim Jagielski } 134*b1cdbd2cSJim Jagielski } 135*b1cdbd2cSJim Jagielski 136*b1cdbd2cSJim Jagielski if(_closed) throw new com.sun.star.io.IOException("connection has been closed"); 137*b1cdbd2cSJim Jagielski 138*b1cdbd2cSJim Jagielski int bytes ; 139*b1cdbd2cSJim Jagielski 140*b1cdbd2cSJim Jagielski if(_out < _in) { 141*b1cdbd2cSJim Jagielski bytes = Math.min(aData.length - bytesWritten, _in - _out - 1); 142*b1cdbd2cSJim Jagielski 143*b1cdbd2cSJim Jagielski System.arraycopy(aData, bytesWritten, _buffer, _out, bytes); 144*b1cdbd2cSJim Jagielski } 145*b1cdbd2cSJim Jagielski else { 146*b1cdbd2cSJim Jagielski if(_in > 0){ 147*b1cdbd2cSJim Jagielski bytes = Math.min(aData.length - bytesWritten, _buffer.length - _out); 148*b1cdbd2cSJim Jagielski } 149*b1cdbd2cSJim Jagielski else { 150*b1cdbd2cSJim Jagielski bytes = Math.min(aData.length - bytesWritten, _buffer.length - _out - 1); 151*b1cdbd2cSJim Jagielski } 152*b1cdbd2cSJim Jagielski 153*b1cdbd2cSJim Jagielski System.arraycopy(aData, bytesWritten, _buffer, _out, bytes); 154*b1cdbd2cSJim Jagielski } 155*b1cdbd2cSJim Jagielski 156*b1cdbd2cSJim Jagielski bytesWritten += bytes; 157*b1cdbd2cSJim Jagielski _out += bytes; 158*b1cdbd2cSJim Jagielski if(_out >= _buffer.length) 159*b1cdbd2cSJim Jagielski _out = 0; 160*b1cdbd2cSJim Jagielski } 161*b1cdbd2cSJim Jagielski } 162*b1cdbd2cSJim Jagielski 163*b1cdbd2cSJim Jagielski /** 164*b1cdbd2cSJim Jagielski * Read the required number of bytes. 165*b1cdbd2cSJim Jagielski * <p> 166*b1cdbd2cSJim Jagielski * @return the number of bytes read 167*b1cdbd2cSJim Jagielski * @param aReadBytes the outparameter, where the bytes have to be placed 168*b1cdbd2cSJim Jagielski * @param nBytesToRead the number of bytes to read 169*b1cdbd2cSJim Jagielski * @see com.sun.star.connections.XConnection#read 170*b1cdbd2cSJim Jagielski */ read( byte[][] aReadBytes, int nBytesToRead)171*b1cdbd2cSJim Jagielski public synchronized int read(/*OUT*/byte[][] aReadBytes, int nBytesToRead) throws com.sun.star.io.IOException, com.sun.star.uno.RuntimeException { 172*b1cdbd2cSJim Jagielski aReadBytes[0] = new byte[nBytesToRead]; 173*b1cdbd2cSJim Jagielski 174*b1cdbd2cSJim Jagielski if(DEBUG) System.err.println("##### PipedConnection.read - bytes:" + nBytesToRead + " at:" + _in); 175*b1cdbd2cSJim Jagielski 176*b1cdbd2cSJim Jagielski // loop while not all bytes read or when closed but there is still data 177*b1cdbd2cSJim Jagielski while(nBytesToRead > 0 && (_in != _out || !_closed)) { 178*b1cdbd2cSJim Jagielski while(_in == _out && !_closed) { 179*b1cdbd2cSJim Jagielski try { 180*b1cdbd2cSJim Jagielski notify(); // the buffer is empty, signal it 181*b1cdbd2cSJim Jagielski 182*b1cdbd2cSJim Jagielski wait(__waitTime); // we wait for data or for the pipe to be closed 183*b1cdbd2cSJim Jagielski } 184*b1cdbd2cSJim Jagielski catch(InterruptedException interruptedException) { 185*b1cdbd2cSJim Jagielski throw new com.sun.star.io.IOException(interruptedException.toString()); 186*b1cdbd2cSJim Jagielski } 187*b1cdbd2cSJim Jagielski } 188*b1cdbd2cSJim Jagielski 189*b1cdbd2cSJim Jagielski if(_in < _out) { 190*b1cdbd2cSJim Jagielski int bytes = Math.min(nBytesToRead, _out - _in); 191*b1cdbd2cSJim Jagielski 192*b1cdbd2cSJim Jagielski System.arraycopy(_buffer, _in, aReadBytes[0], aReadBytes[0].length - nBytesToRead, bytes); 193*b1cdbd2cSJim Jagielski 194*b1cdbd2cSJim Jagielski nBytesToRead -= bytes; 195*b1cdbd2cSJim Jagielski _in += bytes; 196*b1cdbd2cSJim Jagielski } 197*b1cdbd2cSJim Jagielski else if(_in > _out) { 198*b1cdbd2cSJim Jagielski int bytes = Math.min(nBytesToRead, _buffer.length - _in); 199*b1cdbd2cSJim Jagielski 200*b1cdbd2cSJim Jagielski System.arraycopy(_buffer, _in, aReadBytes[0], aReadBytes[0].length - nBytesToRead, bytes); 201*b1cdbd2cSJim Jagielski 202*b1cdbd2cSJim Jagielski nBytesToRead -= bytes; 203*b1cdbd2cSJim Jagielski _in += bytes; 204*b1cdbd2cSJim Jagielski if(_in >= _buffer.length) 205*b1cdbd2cSJim Jagielski _in = 0; 206*b1cdbd2cSJim Jagielski } 207*b1cdbd2cSJim Jagielski } 208*b1cdbd2cSJim Jagielski 209*b1cdbd2cSJim Jagielski if(nBytesToRead > 0) { // not all bytes read 210*b1cdbd2cSJim Jagielski byte tmp[] = new byte[aReadBytes[0].length - nBytesToRead]; 211*b1cdbd2cSJim Jagielski System.arraycopy(aReadBytes[0], 0, tmp, 0, tmp.length); 212*b1cdbd2cSJim Jagielski 213*b1cdbd2cSJim Jagielski aReadBytes[0] = tmp; 214*b1cdbd2cSJim Jagielski } 215*b1cdbd2cSJim Jagielski 216*b1cdbd2cSJim Jagielski return aReadBytes[0].length; 217*b1cdbd2cSJim Jagielski } 218*b1cdbd2cSJim Jagielski 219*b1cdbd2cSJim Jagielski /** 220*b1cdbd2cSJim Jagielski * Write bytes. 221*b1cdbd2cSJim Jagielski * <p> 222*b1cdbd2cSJim Jagielski * @param aData the bytes to write 223*b1cdbd2cSJim Jagielski * @see com.sun.star.connections.XConnection#write 224*b1cdbd2cSJim Jagielski */ write(byte aData[])225*b1cdbd2cSJim Jagielski public void write(byte aData[]) throws com.sun.star.io.IOException, com.sun.star.uno.RuntimeException { 226*b1cdbd2cSJim Jagielski _otherSide.receive(aData); 227*b1cdbd2cSJim Jagielski } 228*b1cdbd2cSJim Jagielski 229*b1cdbd2cSJim Jagielski /** 230*b1cdbd2cSJim Jagielski * Flushes the buffer, notifies if necessary the other side that new data has arrived. 231*b1cdbd2cSJim Jagielski * <p> 232*b1cdbd2cSJim Jagielski * @see com.sun.star.connections.XConnection#flush 233*b1cdbd2cSJim Jagielski */ flush()234*b1cdbd2cSJim Jagielski public void flush() throws com.sun.star.io.IOException, com.sun.star.uno.RuntimeException { 235*b1cdbd2cSJim Jagielski synchronized(_otherSide) { 236*b1cdbd2cSJim Jagielski _otherSide.notify(); 237*b1cdbd2cSJim Jagielski } 238*b1cdbd2cSJim Jagielski } 239*b1cdbd2cSJim Jagielski 240*b1cdbd2cSJim Jagielski /** 241*b1cdbd2cSJim Jagielski * Closes the pipe. 242*b1cdbd2cSJim Jagielski * <p> 243*b1cdbd2cSJim Jagielski * @see com.sun.star.connections.XConnection#closed 244*b1cdbd2cSJim Jagielski */ close()245*b1cdbd2cSJim Jagielski public synchronized void close() throws com.sun.star.io.IOException, com.sun.star.uno.RuntimeException { 246*b1cdbd2cSJim Jagielski if(!_closed) { 247*b1cdbd2cSJim Jagielski _closed = true; 248*b1cdbd2cSJim Jagielski 249*b1cdbd2cSJim Jagielski _otherSide.close(); 250*b1cdbd2cSJim Jagielski 251*b1cdbd2cSJim Jagielski notify(); 252*b1cdbd2cSJim Jagielski } 253*b1cdbd2cSJim Jagielski } 254*b1cdbd2cSJim Jagielski 255*b1cdbd2cSJim Jagielski /** 256*b1cdbd2cSJim Jagielski * Gives a description of this pipe. 257*b1cdbd2cSJim Jagielski * <p> 258*b1cdbd2cSJim Jagielski * @return the description 259*b1cdbd2cSJim Jagielski * @see com.sun.star.connections.XConnection#getDescription 260*b1cdbd2cSJim Jagielski */ getDescription()261*b1cdbd2cSJim Jagielski public String getDescription() throws com.sun.star.uno.RuntimeException { 262*b1cdbd2cSJim Jagielski return getClass().getName(); 263*b1cdbd2cSJim Jagielski } 264*b1cdbd2cSJim Jagielski 265*b1cdbd2cSJim Jagielski } 266*b1cdbd2cSJim Jagielski 267