PooledSocket (MyTISM API Documentation)

java.lang.Object
- de.ipcon.db.protocol.socket.PooledSocket

public class PooledSocket
extends java.lang.Object

A special socket wrapper for use with a socket pool.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acquired()` Records acquisition information.
`void`	`auth()` Authenticates with the server by sending the session ID.
`void`	`bye()` Terminates the server connection gracefully by sending a termination command and closing the socket.
`void`	`checkFreeSocket()` Checks the connection to the server by sending a ping command.
`void`	`close()` Closes the PooledSocket.
`void`	`closeLater()` Marks the PooledSocket for closing.
`void`	`closeNT()` Closes the PooledSocket, ignoring any I/O exceptions that may occur.
`java.lang.RuntimeException`	`getAcquiredAt()`
`java.lang.Thread`	`getAcquiredFrom()` Returns the Thread from which this PooledSocket was acquired, if it has not yet been garbage collected.
`long`	`getAcquiredWhen()`
`java.lang.RuntimeException`	`getCreatedAt()`
`long`	`getCreatedWhen()`
`CryptoHandlerI`	`getCryptoHandler()` Retrieves a CryptoHandlerI from the BackendProtocolServer.
`long`	`getLastUsed()`
`java.lang.String`	`getLogPrefix()`
`int`	`getPid()`
`SocketPool`	`getSocketPool()`
`TransportI`	`getTransport()` Returns the underlying TransportI used by this PooledSocket.
`boolean`	`isAuthenticated()` Comparator for PooledSockets.
`boolean`	`isClosed()` Checks if the PooledSocket is closed.
`int`	`ping()` Sends a ping command to the server to check the connection and retrieve the server's protocol version.
`void`	`readMagic()` Tries to read the protocol magic from the input stream.
`void`	`readMagic(boolean updateLastUsed)`
`void`	`released()` Resets acquisition information.
`void`	`reset()` Resets the transport.
`void`	`rinse()` Returns this PooledSocket to the pool.
`void`	`setAcquiredAt(java.lang.RuntimeException $15)`
`void`	`setAcquiredWhen(long $16)`
`void`	`setAuthenticated(boolean $13)`
`void`	`setCreatedAt(java.lang.RuntimeException $18)`
`void`	`setCreatedWhen(long $17)`
`void`	`setLastUsed(long $14)`
`void`	`setLogPrefix(java.lang.String $21)`
`void`	`setPid(int $19)`
`void`	`setSocketPool(SocketPool $20)`
`boolean`	`shouldBeClosed()` Checks if the PooledSocket should be closed.
`java.lang.String`	`toString()`
`long`	`validUntil()` Returns the timestamp until which this PooledSocket is considered valid.
`boolean`	`wasRecentlyUsed()` Checks if this PooledSocket was recently used.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getTransport
```
public TransportI getTransport()
```
    Returns the underlying TransportI used by this PooledSocket. This allows access to the socket's communication channel.
    
    Returns:
    
    The TransportI object representing the socket's transport.
  - getAcquiredFrom
```
public java.lang.Thread getAcquiredFrom()
```
    Returns the Thread from which this PooledSocket was acquired, if it has not yet been garbage collected. This can be useful for debugging and tracking socket usage.
    
    Returns:
    
    The Thread object that acquired this PooledSocket, or null if the Thread has been garbage collected.
  - acquired
```
public void acquired()
```
    Records acquisition information. This method is called when the PooledSocket is acquired from the pool.
  - released
```
public void released()
```
    Resets acquisition information. This method is called when the PooledSocket is released back to the pool. It should reset any data set by the acquired() method.
  - rinse
```
public void rinse()
```
    Returns this PooledSocket to the pool.
  - wasRecentlyUsed
```
public boolean wasRecentlyUsed()
```
    Checks if this PooledSocket was recently used. "Recently" is defined by RECENT_THRESHOLD.
    
    Returns:
    
    true if the socket has been used within the recent threshold, false otherwise.
  - validUntil
```
public long validUntil()
```
    Returns the timestamp until which this PooledSocket is considered valid. This is based on the last usage time plus the RECENT_THRESHOLD.
    
    Returns:
    
    The timestamp representing the validity deadline.
  - getCryptoHandler
```
public CryptoHandlerI getCryptoHandler()
                                throws ServerConnectionException
```
    Retrieves a CryptoHandlerI from the BackendProtocolServer. This method is called during the initialization of a new session. It is responsible for obtaining the cryptographic handler used for secure communication.
    
    Returns:
    
    The CryptoHandlerI.
    
    Throws:
    
    ServerConnectionException - If a server connection error occurs or if an unexpected response is received from the server.
    
    See Also:
    
    SocketPool, BackendProtocolServer
  - auth
```
public void auth()
          throws ServerConnectionException
```
    Authenticates with the server by sending the session ID. This method is called before any command that requires authentication. It verifies the session's validity with the server. The authentication process involves sending the session ID to the server and waiting for a response. The server will respond with an OK message and the PID of the new BackendCommandHandler-thread if the session is valid, or a NOK message if the session is invalid or has expired.
    This method reads a protocol magic value after receiving the server's response to ensure synchronization with the server's communication protocol.
    
    Throws:
    
    ServerConnectionException - If authentication fails, a connection timeout occurs, or if an unexpected response is received from the server.
    
    See Also:
    
    SocketPool, BackendProtocolServer
  - ping
```
public int ping()
         throws ServerConnectionException
```
    Sends a ping command to the server to check the connection and retrieve the server's protocol version.
    
    Returns:
    
    The server's protocol version.
    
    Throws:
    
    ServerConnectionException - If a server connection error occurs.
    
    See Also:
    
    SocketPool, BackendConnection, BackendProtocolServer
  - checkFreeSocket
```
public void checkFreeSocket()
                     throws ServerConnectionException
```
    Checks the connection to the server by sending a ping command. This method is currently unused, but can be used to verify the health of free sockets. It does not update the last-used timestamp.
    
    Throws:
    
    ServerConnectionException - If a server connection error occurs.
  - bye
```
public void bye()
```
    Terminates the server connection gracefully by sending a termination command and closing the socket. This method also uses a TransportWatchdog to ensure the socket is closed even if the server is unresponsive.
    
    See Also:
    
    SocketPool
  - close
```
public void close()
           throws java.io.IOException
```
    Closes the PooledSocket. This method releases any resources associated with the socket.
    
    Throws:
    
    IOException - If an I/O error occurs during closing.
    
    See Also:
    
    SocketPool
  - closeNT
```
public void closeNT()
```
    Closes the PooledSocket, ignoring any I/O exceptions that may occur.
    
    See Also:
    
    SocketPool
  - closeLater
```
public void closeLater()
```
    Marks the PooledSocket for closing. The actual closing is deferred and performed by the SocketPool.recycleOldSocket(PooledSocket) method. This is used to avoid closing sockets within critical code sections.
    
    See Also:
    
    SocketPool, BackendQueryResults
  - shouldBeClosed
```
public boolean shouldBeClosed()
```
    Checks if the PooledSocket should be closed. This method is used by the SocketPool.recycleOldSocket(PooledSocket) method to identify sockets that need to be closed.
    
    Returns:
    
    true if the socket should be closed, false otherwise.
    
    See Also:
    
    SocketPool
  - isClosed
```
public boolean isClosed()
```
    Checks if the PooledSocket is closed. This method directly checks the underlying Transport's closed status.
    
    Returns:
    
    true if the socket is closed, false otherwise.
  - reset
```
public void reset()
           throws java.io.IOException
```
    Resets the transport. This method is called by the SocketPool.recycleOldSocket(PooledSocket) method to allow the transport to be reused.
    
    Throws:
    
    IOException - If an I/O error occurs.
  - readMagic
```
public void readMagic()
               throws java.io.IOException
```
    Tries to read the protocol magic from the input stream. This method verifies that the expected protocol magic is received from the server.
    
    Parameters:
    
    updateLastUsed - Whether to update the last-used timestamp after reading the magic.
    
    Throws:
    
    IOException - If an I/O error occurs or if the incorrect protocol magic is received.
    
    ServerConnectionException - If a timeout occurs while reading the magic.
    
    See Also:
    
    SocketPool, BackendConnection, BackendProtocolServer
  - readMagic
```
public void readMagic(boolean updateLastUsed)
               throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - isAuthenticated
```
public boolean isAuthenticated()
```
    Comparator for PooledSockets. This comparator is used to sort PooledSockets within the SocketPool's PriorityQueue. Sockets are prioritized based on their creation time.
    
    See Also:
    
    SocketPool
  - setAuthenticated
```
public void setAuthenticated(boolean $13)
```
  - getLastUsed
```
public long getLastUsed()
```
  - setLastUsed
```
public void setLastUsed(long $14)
```
  - getAcquiredAt
```
public java.lang.RuntimeException getAcquiredAt()
```
  - setAcquiredAt
```
public void setAcquiredAt(java.lang.RuntimeException $15)
```
  - getAcquiredWhen
```
public long getAcquiredWhen()
```
  - setAcquiredWhen
```
public void setAcquiredWhen(long $16)
```
  - getCreatedWhen
```
public long getCreatedWhen()
```
  - setCreatedWhen
```
public void setCreatedWhen(long $17)
```
  - getCreatedAt
```
public java.lang.RuntimeException getCreatedAt()
```
  - setCreatedAt
```
public void setCreatedAt(java.lang.RuntimeException $18)
```
  - getPid
```
public int getPid()
```
  - setPid
```
public void setPid(int $19)
```
  - getSocketPool
```
public SocketPool getSocketPool()
```
  - setSocketPool
```
public void setSocketPool(SocketPool $20)
```
  - getLogPrefix
```
public java.lang.String getLogPrefix()
```
  - setLogPrefix
```
public void setLogPrefix(java.lang.String $21)
```

Class PooledSocket

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getTransport

getAcquiredFrom

acquired

released

rinse

wasRecentlyUsed

validUntil

getCryptoHandler

auth

ping

checkFreeSocket

bye

close

closeNT

closeLater

shouldBeClosed

isClosed

reset

readMagic

readMagic

toString

isAuthenticated

setAuthenticated

getLastUsed

setLastUsed

getAcquiredAt

setAcquiredAt

getAcquiredWhen

setAcquiredWhen

getCreatedWhen

setCreatedWhen

getCreatedAt

setCreatedAt

getPid

setPid

getSocketPool

setSocketPool

getLogPrefix

setLogPrefix