IceProcessingState

All Implemented Interfaces:

java.io.Serializable , java.lang.Comparable
```
public enum IceProcessingState

                    
```
RFC 5245 mentions that ICE processing across all media streams also has a state associated with it. This state is equal to Running while ICE processing is under way. The state is Completed when ICE processing is complete and Failed if it failed without success. For convenience reasons we are also adding two extra states. The first one is the Waiting state that reflects the state of an Agent before it starts processing. This is also an Agent's default state. The second one is the "Terminated" state. RFC 5245 says that once ICE processing has reached the Completed state for all peers for media streams using those candidates, the agent SHOULD wait an additional three seconds, and then it MAY cease responding to checks or generating triggered checks on that candidate. It MAY free the candidate at that time. which reflects the state where an Agent does not need to handle incoming checks any more and is ready for garbage collection. This is the state we refer to with "Terminated".

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description
`TERMINATED`	Once ICE processing has reached the Completed state for all peers for media streams using those candidates, the agent SHOULD wait an additional three seconds, and then it MAY cease responding to checks or generating triggered checks on that candidate. It MAY free the candidate at that time. This is also when an agent would enter the terminated state.
`FAILED`	The state is Completed when ICE processing is Failed if processing failed without success.
`COMPLETED`	The state is Completed when ICE processing is complete.
`RUNNING`	The state is equal to Running while ICE processing is under way.
`WAITING`	The state is equal to Waiting if ICE processing has not started for the corresponding Agent.

Method Summary

Modifier and Type	Method	Description
`String`	`toString()`	Returns the name of this IceProcessingState (e.g.
`boolean`	`isOver()`	Determines whether an Agent in this state has finished its ICE processing.
`boolean`	`isEstablished()`	Returns true iff the state is one in which a connection has been established, that is either COMPLETED or TERMINATED.
`static Array<IceProcessingState>`	`values()`
`static IceProcessingState`	`valueOf(String name)`

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

- Constructor Detail
- Method Detail
  - toString
```
 String toString()
```
    Returns the name of this IceProcessingState (e.g. "Running", "Completed", or "Failed").
  - isOver
```
 boolean isOver()
```
    Determines whether an Agent in this state has finished its ICE processing.
  - isEstablished
```
 boolean isEstablished()
```
    Returns true iff the state is one in which a connection has been established, that is either COMPLETED or TERMINATED.
  - values
```
 static Array<IceProcessingState> values()
```
  - valueOf
```
 static IceProcessingState valueOf(String name)
```