NetSocket (P2J - Progress 4GL to Java Conversion and Runtime)

All Known Implementing Classes:

LoggingNetSocket, NetSocketWrapper, NIONetSocket, NIONetSocketBase, NIOSslSocket
```
public interface NetSocket
```
This interface represents a (secure) socket/channel and all related input/output streams as a one unit.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface NetSocket.NetSocketFactory
NetSocket factory

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`NetSocket.NetSocketFactory` NetSocket factory

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BUF_SIZE` I/O buffers' size
`static NetSocket.NetSocketFactory`	`FACTORY` NetSocket factory instance
`static long`	`handshakeTimeout` Handshake timeout (ms)
`static CentralLogger`	`LOG` Logger

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addSessionListener(SessionListener sessionListener)` Adds a session listener.
`void`	`close()` Closes the socket.
`default void`	`flush()` Flush the output if applicable
`java.net.InetAddress`	`getLocalAddr()` Access the address of the local system, through which we are connecting.
`java.net.InetSocketAddress`	`getLocalSockAddr()` Access the address of the local system, through which we are connecting.
`java.net.InetAddress`	`getRemoteAddr()` Access the address of the remote system, to which we are connecting.
`java.net.InetSocketAddress`	`getRemoteSockAddr()` Access the address of the remote system, to which we are connecting.
`javax.net.ssl.SSLSession`	`getSession()` Gets the SSL session.
`java.util.List<SessionListener>`	`getSessionListeners()` Gets the list with added session listeners.
`boolean`	`isClosed()` Reports if the socket is closed (and thus can no longer be used).
`byte[]`	`read()` Read the next portion of raw data (byte array) to the output
`boolean`	`readBoolean()` Read the boolean from the input
`void`	`readBytes(byte[] bytes)` Read the byte sequence from the input
`int`	`readInt()` Read the integer from the input
`java.lang.String`	`readUTF()` Read the UTF string from the input
`default void`	`tracef(java.lang.String fmt, java.lang.Object... args)` Write a message to the log using the specified format string and arguments.
`default void`	`traceln(java.lang.String message)` Write message to the log
`void`	`write(byte[] data)` Write byte array to the output
`void`	`writeBoolean(boolean val)` Write a boolean to the output
`void`	`writeBytes(byte[] bytes)` Write a byte sequence to the output
`void`	`writeInt(int val)` Write an integer to the output
`void`	`writeUTF(java.lang.String val)` Write an UTF String to the output

- Field Detail
  - LOG
```
static final CentralLogger LOG
```
    Logger
  - handshakeTimeout
```
static final long handshakeTimeout
```
    Handshake timeout (ms)
    
    See Also:
    
    Constant Field Values
  - BUF_SIZE
```
static final int BUF_SIZE
```
    I/O buffers' size
    
    See Also:
    
    Constant Field Values
  - FACTORY
```
static final NetSocket.NetSocketFactory FACTORY
```
    NetSocket factory instance
- Method Detail
  - traceln
```
default void traceln(java.lang.String message)
```
    Write message to the log
    
    Parameters:
    
    message - message to be written
  - tracef
```
default void tracef(java.lang.String fmt,
                    java.lang.Object... args)
```
    Write a message to the log using the specified format string and arguments.
    
    Parameters:
    
    fmt - A format string
    
    args - Arguments referenced by the format specifiers in the format string.
  - getSession
```
javax.net.ssl.SSLSession getSession()
```
    Gets the SSL session.
    
    Returns:
    
    The SSL session or null if the socket is not secure.
  - close
```
void close()
```
    Closes the socket.
  - isClosed
```
boolean isClosed()
```
    Reports if the socket is closed (and thus can no longer be used).
    
    Returns:
    
    true if the socket is closed.
  - getLocalAddr
```
java.net.InetAddress getLocalAddr()
```
    Access the address of the local system, through which we are connecting.
    
    Returns:
    
    The local address.
  - getLocalSockAddr
```
java.net.InetSocketAddress getLocalSockAddr()
```
    Access the address of the local system, through which we are connecting.
    
    Returns:
    
    The local socket address.
  - getRemoteAddr
```
java.net.InetAddress getRemoteAddr()
```
    Access the address of the remote system, to which we are connecting.
    
    Returns:
    
    The remote address.
  - getRemoteSockAddr
```
java.net.InetSocketAddress getRemoteSockAddr()
```
    Access the address of the remote system, to which we are connecting.
    
    Returns:
    
    The remote socket address.
  - getSessionListeners
```
java.util.List<SessionListener> getSessionListeners()
```
    Gets the list with added session listeners. May return null if none has been added.
    
    Returns:
    
    The current session listener.
  - addSessionListener
```
void addSessionListener(SessionListener sessionListener)
```
    Adds a session listener.
    
    Parameters:
    
    sessionListener - A session listener to be added.
  - flush
```
default void flush()
            throws java.io.IOException
```
    Flush the output if applicable
    
    Throws:
    
    java.io.IOException - on error
  - write
```
void write(byte[] data)
    throws java.io.IOException
```
    Write byte array to the output
    
    Parameters:
    
    data - byte array
    
    Throws:
    
    java.io.IOException - on error
  - read
```
byte[] read()
     throws java.io.IOException
```
    Read the next portion of raw data (byte array) to the output
    
    Returns:
    
    byte array
    
    Throws:
    
    java.io.IOException - on error
  - readInt
```
int readInt()
     throws java.io.IOException
```
    Read the integer from the input
    
    Returns:
    
    integer data
    
    Throws:
    
    java.io.IOException - on error
  - writeInt
```
void writeInt(int val)
       throws java.io.IOException
```
    Write an integer to the output
    
    Parameters:
    
    val - integer data to be written
    
    Throws:
    
    java.io.IOException - on error
  - writeBytes
```
void writeBytes(byte[] bytes)
         throws java.io.IOException
```
    Write a byte sequence to the output
    
    Parameters:
    
    bytes - byte sequence to be written
    
    Throws:
    
    java.io.IOException - on error
  - readBytes
```
void readBytes(byte[] bytes)
        throws java.io.IOException
```
    Read the byte sequence from the input
    
    Parameters:
    
    bytes - byte array to be filled by the input bytes
    
    Throws:
    
    java.io.IOException - on error
  - writeBoolean
```
void writeBoolean(boolean val)
           throws java.io.IOException
```
    Write a boolean to the output
    
    Parameters:
    
    val - boolean data to be written
    
    Throws:
    
    java.io.IOException - on error
  - readBoolean
```
boolean readBoolean()
             throws java.io.IOException
```
    Read the boolean from the input
    
    Returns:
    
    boolean data
    
    Throws:
    
    java.io.IOException - on error
  - readUTF
```
java.lang.String readUTF()
                  throws java.io.IOException
```
    Read the UTF string from the input
    
    Returns:
    
    UTF string
    
    Throws:
    
    java.io.IOException - on error
  - writeUTF
```
void writeUTF(java.lang.String val)
       throws java.io.IOException
```
    Write an UTF String to the output
    
    Parameters:
    
    val - UTF String to be written
    
    Throws:
    
    java.io.IOException - on error

Interface NetSocket

Nested Class Summary

Field Summary

Method Summary

Field Detail

LOG

handshakeTimeout

BUF_SIZE

FACTORY

Method Detail

traceln

tracef

getSession

close

isClosed

getLocalAddr

getLocalSockAddr

getRemoteAddr

getRemoteSockAddr

getSessionListeners

addSessionListener

flush

write

read

readInt

writeInt

writeBytes

readBytes

writeBoolean

readBoolean

readUTF

writeUTF