Module com.ensarsarajcic.neovim.java.unixsocketconnection

Package com.ensarsarajcic.neovim.java.unix.socket

Class UnixDomainSocketRpcConnection

java.lang.Object

com.ensarsarajcic.neovim.java.unix.socket.UnixDomainSocketRpcConnection

All Implemented Interfaces:

RpcConnection, Closeable, AutoCloseable

public final class UnixDomainSocketRpcConnection
extends Object
implements RpcConnection

Simple implementation of RpcConnection based on a unix domain socket

This allows connection and communication via unix domain socket/windows named pipe It is a very simple implementation and it just passes down calls to underlying UnixDomainSocket

Example:

     
     File socket = new File("/var/nvim/random");

     RpcConnection fileConnection = new UnixDomainSocketRpcConnection(socket);

     // It can now be used for communication
     rpcStreamer.attach(fileConnection);
     rpcStreamer.sent(message); // send a message to unix domain socket located on /var/nvim/random
     
 

Constructor Summary

Constructors

Constructor	Description
UnixDomainSocketRpcConnection(File path)	Creates a new UnixDomainSocketRpcConnection connected to the file on given path It uses input/output stream provided by UnixDomainSocket created for given file

Method Summary

Modifier and Type	Method	Description
void	close()	Closes underlying UnixDomainSocket Communication is no longer possible after this call
InputStream	getIncomingStream()	Gets the InputStream of the underlying UnixDomainSocket
OutputStream	getOutgoingStream()	Gets the OutputStream of the underlying UnixDomainSocket
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

UnixDomainSocketRpcConnection

public UnixDomainSocketRpcConnection(File path)

Creates a new UnixDomainSocketRpcConnection connected to the file on given path It uses input/output stream provided by UnixDomainSocket created for given file

Parameters:

path - file to use as unix domain socket

Throws:

NullPointerException - if path is null

RuntimeException - if socket can't be open for given path

Method Details

getIncomingStream

public InputStream getIncomingStream()

Gets the InputStream of the underlying UnixDomainSocket

Specified by:

getIncomingStream in interface RpcConnection

Returns:

InputStream of the underlying UnixDomainSocket

getOutgoingStream

public OutputStream getOutgoingStream()

Gets the OutputStream of the underlying UnixDomainSocket

Specified by:

getOutgoingStream in interface RpcConnection

Returns:

OutputStream of the underlying UnixDomainSocket

close

public void close()
           throws IOException

Closes underlying UnixDomainSocket Communication is no longer possible after this call

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if underlying UnixDomainSocket throws exception

toString

public String toString()

Overrides:

toString in class Object