com.sun.star.lib.connections.socket

Class socketAcceptor

java.lang.Object

com.sun.star.lib.connections.socket.socketAcceptor

public final class socketAcceptor
extends java.lang.Object

A component that implements the XAcceptor interface.

The socketAcceptor is a specialized component that uses TCP sockets for communication. The socketAcceptor is generally used by the com.sun.star.connection.Acceptor service.

Since:

UDK 1.0

See Also:

com.sun.star.connections.XAcceptor, com.sun.star.connections.XConnection, com.sun.star.connections.XConnector, com.sun.star.loader.JavaLoader

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
socketAcceptor()

Method Summary

Modifier and Type	Method and Description
static XSingleServiceFactory	__getServiceFactory(java.lang.String implName, XMultiServiceFactory multiFactory, XRegistryKey regKey) Returns a factory for creating the service.
XConnection	accept(java.lang.String connectionDescription) Accepts a connection request via the described socket.
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 acceses this through reflection.

See Also:

JavaLoader, Constant Field Values

Constructor Detail

socketAcceptor

public socketAcceptor()

Method Detail

__getServiceFactory

public static XSingleServiceFactory __getServiceFactory(java.lang.String implName,
                                                        XMultiServiceFactory multiFactory,
                                                        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 XConnection accept(java.lang.String connectionDescription)
                   throws AlreadyAcceptingException,
                          ConnectionSetupException,
                          com.sun.star.lang.IllegalArgumentException

Accepts a connection request via the described socket.

This call blocks until a connection has been established.

The connection description has the following format: type*(key=value), where type should be socket (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.

Parameters:

connectionDescription - the description of the connection.

Returns:

an XConnection to the client.

Throws:

AlreadyAcceptingException

ConnectionSetupException

com.sun.star.lang.IllegalArgumentException

See Also:

com.sun.star.connections.XConnection, com.sun.star.connections.XConnector

stopAccepting

public void stopAccepting()