Package com.sun.star.lib.connections.pipe

Class pipeAcceptor

  • All Implemented Interfaces:
    com.sun.star.connection.XAcceptor, com.sun.star.uno.XInterface
    public final class pipeAcceptor
extends java.lang.Object
implements com.sun.star.connection.XAcceptor
    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.

    Since:
    UDK 1.0
    See Also:
    XAcceptor, XConnection, XConnector, JavaLoader

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String __serviceName
      The name of the service.

      • Fields inherited from interface com.sun.star.connection.XAcceptor

        UNOTYPEINFO

    • Constructor Summary

      Constructors 
      Constructor Description
      pipeAcceptor()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static com.sun.star.lang.XSingleServiceFactory __getServiceFactory​(java.lang.String implName, com.sun.star.lang.XMultiServiceFactory multiFactory, com.sun.star.registry.XRegistryKey regKey)
      Returns a factory for creating the service.
      com.sun.star.connection.XConnection accept​(java.lang.String connectionDescription)
      Accepts a connection request via the described pipe.
      void stopAccepting()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • __serviceName

        public static final java.lang.String __serviceName
        The name of the service.

        The JavaLoader accesses this through reflection.

        See Also:
        JavaLoader, Constant Field Values

    • Constructor Detail

      • pipeAcceptor

        public pipeAcceptor()

    • Method Detail

      • __getServiceFactory

        public static com.sun.star.lang.XSingleServiceFactory __getServiceFactory​(java.lang.String implName,
                                                                          com.sun.star.lang.XMultiServiceFactory multiFactory,
                                                                          com.sun.star.registry.XRegistryKey regKey)
        Returns a factory for creating the service.

        This method is called by the JavaLoader.

        Parameters:
        implName - the name of the implementation for which a service is requested.
        multiFactory - the service manager to be used (if needed).
        regKey - the registry key.
        Returns:
        an XSingleServiceFactory for creating the component.
        See Also:
        JavaLoader

      • accept

        public com.sun.star.connection.XConnection accept​(java.lang.String connectionDescription)
                                           throws com.sun.star.connection.AlreadyAcceptingException,
                                                  com.sun.star.connection.ConnectionSetupException,
                                                  com.sun.star.lang.IllegalArgumentException
        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.
        Specified by:
        accept in interface com.sun.star.connection.XAcceptor
        Parameters:
        connectionDescription - the description of the connection.
        Returns:
        an XConnection to the client.
        Throws:
        com.sun.star.connection.AlreadyAcceptingException
        com.sun.star.connection.ConnectionSetupException
        com.sun.star.lang.IllegalArgumentException
        See Also:
        XConnection, XConnector

      • stopAccepting

        public void stopAccepting()
        Specified by:
        stopAccepting in interface com.sun.star.connection.XAcceptor
        See Also:
        XAcceptor.stopAccepting()