com.sun.star.lib.connections.pipe.pipeAcceptor Maven / Gradle / Ivy

Go to download
/* -*- Mode: Java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

package com.sun.star.lib.connections.pipe;

import com.sun.star.comp.loader.FactoryHelper;
import com.sun.star.connection.AlreadyAcceptingException;
import com.sun.star.connection.ConnectionSetupException;
import com.sun.star.connection.XAcceptor;
import com.sun.star.connection.XConnection;
import com.sun.star.lang.XMultiServiceFactory;
import com.sun.star.lang.XSingleServiceFactory;
import com.sun.star.registry.XRegistryKey;

/**
 * A component that implements the XAcceptor interface.
 *
 * The pipeAcceptor is a specialized component that uses TCP
 * pipes for communication.  The pipeAcceptor is generally used
 * by the com.sun.star.connection.Acceptor service.
 *
 * @see com.sun.star.connection.XAcceptor
 * @see com.sun.star.connection.XConnection
 * @see com.sun.star.connection.XConnector
 * @see com.sun.star.comp.loader.JavaLoader
 *
 * @since UDK 1.0
 */
public final class pipeAcceptor implements XAcceptor {
    /**
     * The name of the service.
     *
     * The JavaLoader accesses this through reflection.
     *
     * @see com.sun.star.comp.loader.JavaLoader
     */
    public static final String __serviceName
    = "com.sun.star.connection.pipeAcceptor";

    /**
     * Returns a factory for creating the service.
     *
     * This method is called by the JavaLoader.
     *
     * @param implName the name of the implementation for which a service is
     *     requested.
     * @param multiFactory the service manager to be used (if needed).
     * @param regKey the registry key.
     * @return an XSingleServiceFactory for creating the component.
     *
     * @see com.sun.star.comp.loader.JavaLoader
     */
    public static XSingleServiceFactory __getServiceFactory(
        String implName, XMultiServiceFactory multiFactory, XRegistryKey regKey)
    {
        return implName.equals(pipeAcceptor.class.getName())
            ? FactoryHelper.getServiceFactory(
        pipeAcceptor.class, __serviceName, multiFactory, regKey)
            : null;
    }

    /**
     * Accepts a connection request via the described pipe.
     *
     * This call blocks until a connection has been established.
     *
     * The connection description has the following format:
     * type*(key=value),
     * where type should be pipe
     * (ignoring case).  Supported keys (ignoring case) currently are
     * 
     * host
     * 
The name or address of the accepting interface (defaults to
     *     0, meaning any interface).
     * 
port
     * 
The TCP port number to accept on (defaults to 6001).
     * 
backlog
     * 
The maximum length of the acceptor's queue (defaults to
     *     50).
     * 
tcpnodelay
     * 
A flag (0/1) enabling or disabling Nagle's
     *     algorithm on the resulting connection.
     * 
     *
     * @param connectionDescription the description of the connection.
     * @return an XConnection to the client.
     *
     * @see com.sun.star.connection.XConnection
     * @see com.sun.star.connection.XConnector
     */
    public XConnection accept(String connectionDescription) throws
        AlreadyAcceptingException, ConnectionSetupException,
        com.sun.star.lang.IllegalArgumentException
    {
        throw new java.lang.NoSuchMethodError( "pipeAcceptor not fully implemented yet" );
    }

    /**
     *
     * @see com.sun.star.connection.XAcceptor#stopAccepting
     */
    public void stopAccepting() {
    }
}

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */