LocalSocket

java.lang.Object
- ohos.net.LocalSocket

```
public class LocalSocket
extends Object
```
Represents an AF_LOCAL (also known as AF_UNIX) socket in the UNIX domain namespace.

从以下版本开始:

4

构造器概要

构造器
构造器说明

LocalSocket(String name, boolean isServer)
A parameterized constructor used to create a LocalSocket instance.

构造器
构造器	说明
`LocalSocket(String name, boolean isServer)`	A parameterized constructor used to create a `LocalSocket` instance.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`LocalSocket`	`acceptSocket()`	Accepts a connection request from the client.
`void`	`closeInputStream()`	Closes the input stream of this socket.
`void`	`closeOutputStream()`	Closes the output stream of this socket.
`void`	`closeSocket()`	Closes the socket after the server and client finish communicating with each other.
`void`	`connectSocket()`	Connects the client socket to a specified address for setting up a connection with the server.
`FileDescriptor[]`	`getAppendedFds()`	Obtains an array of appended file descriptors sent by the peer as additional information.
`InputStream`	`getInputStream()`	Obtains the input stream of this socket.
`OutputStream`	`getOutputStream()`	Obtains the output stream of this socket.
`SocketCertificates`	`getPeerSocketInfo()`	Obtains certificates of the peer socket.
`FileDescriptor`	`getSocketFd()`	Obtains the file descriptor of this socket.
`String`	`getSocketName()`	Obtains the socket name.
`boolean`	`isSocketConnected()`	Checks whether this socket is connected.
`void`	`setAppendedFds(FileDescriptor[] fds)`	Sets an array of appended file descriptors that will be added as additional information to the common information to be sent to the peer next time.
`void`	`setSocketReadTimeout(int timeout)`	Sets the timeout duration for reading data from the input stream of this socket.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - LocalSocket
```
public LocalSocket(String name,
                   boolean isServer)
            throws IOException
```
    A parameterized constructor used to create a LocalSocket instance.
    Currently, only a stream socket can be created. If a server socket is to be created, bind and listen operations will be performed during the creation.
    
    参数:
    
    name - Indicates the socket name. It cannot be null.
    
    isServer - Specifies whether to create a server or client socket. The value true means to create a server socket, and false means to create a client socket.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if name is null.
    
    IOException - Throws this exception if an error occurs during the server socket creation.
    
    从以下版本开始:
    
    4
- 方法详细资料
  - connectSocket
```
public void connectSocket()
                   throws IOException
```
    Connects the client socket to a specified address for setting up a connection with the server.
    The address is the name passed in the constructor.
    
    抛出:
    
    IOException - Throws this exception if the socket connection status is invalid (for example, already connected) or an error occurs during the socket creation.
    
    从以下版本开始:
    
    4
  - acceptSocket
```
public LocalSocket acceptSocket()
                         throws IOException
```
    Accepts a connection request from the client.
    
    返回:
    
    Returns a new LocalSocket object for communicating with the client.
    
    抛出:
    
    IOException - Throws this exception if an error occurs during the socket creation, for example, the socket fails to create.
    
    从以下版本开始:
    
    4
  - closeSocket
```
public void closeSocket()
                 throws IOException
```
    Closes the socket after the server and client finish communicating with each other.
    
    抛出:
    
    IOException - Throws this exception if the socket fails to close.
    
    从以下版本开始:
    
    4
  - getInputStream
```
public InputStream getInputStream()
                           throws IOException
```
    Obtains the input stream of this socket.
    
    返回:
    
    Returns the input stream.
    
    抛出:
    
    IOException - Throws this exception if an error occurs during the socket creation or the socket has been closed.
    
    从以下版本开始:
    
    4
  - getOutputStream
```
public OutputStream getOutputStream()
                             throws IOException
```
    Obtains the output stream of this socket.
    
    返回:
    
    Returns the output stream.
    
    抛出:
    
    IOException - Throws this exception if an error occurs during the socket creation or the socket has been closed.
    
    从以下版本开始:
    
    4
  - closeInputStream
```
public void closeInputStream()
                      throws IOException
```
    Closes the input stream of this socket.
    
    抛出:
    
    IOException - Throws this exception if an error occurs during the socket creation, for example, the socket fails to create.
    
    从以下版本开始:
    
    4
  - closeOutputStream
```
public void closeOutputStream()
                       throws IOException
```
    Closes the output stream of this socket.
    
    抛出:
    
    IOException - Throws this exception if an error occurs during the socket creation, for example, the socket fails to create.
    
    从以下版本开始:
    
    4
  - getSocketFd
```
public FileDescriptor getSocketFd()
```
    Obtains the file descriptor of this socket.
    
    返回:
    
    Returns the file descriptor if obtained; returns null if no socket is available or the socket has been closed.
    
    从以下版本开始:
    
    4
  - getSocketName
```
public String getSocketName()
```
    Obtains the socket name.
    
    返回:
    
    Returns the socket name.
    
    从以下版本开始:
    
    4
  - getPeerSocketInfo
```
public SocketCertificates getPeerSocketInfo()
                                     throws IOException
```
    Obtains certificates of the peer socket.
    
    返回:
    
    Returns certificates of the peer socket, including the PID, UID, and GID of the peer process.
    
    抛出:
    
    IOException - Throws this exception if an error occurs during the socket creation, for example, the socket fails to create.
    
    从以下版本开始:
    
    4
  - isSocketConnected
```
public boolean isSocketConnected()
```
    Checks whether this socket is connected.
    
    返回:
    
    Returns true if this socket is connected; returns false otherwise.
    
    从以下版本开始:
    
    4
  - setSocketReadTimeout
```
public void setSocketReadTimeout(int timeout)
                          throws IOException
```
    Sets the timeout duration for reading data from the input stream of this socket.
    
    参数:
    
    timeout - Indicates the timeout duration to set, in milliseconds.
    
    抛出:
    
    IOException - Throws this exception if an error occurs during the socket creation, for example, the socket fails to create.
    
    从以下版本开始:
    
    4
  - getAppendedFds
```
public FileDescriptor[] getAppendedFds()
                                throws IOException
```
    Obtains an array of appended file descriptors sent by the peer as additional information.
    
    返回:
    
    Returns an array of appended file descriptors, if any; returns null otherwise.
    
    抛出:
    
    IOException - Throws this exception if an error occurs during the socket creation, for example, the socket fails to create.
    
    从以下版本开始:
    
    5
  - setAppendedFds
```
public void setAppendedFds(FileDescriptor[] fds)
                    throws IOException
```
    Sets an array of appended file descriptors that will be added as additional information to the common information to be sent to the peer next time.
    
    参数:
    
    fds - Indicates an array of file descriptors.
    
    抛出:
    
    IOException - Throws this exception if an error occurs during the socket creation, for example, the socket fails to create.
    
    从以下版本开始:
    
    5

类 LocalSocket

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

LocalSocket

方法详细资料

connectSocket

acceptSocket

closeSocket

getInputStream

getOutputStream

closeInputStream

closeOutputStream

getSocketFd

getSocketName

getPeerSocketInfo

isSocketConnected

setSocketReadTimeout

getAppendedFds

setAppendedFds