IT. Expert System.

All Implemented Interfaces:

Closeable, AutoCloseable

public class LocalSocket
extends Object
implements Closeable

• Constructor Summary

  Constructors

  Constructor and Description
  LocalSocket() Creates a AF_LOCAL/UNIX domain stream socket.
  LocalSocket(FileDescriptor fd) Creates a AF_LOCAL/UNIX domain stream socket with FileDescriptor.

• Method Summary

  Methods

  Modifier and Type	Method and Description
  void	bind(LocalSocketAddress bindpoint) Binds this socket to an endpoint name.
  void	close() Closes the socket.
  void	connect(LocalSocketAddress endpoint) Connects this socket to an endpoint.
  void	connect(LocalSocketAddress endpoint, int timeout)
  FileDescriptor[]	getAncillaryFileDescriptors() Retrieves a set of file descriptors that a peer has sent through an ancillary message.
  FileDescriptor	getFileDescriptor() Returns file descriptor or null if not yet open/already closed
  InputStream	getInputStream() Retrieves the input stream for this instance.
  LocalSocketAddress	getLocalSocketAddress() Retrieves the name that this socket is bound to, if any.
  OutputStream	getOutputStream() Retrieves the output stream for this instance.
  Credentials	getPeerCredentials() Retrieves the credentials of this socket's peer.
  int	getReceiveBufferSize()
  LocalSocketAddress	getRemoteSocketAddress()
  int	getSendBufferSize()
  int	getSoTimeout()
  boolean	isBound()
  boolean	isClosed()
  boolean	isConnected()
  boolean	isInputShutdown()
  boolean	isOutputShutdown()
  void	setFileDescriptorsForSend(FileDescriptor[] fds) Enqueues a set of file descriptors to send to the peer.
  void	setReceiveBufferSize(int size)
  void	setSendBufferSize(int n)
  void	setSoTimeout(int n)
  void	shutdownInput() Shuts down the input side of the socket.
  void	shutdownOutput() Shuts down the output side of the socket.
  String	toString() Returns a string containing a concise, human-readable description of this object.

  • Methods inherited from class java.lang.Object

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

• Constructor Detail

  • LocalSocket

    public LocalSocket()

    Creates a AF_LOCAL/UNIX domain stream socket.

  • LocalSocket

    public LocalSocket(FileDescriptor fd)
                throws IOException

    Creates a AF_LOCAL/UNIX domain stream socket with FileDescriptor.

    Throws:

    IOException

• Method Detail

  • toString

    public String toString()

    Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

       getClass().getName() + '@' + Integer.toHexString(hashCode())

    See Writing a useful toString method if you intend implementing your own toString method.

    Overrides:

    toString in class Object

    Returns:

    a printable representation of this object.

  • connect

    public void connect(LocalSocketAddress endpoint)
                 throws IOException

    Connects this socket to an endpoint. May only be called on an instance that has not yet been connected.

    Parameters:

    endpoint - endpoint address

    Throws:

    IOException - if socket is in invalid state or the address does not exist.

  • bind

    public void bind(LocalSocketAddress bindpoint)
              throws IOException

    Binds this socket to an endpoint name. May only be called on an instance that has not yet been bound.

    Parameters:

    bindpoint - endpoint address

    Throws:

    IOException

  • getLocalSocketAddress

    public LocalSocketAddress getLocalSocketAddress()

    Retrieves the name that this socket is bound to, if any.

    Returns:

    Local address or null if anonymous

  • getInputStream

    public InputStream getInputStream()
                               throws IOException

    Retrieves the input stream for this instance.

    Returns:

    input stream

    Throws:

    IOException - if socket has been closed or cannot be created.

  • getOutputStream

    public OutputStream getOutputStream()
                                 throws IOException

    Retrieves the output stream for this instance.

    Returns:

    output stream

    Throws:

    IOException - if socket has been closed or cannot be created.

  • close

    public void close()
               throws IOException

    Closes the socket.

    Specified by:

    close in interface Closeable

    Specified by:

    close in interface AutoCloseable

    Throws:

    IOException

  • shutdownInput

    public void shutdownInput()
                       throws IOException

    Shuts down the input side of the socket.

    Throws:

    IOException

  • shutdownOutput

    public void shutdownOutput()
                        throws IOException

    Shuts down the output side of the socket.

    Throws:

    IOException

  • setReceiveBufferSize

    public void setReceiveBufferSize(int size)
                              throws IOException

    Throws:

    IOException

  • getReceiveBufferSize

    public int getReceiveBufferSize()
                             throws IOException

    Throws:

    IOException

  • setSoTimeout

    public void setSoTimeout(int n)
                      throws IOException

    Throws:

    IOException

  • getSoTimeout

    public int getSoTimeout()
                     throws IOException

    Throws:

    IOException

  • setSendBufferSize

    public void setSendBufferSize(int n)
                           throws IOException

    Throws:

    IOException

  • getSendBufferSize

    public int getSendBufferSize()
                          throws IOException

    Throws:

    IOException

  • getRemoteSocketAddress

    public LocalSocketAddress getRemoteSocketAddress()

  • isConnected

    public boolean isConnected()

  • isClosed

    public boolean isClosed()

  • isBound

    public boolean isBound()

  • isOutputShutdown

    public boolean isOutputShutdown()

  • isInputShutdown

    public boolean isInputShutdown()

  • connect

    public void connect(LocalSocketAddress endpoint,
               int timeout)
                 throws IOException

    Throws:

    IOException

  • setFileDescriptorsForSend

    public void setFileDescriptorsForSend(FileDescriptor[] fds)

    Enqueues a set of file descriptors to send to the peer. The queue is one deep. The file descriptors will be sent with the next write of normal data, and will be delivered in a single ancillary message. See "man 7 unix" SCM_RIGHTS on a desktop Linux machine.

    Parameters:

    fds - non-null; file descriptors to send.

  • getAncillaryFileDescriptors

    public FileDescriptor[] getAncillaryFileDescriptors()
                                                 throws IOException

    Retrieves a set of file descriptors that a peer has sent through an ancillary message. This method retrieves the most recent set sent, and then returns null until a new set arrives. File descriptors may only be passed along with regular data, so this method can only return a non-null after a read operation.

    Returns:

    null or file descriptor array

    Throws:

    IOException

  • getPeerCredentials

    public Credentials getPeerCredentials()
                                   throws IOException

    Retrieves the credentials of this socket's peer. Only valid on connected sockets.

    Returns:

    non-null; peer credentials

    Throws:

    IOException

  • getFileDescriptor

    public FileDescriptor getFileDescriptor()

    Returns file descriptor or null if not yet open/already closed

    Returns:

    fd or null