cx.ath.matthew.unix.UnixSocket クラス

cx.ath.matthew.unix.UnixSocket 連携図

公開メンバ関数
	UnixSocket ()
	UnixSocket (UnixSocketAddress address) throws IOException
	UnixSocket (String address) throws IOException
void	connect (UnixSocketAddress address) throws IOException
void	connect (String address) throws IOException
void	finalize ()
synchronized void	close () throws IOException
InputStream	getInputStream ()
OutputStream	getOutputStream ()
UnixSocketAddress	getAddress ()
void	sendCredentialByte (byte data) throws IOException
byte	recvCredentialByte () throws IOException
boolean	getPassCred ()
int	getPeerUID ()
int	getPeerGID ()
int	getPeerPID ()
void	setPassCred (boolean enable) throws IOException
boolean	getBlocking ()
void	setBlocking (boolean enable)
boolean	isClosed ()
boolean	isConnected ()
boolean	isInputShutdown ()
boolean	isOutputShutdown ()
void	shutdownInput ()
void	shutdownOutput ()
void	setSoTimeout (int timeout)

関数
	UnixSocket (int sock, UnixSocketAddress address)

非公開メンバ関数
native void	native_set_pass_cred (int sock, boolean passcred) throws IOException
native int	native_connect (String address, boolean abs) throws IOException
native void	native_close (int sock) throws IOException
native int	native_getPID (int sock)
native int	native_getUID (int sock)
native int	native_getGID (int sock)
native void	native_send_creds (int sock, byte data) throws IOException
native byte	native_recv_creds (int sock, int[] creds) throws IOException

非公開変数類
UnixSocketAddress	address = null
USOutputStream	os = null
USInputStream	is = null
boolean	closed = false
boolean	connected = false
boolean	passcred = false
int	sock = 0
boolean	blocking = true
int	uid = -1
int	pid = -1
int	gid = -1

詳解

Represents a UnixSocket.

構築子と解体子

UnixSocket() [1/4]

cx.ath.matthew.unix.UnixSocket.UnixSocket ( int  sock, UnixSocketAddress  address  )

inlinepackage

                                                    {
        this.sock = sock;
        this.address = address;
        this.connected = true;
        this.os = new USOutputStream(sock, this);
        this.is = new USInputStream(sock, this);
    }

UnixSocket() [2/4]

cx.ath.matthew.unix.UnixSocket.UnixSocket ( )

inline

Create an unconnected socket.

                        {
    }

UnixSocket() [3/4]

cx.ath.matthew.unix.UnixSocket.UnixSocket ( UnixSocketAddress  address ) throws IOException

inline

Create a socket connected to the given address.

引数

address

The Unix Socket address to connect to

                                                                    {
        connect(address);
    }

UnixSocket() [4/4]

cx.ath.matthew.unix.UnixSocket.UnixSocket ( String  address ) throws IOException

inline

Create a socket connected to the given address.

引数

address

The Unix Socket address to connect to

                                                         {
        this(new UnixSocketAddress(address));
    }

関数詳解

close()

synchronized void cx.ath.matthew.unix.UnixSocket.close ( ) throws IOException

inline

Closes the connection.

                                                        {
        if (Debug.debug) Debug.print(Debug.INFO, "Closing socket");
        native_close(sock);
        sock = 0;
        this.closed = true;
        this.connected = false;
        os = null;
        is = null;
    }

connect() [1/2]

void cx.ath.matthew.unix.UnixSocket.connect ( UnixSocketAddress  address ) throws IOException

inline

Connect the socket to this address.

引数

address

The Unix Socket address to connect to

                                                                      {
        if (connected) close();
        this.sock = native_connect(address.path, address.abs);
        this.os = new USOutputStream(this.sock, this);
        this.is = new USInputStream(this.sock, this);
        this.address = address;
        this.connected = true;
        this.closed = false;
        this.is.setBlocking(blocking);
    }

connect() [2/2]

void cx.ath.matthew.unix.UnixSocket.connect ( String  address ) throws IOException

inline

Connect the socket to this address.

引数

address

The Unix Socket address to connect to

                                                           {
        connect(new UnixSocketAddress(address));
    }

finalize()

void cx.ath.matthew.unix.UnixSocket.finalize ( )

inline

                           {
        try {
            close();
        } catch (IOException IOe) {
        }
    }

getAddress()

UnixSocketAddress cx.ath.matthew.unix.UnixSocket.getAddress ( )

inline

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

戻り値

The UnixSocketAddress the socket is connected to

                                          {
        return address;
    }

getBlocking()

boolean cx.ath.matthew.unix.UnixSocket.getBlocking ( )

inline

Get the blocking mode.

戻り値

true if reads are blocking.

参照

setBlocking

                                 {
        return blocking;
    }

getInputStream()

InputStream cx.ath.matthew.unix.UnixSocket.getInputStream ( )

inline

Returns an InputStream for reading from the socket.

戻り値

An InputStream connected to this socket.

                                        {
        return is;
    }

getOutputStream()

OutputStream cx.ath.matthew.unix.UnixSocket.getOutputStream ( )

inline

Returns an OutputStream for writing to the socket.

戻り値

An OutputStream connected to this socket.

                                          {
        return os;
    }

getPassCred()

boolean cx.ath.matthew.unix.UnixSocket.getPassCred ( )

inline

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

戻り値

The current status of credential passing.

参照

setPassCred

                                 {
        return passcred;
    }

getPeerGID()

int cx.ath.matthew.unix.UnixSocket.getPeerGID ( )

inline

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.

戻り値

the GID or -1 if it is not available

                            {
        if (-1 == gid)
            gid = native_getGID(sock);
        return gid;
    }

getPeerPID()

int cx.ath.matthew.unix.UnixSocket.getPeerPID ( )

inline

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.

戻り値

the PID or -1 if it is not available

                            {
        if (-1 == pid)
            pid = native_getPID(sock);
        return pid;
    }

getPeerUID()

int cx.ath.matthew.unix.UnixSocket.getPeerUID ( )

inline

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.

戻り値

the UID or -1 if it is not available

                            {
        if (-1 == uid)
            uid = native_getUID(sock);
        return uid;
    }

isClosed()

boolean cx.ath.matthew.unix.UnixSocket.isClosed ( )

inline

Check the socket status.

戻り値

true if closed.

                              {
        return closed;
    }

isConnected()

boolean cx.ath.matthew.unix.UnixSocket.isConnected ( )

inline

Check the socket status.

戻り値

true if connected.

                                 {
        return connected;
    }

isInputShutdown()

boolean cx.ath.matthew.unix.UnixSocket.isInputShutdown ( )

inline

Check the socket status.

戻り値

true if the input stream has been shutdown

                                     {
        return is.isClosed();
    }

isOutputShutdown()

boolean cx.ath.matthew.unix.UnixSocket.isOutputShutdown ( )

inline

Check the socket status.

戻り値

true if the output stream has been shutdown

                                      {
        return os.isClosed();
    }

native_close()

native void cx.ath.matthew.unix.UnixSocket.native_close ( int  sock ) throws IOException

private

native_connect()

native int cx.ath.matthew.unix.UnixSocket.native_connect ( String  address, boolean  abs  ) throws IOException

private

native_getGID()

native int cx.ath.matthew.unix.UnixSocket.native_getGID ( int  sock )

private

native_getPID()

native int cx.ath.matthew.unix.UnixSocket.native_getPID ( int  sock )

private

native_getUID()

native int cx.ath.matthew.unix.UnixSocket.native_getUID ( int  sock )

private

native_recv_creds()

native byte cx.ath.matthew.unix.UnixSocket.native_recv_creds ( int  sock, int []  creds  ) throws IOException

private

native_send_creds()

native void cx.ath.matthew.unix.UnixSocket.native_send_creds ( int  sock, byte  data  ) throws IOException

private

native_set_pass_cred()

native void cx.ath.matthew.unix.UnixSocket.native_set_pass_cred ( int  sock, boolean  passcred  ) throws IOException

private

recvCredentialByte()

byte cx.ath.matthew.unix.UnixSocket.recvCredentialByte ( ) throws IOException

inline

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

引数

data	The byte of data to send.

参照

getPeerUID

getPeerPID

getPeerGID

                                                        {
        if (!connected) throw new NotConnectedException();
        int[] creds = new int[]{-1, -1, -1};
        byte data = native_recv_creds(sock, creds);
        pid = creds[0];
        uid = creds[1];
        gid = creds[2];
        return data;
    }

sendCredentialByte()

void cx.ath.matthew.unix.UnixSocket.sendCredentialByte ( byte  data ) throws IOException

inline

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

引数

data	The byte of data to send.

                                                                 {
        if (!connected) throw new NotConnectedException();
        native_send_creds(sock, data);
    }

setBlocking()

void cx.ath.matthew.unix.UnixSocket.setBlocking ( boolean  enable )

inline

Set the blocking mode.

引数

enable

Set to false for non-blocking reads.

                                            {
        blocking = enable;
        if (null != is) is.setBlocking(enable);
    }

setPassCred()

void cx.ath.matthew.unix.UnixSocket.setPassCred ( boolean  enable ) throws IOException

inline

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

引数

enable

Set to true for credentials to be passed.

                                                               {
        native_set_pass_cred(sock, enable);
        passcred = enable;
    }

setSoTimeout()

void cx.ath.matthew.unix.UnixSocket.setSoTimeout ( int  timeout )

inline

Set timeout of read requests.

                                          {
        is.setSoTimeout(timeout);
    }

shutdownInput()

void cx.ath.matthew.unix.UnixSocket.shutdownInput ( )

inline

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

                                {
        is.closed = true;
    }

shutdownOutput()

void cx.ath.matthew.unix.UnixSocket.shutdownOutput ( )

inline

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

                                 {
        os.closed = true;
    }

メンバ詳解

address

UnixSocketAddress cx.ath.matthew.unix.UnixSocket.address = null

private

blocking

boolean cx.ath.matthew.unix.UnixSocket.blocking = true

private

closed

boolean cx.ath.matthew.unix.UnixSocket.closed = false

private

connected

boolean cx.ath.matthew.unix.UnixSocket.connected = false

private

gid

int cx.ath.matthew.unix.UnixSocket.gid = -1

private

is

USInputStream cx.ath.matthew.unix.UnixSocket.is = null

private

os

USOutputStream cx.ath.matthew.unix.UnixSocket.os = null

private

passcred

boolean cx.ath.matthew.unix.UnixSocket.passcred = false

private

pid

int cx.ath.matthew.unix.UnixSocket.pid = -1

private

sock

int cx.ath.matthew.unix.UnixSocket.sock = 0

private

uid

int cx.ath.matthew.unix.UnixSocket.uid = -1

private

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/federation/src/federation/sssd/src/main/java/cx/ath/matthew/unix/UnixSocket.java