TcpFlagMask (sdn-apidoc 2.6.8 API)

java.lang.Object
- java.lang.Enum<TcpFlagMask>
- - com.hp.of.lib.match.TcpFlagMask

All Implemented Interfaces:

Serializable, Comparable<TcpFlagMask>
```
public enum TcpFlagMask
extends Enum<TcpFlagMask>
```
TCP Flag coding mechanism in HP switch. This is only to be used in the HP experimenter match fields

Author:

Chao Shi

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ACK_SET`
`ACK_UNSET`
`FIN_SET`
`FIN_UNSET`
`PSH_SET`
`PSH_UNSET`
`RST_SET`
`RST_UNSET`
`SYN_SET`
`SYN_UNSET`
`URG_SET`
`URG_UNSET`

Method Summary

Methods
Modifier and Type	Method and Description
`static List<TcpFlagMask>`	`encode(int flag, int mask)` Encode TCP flags and masks into human readable Strings
`static TcpFlagMask`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static TcpFlagMask[]`	`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
  - URG_SET
```
public static final TcpFlagMask URG_SET
```
  - URG_UNSET
```
public static final TcpFlagMask URG_UNSET
```
  - ACK_SET
```
public static final TcpFlagMask ACK_SET
```
  - ACK_UNSET
```
public static final TcpFlagMask ACK_UNSET
```
  - PSH_SET
```
public static final TcpFlagMask PSH_SET
```
  - PSH_UNSET
```
public static final TcpFlagMask PSH_UNSET
```
  - RST_SET
```
public static final TcpFlagMask RST_SET
```
  - RST_UNSET
```
public static final TcpFlagMask RST_UNSET
```
  - SYN_SET
```
public static final TcpFlagMask SYN_SET
```
  - SYN_UNSET
```
public static final TcpFlagMask SYN_UNSET
```
  - FIN_SET
```
public static final TcpFlagMask FIN_SET
```
  - FIN_UNSET
```
public static final TcpFlagMask FIN_UNSET
```
- Method Detail
  - values
```
public static TcpFlagMask[] 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 (TcpFlagMask c : TcpFlagMask.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TcpFlagMask valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - encode
```
public static List<TcpFlagMask> encode(int flag,
                       int mask)
```
    Encode TCP flags and masks into human readable Strings
    
    Parameters:
    flag - TCP Flag value
    mask - TCP Flag mask
    
    Returns:
    list of Enums representing TCP flag/mask per bit.

Enum TcpFlagMask

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

URG_SET

URG_UNSET

ACK_SET

ACK_UNSET

PSH_SET

PSH_UNSET

RST_SET

RST_UNSET

SYN_SET

SYN_UNSET

FIN_SET

FIN_UNSET

Method Detail

values

valueOf

encode