NetStat.BusyPort.TcpState (Terracotta Utilities Port Chooser 0.0.17 API)

java.lang.Object
- java.lang.Enum<NetStat.BusyPort.TcpState>
- - org.terracotta.utilities.test.net.NetStat.BusyPort.TcpState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NetStat.BusyPort.TcpState>

Enclosing class:

NetStat.BusyPort
```
public static enum NetStat.BusyPort.TcpState
extends java.lang.Enum<NetStat.BusyPort.TcpState>
```
TCP Connection states.
This class maps the states observed by the utilities used to examine the TCP connections on the platform to a common form. Where the state maps to a state described in RFC-793 Transmission Control Protocol, that state name is used for the enumeration constant.
The following diagram shows the usual TCP state transitions. For a discussion of this diagram, see RFC-793 Transmission Control Protocol and TCP/IP Illustrated, Volume 1, 1ed: The Protocols by W. Richard Stevens.
- The CLOSE_WAIT and FIN_WAIT_2 states are paired -- one side of the connection will be in CLOSE_WAIT and the other in FIN_WAIT_2. Until the application in CLOSE_WAIT actually closes the connection, the connection remains with neither socket endpoint being available for re-use. (According to (Stevens 1994), some TCP implementations will move a socket in FIN_WAIT_2 to CLOSED after 10+ minutes of idle time.)
- The TIME_WAIT state is applied to a newly closed connection and is used to prevent immediate re-use of the socket to allow delivery of potentially delayed packets. The amount of time the socket remains in TIME_WAIT varies by implementation (and potentially configuration) but is commonly 2 minutes.
Implementation Notes

Mac OS X
The nettop utility used for Mac OS X is closed source but source for a variant (netbottom.c) is available. The TCP state constants returned by nettop are neither documented nor listed in an available source file. The values used in this enum are presumed from the known values and the names of external references, in the form of kNStatSrcTcpStateXxxxxxxxxx, made by netbottom.c.
See Also:

Get-NetTCPConnection, MSFT_NetTCPConnection class, lsof/dialects/linux/dsock.c, apple/darwin-xnu/bsd/netinet/tcp_fsm.h, netbottom.c Sources, "Stevens, W. Richard (1994) TCP/IP Illustrated, Volume 1, 1ed: The Protocols, Addison-Wesley", RFC-793 Transmission Control Protocol

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BOUND` Awaiting application `listen`, `connect`, `accept`, or `close` call following `bind` (lsof).
`CLOSE` Awaiting application `close` following a socket/connection error (lsof/Linux).
`CLOSE_WAIT` Awaiting application-level connection termination (socket close) (RFC-793).
`CLOSED` Not connected (RFC-793).
`CLOSING` Awaiting connection termination request acknowledgement from remote (RFC-793).
`DELETE_TCB` Indicates the control block representing the TCP connection is being deleted (MSFT_NetTCPConnection).
`ESTABLISHED` An "open" TCP connection over which data may be transferred (RFC-793).
`FIN_WAIT_1` Awaiting connection termination request or acknowledgement of sent connection termination request from remote (RFC-793).
`FIN_WAIT_2` Awaiting connection termination request from remote (RFC-793).
`IDLE` Awaiting application `bind`, `connect`, or `close` on socket (lsof).
`LAST_ACK` Awaiting acknowledgement of connection termination request sent to remote (RFC-793).
`LISTEN` Awaiting a connection request (RFC-793).
`SYN_RECEIVED` Awaiting connection request acknowledgement after having sent and received a connection request (RFC-793).
`SYN_SENT` Awaiting a matching connection request after having sent a connection request (RFC-793).
`TIME_WAIT` Awaiting expiration of TCP implementation-defined timeout before socket of closed connection can be re-used (RFC-793).
`UNKNOWN` Connection state is unknown (MSFT_NetTCPConnection).

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static NetStat.BusyPort.TcpState`	`fromLsofString(java.lang.String lsofStateString)` Determine the `TcpCode` from the state string from the `lsof` command.
`static NetStat.BusyPort.TcpState`	`fromMicrosoftNumber(int msStateNumber)` Determine the `TcpState` from the state number corresponding to a Microsoft `System.Net.NetworkInformation.TcpState` enum value.
`static NetStat.BusyPort.TcpState`	`fromMicrosoftString(java.lang.String msStateString)` Determine the `TcpState` from the state string from the Microsoft `Get-NetTCPConnection` cmdlet.
`static NetStat.BusyPort.TcpState`	`fromNettopString(java.lang.String nettopStateString)` Determine the `TcpCode` from the state string from the `nettop` command.
`static NetStat.BusyPort.TcpState`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static NetStat.BusyPort.TcpState[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - UNKNOWN
```
public static final NetStat.BusyPort.TcpState UNKNOWN
```
    Connection state is unknown (MSFT_NetTCPConnection).
  - CLOSED
```
public static final NetStat.BusyPort.TcpState CLOSED
```
    Not connected (RFC-793).
  - LISTEN
```
public static final NetStat.BusyPort.TcpState LISTEN
```
    Awaiting a connection request (RFC-793).
  - SYN_SENT
```
public static final NetStat.BusyPort.TcpState SYN_SENT
```
    Awaiting a matching connection request after having sent a connection request (RFC-793).
  - SYN_RECEIVED
```
public static final NetStat.BusyPort.TcpState SYN_RECEIVED
```
    Awaiting connection request acknowledgement after having sent and received a connection request (RFC-793).
  - ESTABLISHED
```
public static final NetStat.BusyPort.TcpState ESTABLISHED
```
    An "open" TCP connection over which data may be transferred (RFC-793).
  - FIN_WAIT_1
```
public static final NetStat.BusyPort.TcpState FIN_WAIT_1
```
    Awaiting connection termination request or acknowledgement of sent connection termination request from remote (RFC-793).
  - FIN_WAIT_2
```
public static final NetStat.BusyPort.TcpState FIN_WAIT_2
```
    Awaiting connection termination request from remote (RFC-793).
  - CLOSE_WAIT
```
public static final NetStat.BusyPort.TcpState CLOSE_WAIT
```
    Awaiting application-level connection termination (socket close) (RFC-793).
  - CLOSING
```
public static final NetStat.BusyPort.TcpState CLOSING
```
    Awaiting connection termination request acknowledgement from remote (RFC-793).
  - LAST_ACK
```
public static final NetStat.BusyPort.TcpState LAST_ACK
```
    Awaiting acknowledgement of connection termination request sent to remote (RFC-793).
  - TIME_WAIT
```
public static final NetStat.BusyPort.TcpState TIME_WAIT
```
    Awaiting expiration of TCP implementation-defined timeout before socket of closed connection can be re-used (RFC-793).
  - DELETE_TCB
```
public static final NetStat.BusyPort.TcpState DELETE_TCB
```
    Indicates the control block representing the TCP connection is being deleted (MSFT_NetTCPConnection).
  - BOUND
```
public static final NetStat.BusyPort.TcpState BOUND
```
    Awaiting application listen, connect, accept, or close call following bind (lsof).
  - CLOSE
```
public static final NetStat.BusyPort.TcpState CLOSE
```
    Awaiting application close following a socket/connection error (lsof/Linux).
  - IDLE
```
public static final NetStat.BusyPort.TcpState IDLE
```
    Awaiting application bind, connect, or close on socket (lsof).
- Method Detail
  - values
```
public static NetStat.BusyPort.TcpState[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (NetStat.BusyPort.TcpState c : NetStat.BusyPort.TcpState.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static NetStat.BusyPort.TcpState valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - fromNettopString
```
public static NetStat.BusyPort.TcpState fromNettopString(java.lang.String nettopStateString)
```
    Determine the TcpCode from the state string from the nettop command.
    
    Parameters:
    
    nettopStateString - the state string from nettop
    
    Returns:
    
    the TcpState corresponding to nettopStateString
    
    Throws:
    
    java.lang.EnumConstantNotPresentException - if nettopStateString is not a recognized TcpState
  - fromLsofString
```
public static NetStat.BusyPort.TcpState fromLsofString(java.lang.String lsofStateString)
```
    Determine the TcpCode from the state string from the lsof command.
    
    Parameters:
    
    lsofStateString - the state string from lsof
    
    Returns:
    
    the TcpState corresponding to lsofStateString
    
    Throws:
    
    java.lang.EnumConstantNotPresentException - if lsofStateString is not a recognized TcpState
    
    See Also:
    
    lsof-org/lsof Source Repository
  - fromMicrosoftString
```
public static NetStat.BusyPort.TcpState fromMicrosoftString(java.lang.String msStateString)
```
    Determine the TcpState from the state string from the Microsoft Get-NetTCPConnection cmdlet.
    
    Parameters:
    
    msStateString - the state string from the Get-NetTCPConnection cmdlet
    
    Returns:
    
    the TcpState corresponding to msStateString
    
    Throws:
    
    java.lang.EnumConstantNotPresentException - if msStateString is not a recognized TcpState
    
    See Also:
    
    MSFT_NetTCPConnection class
  - fromMicrosoftNumber
```
public static NetStat.BusyPort.TcpState fromMicrosoftNumber(int msStateNumber)
```
    Determine the TcpState from the state number corresponding to a Microsoft System.Net.NetworkInformation.TcpState enum value.
    
    Parameters:
    
    msStateNumber - the TcpState enum number
    
    Returns:
    
    the TcpState corresponding to msStateNumber
    
    Throws:
    
    java.lang.EnumConstantNotPresentException - if msStateNumber is not a recognized TcpState
    
    See Also:
    
    TcpState Enum

Enum NetStat.BusyPort.TcpState

Implementation Notes

Mac OS X

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

UNKNOWN

CLOSED

LISTEN

SYN_SENT

SYN_RECEIVED

ESTABLISHED

FIN_WAIT_1

FIN_WAIT_2

CLOSE_WAIT

CLOSING

LAST_ACK

TIME_WAIT

DELETE_TCB

BOUND

CLOSE

IDLE

Method Detail

values

valueOf

fromNettopString

fromLsofString

fromMicrosoftString

fromMicrosoftNumber