Package org.rnorth.tcpunixsocketproxy

Class TcpToUnixSocketProxy

java.lang.Object

org.rnorth.tcpunixsocketproxy.TcpToUnixSocketProxy

public class TcpToUnixSocketProxy
extends Object

Listens on a TCP port and proxies connections to a UNIX domain socket.

Like socat TCP-LISTEN:2375,fork UNIX-CONNECT:/var/tmp/docker.sock, except this is literally the only thing this program does.

Purposefully simplistic in implementation, using blocking I/O for simplicity over performance.

Author:

Richard North <rich.north@gmail.com>

Constructor Summary

Constructors

Constructor	Description
TcpToUnixSocketProxy(File unixSocketFile)	Create an instance of the proxy that will listen for TCP connections on localhost on a random available port.
TcpToUnixSocketProxy(String listenHostname, int listenPort, File unixSocketFile)	Create an instance of the proxy.

Method Summary

Modifier and Type	Method	Description
InetSocketAddress	start()	Start the proxy
void	stop()	Stop the proxy.

Methods inherited from class java.lang.Object

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

Constructor Detail

TcpToUnixSocketProxy

public TcpToUnixSocketProxy(File unixSocketFile)

Create an instance of the proxy that will listen for TCP connections on localhost on a random available port.

This should be the usual method of instantiating a proxy.

Parameters:

unixSocketFile - the local unix domain socket as a File

TcpToUnixSocketProxy

public TcpToUnixSocketProxy(String listenHostname,
                            int listenPort,
                            File unixSocketFile)

Create an instance of the proxy.

Parameters:

listenHostname - hostname to listen on

listenPort - port to listen on, or 0 if an available port should be allocated

unixSocketFile - the local unix domain socket as a File

Method Detail

start

public InetSocketAddress start()
                        throws IOException

Start the proxy

Returns:

the proxy's listening socket address

Throws:

IOException - on socket binding failure

stop

public void stop()

Stop the proxy.