cx.ath.matthew.unix

Class UnixSocket

java.lang.Object

java.net.Socket

cx.ath.matthew.unix.UnixSocket

All Implemented Interfaces:

Closeable, AutoCloseable

public class UnixSocket
extends Socket
implements Closeable

Represents a UnixSocket.

Constructor Summary

Constructors

Constructor and Description
UnixSocket() Create an unconnected socket.
UnixSocket(String _address) Create a socket connected to the given address.
UnixSocket(UnixSocketAddress _address) Create a socket connected to the given address.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection.
void	connect(String _address) Connect the socket to this address.
void	connect(UnixSocketAddress _address) Connect the socket to this address.
UnixSocketAddress	getAddress() Returns the address this socket is connected to.
boolean	getBlocking() Get the blocking mode.
InputStream	getInputStream() Returns an InputStream for reading from the socket.
OutputStream	getOutputStream() Returns an OutputStream for writing to the socket.
boolean	getPassCred() Get the credential passing status.
int	getPeerGID() Return the gid of the remote process.
int	getPeerPID() Return the pid of the remote process.
int	getPeerUID() Return the uid of the remote process.
boolean	isClosed() Check the socket status.
boolean	isConnected() Check the socket status.
boolean	isInputShutdown() Check the socket status.
boolean	isOutputShutdown() Check the socket status.
byte	recvCredentialByte() Receive a single byte of data, with credentials.
void	sendCredentialByte(byte data) Send a single byte of data with credentials.
void	setBlocking(boolean enable) Set the blocking mode.
void	setPassCred(boolean enable) Set the credential passing status.
void	setSoTimeout(int timeout) Set timeout of read requests.
void	shutdownInput() Shuts down the input stream.
void	shutdownOutput() Shuts down the output stream.

Methods inherited from class java.net.Socket

bind, connect, connect, getChannel, getInetAddress, getKeepAlive, getLocalAddress, getLocalPort, getLocalSocketAddress, getOOBInline, getPort, getReceiveBufferSize, getRemoteSocketAddress, getReuseAddress, getSendBufferSize, getSoLinger, getSoTimeout, getTcpNoDelay, getTrafficClass, isBound, sendUrgentData, setKeepAlive, setOOBInline, setPerformancePreferences, setReceiveBufferSize, setReuseAddress, setSendBufferSize, setSocketImplFactory, setSoLinger, setTcpNoDelay, setTrafficClass, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

UnixSocket

public UnixSocket()

Create an unconnected socket.

UnixSocket

public UnixSocket(UnixSocketAddress _address)
           throws IOException

Create a socket connected to the given address.

Parameters:

_address - The Unix Socket address to connect to

Throws:

IOException - on error

UnixSocket

public UnixSocket(String _address)
           throws IOException

Create a socket connected to the given address.

Parameters:

_address - The Unix Socket address to connect to

Throws:

IOException - on error

Method Detail

connect

public void connect(UnixSocketAddress _address)
             throws IOException

Connect the socket to this address.

Parameters:

_address - The Unix Socket address to connect to

Throws:

IOException - on error

connect

public void connect(String _address)
             throws IOException

Connect the socket to this address.

Parameters:

_address - The Unix Socket address to connect to

Throws:

IOException - on error

close

public void close()
           throws IOException

Closes the connection.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class Socket

Throws:

IOException - on error

getInputStream

public InputStream getInputStream()

Returns an InputStream for reading from the socket.

Overrides:

getInputStream in class Socket

Returns:

An InputStream connected to this socket.

getOutputStream

public OutputStream getOutputStream()

Returns an OutputStream for writing to the socket.

Overrides:

getOutputStream in class Socket

Returns:

An OutputStream connected to this socket.

getAddress

public UnixSocketAddress getAddress()

Returns the address this socket is connected to. Returns null if the socket is unconnected.

Returns:

The UnixSocketAddress the socket is connected to

sendCredentialByte

public void sendCredentialByte(byte data)
                        throws IOException

Send a single byte of data with credentials. (Works on BSDs)

Parameters:

data - The byte of data to send.

Throws:

IOException - on error

recvCredentialByte

public byte recvCredentialByte()
                        throws IOException

Receive a single byte of data, with credentials. (Works on BSDs)

Returns:

read byte

Throws:

IOException - on error

See Also:

getPeerUID, getPeerPID, getPeerGID

getPassCred

public boolean getPassCred()

Get the credential passing status. (only effective on linux)

Returns:

The current status of credential passing.

See Also:

setPassCred

getPeerUID

public int getPeerUID()

Return the uid of the remote process. Some data must have been received on the socket to do this. Either setPassCred must be called on Linux first, or recvCredentialByte on BSD.

Returns:

the UID or -1 if it is not available

getPeerGID

public int getPeerGID()

Return the gid of the remote process. Some data must have been received on the socket to do this. Either setPassCred must be called on Linux first, or recvCredentialByte on BSD.

Returns:

the GID or -1 if it is not available

getPeerPID

public int getPeerPID()

Return the pid of the remote process. Some data must have been received on the socket to do this. Either setPassCred must be called on Linux first, or recvCredentialByte on BSD.

Returns:

the PID or -1 if it is not available

setPassCred

public void setPassCred(boolean enable)
                 throws IOException

Set the credential passing status. (Only does anything on linux, for other OS, you need to use send/recv credentials)

Parameters:

enable - Set to true for credentials to be passed.

Throws:

IOException - on error

getBlocking

public boolean getBlocking()

Get the blocking mode.

Returns:

true if reads are blocking.

See Also:

setBlocking

setBlocking

public void setBlocking(boolean enable)

Set the blocking mode.

Parameters:

enable - Set to false for non-blocking reads.

isClosed

public boolean isClosed()

Check the socket status.

Overrides:

isClosed in class Socket

Returns:

true if closed.

isConnected

public boolean isConnected()

Check the socket status.

Overrides:

isConnected in class Socket

Returns:

true if connected.

isInputShutdown

public boolean isInputShutdown()

Check the socket status.

Overrides:

isInputShutdown in class Socket

Returns:

true if the input stream has been shutdown

isOutputShutdown

public boolean isOutputShutdown()

Check the socket status.

Overrides:

isOutputShutdown in class Socket

Returns:

true if the output stream has been shutdown

shutdownInput

public void shutdownInput()

Shuts down the input stream. Subsequent reads on the associated InputStream will fail.

Overrides:

shutdownInput in class Socket

shutdownOutput

public void shutdownOutput()

Shuts down the output stream. Subsequent writes to the associated OutputStream will fail.

Overrides:

shutdownOutput in class Socket

setSoTimeout

public void setSoTimeout(int timeout)

Set timeout of read requests.

Overrides:

setSoTimeout in class Socket

Parameters:

timeout - to set