AbstractSocketProtocolHandler (== GreenMail Core == 2.1.0-alpha-4 API)

java.lang.Object
- com.icegreen.greenmail.server.AbstractSocketProtocolHandler

All Implemented Interfaces:

ProtocolHandler, Runnable

Direct Known Subclasses:

ImapHandler, Pop3Handler, SmtpHandler
```
public abstract class AbstractSocketProtocolHandler
extends Object
implements ProtocolHandler
```
Provides shared helpers for handling a client socket connection.

Field Summary

Fields
Modifier and Type	Field	Description
`protected Object`	`closeMonitor`
`protected org.slf4j.Logger`	`log`
`protected boolean`	`quitting`
`protected Socket`	`socket`	The TCP/IP socket over which the IMAP interaction is occurring

Constructor Summary

Constructors
Modifier Constructor Description

protected AbstractSocketProtocolHandler(Socket socket)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`	Resets the handler data to a basic state.
`protected long`	`getSoTimeout()`	Gets current socket SO_TIMEOUT
`boolean`	`isQuitting()`	Preparing for closing handler connection?
`void`	`setQuitting(boolean quitting)`	Signal for closing handler.

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

Methods inherited from interface java.lang.Runnable
run

- Field Detail
  - log
```
protected final org.slf4j.Logger log
```
  - socket
```
protected final Socket socket
```
    The TCP/IP socket over which the IMAP interaction is occurring
  - quitting
```
protected volatile boolean quitting
```
  - closeMonitor
```
protected final Object closeMonitor
```
- Constructor Detail
  - AbstractSocketProtocolHandler
```
protected AbstractSocketProtocolHandler(Socket socket)
```
- Method Detail
  - isQuitting
```
public boolean isQuitting()
```
    Preparing for closing handler connection?
    
    Returns:
    
    true, if should be closed.
  - setQuitting
```
public void setQuitting(boolean quitting)
```
    Signal for closing handler.
    
    Parameters:
    
    quitting - true, if closing in progress.
  - close
```
public void close()
```
    Resets the handler data to a basic state.
    
    Specified by:
    
    close in interface ProtocolHandler
  - getSoTimeout
```
protected long getSoTimeout()
```
    Gets current socket SO_TIMEOUT
    
    Returns:
    
    the timeout or -1 if unable to retrieve.