IHandshaker (SNF4J 1.10.0 API)

All Known Implementing Classes:

Handshaker
```
public interface IHandshaker
```
A handshaker responsible for processing of the Web Socket handshake phase.

Author:

SNF4J.ORG

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getClosingReason()` Returns a detailed reason why the handshake phase could not finished successfully.
`IExtension`	`getExtension(String name)` Returns the negotiated extension identified by the specified name.
`String[]`	`getExtensionNames()` Returns the names of all extensions that have been negotiated
`IExtension[]`	`getExtensions()` Returns all extensions that have been negotiated
`String`	`getSubProtocol()` Return the negotiated sub-protocol.
`URI`	`getUri()` The URI identifying the Web Socket connection for both the client and server sessions.
`HandshakeFrame`	`handshake()` Initiates the handshake phase by Web Socket clients.
`HandshakeFrame`	`handshake(HandshakeFrame frame)` Processes the handshake frame received from a Web Socket client.
`boolean`	`hasExtensions()` Tells is any extension has been negotiated
`boolean`	`isClientMode()` Tells the mode (server/client) this handshaker is operating
`boolean`	`isClosing()` Tells if this handshake is closing without successfully finishing the handshake phase.
`boolean`	`isFinished()` Tells if this handshake has successfully finished the handshake phase.
`void`	`setSession(ISession session)` Sets the session object this handshaker is associated with.
`void`	`updateExtensionDecoders(ICodecPipeline pipeline)` Called to updated the pipeline decoders based on the negotiated extensions
`void`	`updateExtensionEncoders(ICodecPipeline pipeline)` Called to updated the pipeline encoders based on the negotiated extensions

- Method Detail
  - setSession
```
void setSession(ISession session)
```
    Sets the session object this handshaker is associated with.
    
    Parameters:
    
    session - the session object
  - getClosingReason
```
String getClosingReason()
```
    Returns a detailed reason why the handshake phase could not finished successfully.
    
    Returns:
    
    the detail reason
  - getExtension
```
IExtension getExtension(String name)
```
    Returns the negotiated extension identified by the specified name.
    
    Parameters:
    
    name - the name of the extension to return
    
    Returns:
    
    the extension or null if no extension with specified name has been negotiated
  - getExtensionNames
```
String[] getExtensionNames()
```
    Returns the names of all extensions that have been negotiated
    
    Returns:
    
    an array of the names
  - getExtensions
```
IExtension[] getExtensions()
```
    Returns all extensions that have been negotiated
    
    Returns:
    
    an array of the extensions
  - getSubProtocol
```
String getSubProtocol()
```
    Return the negotiated sub-protocol.
    
    Returns:
    
    the negotiated sub-protocol or null if no sub-protocol has been negotiated.
  - getUri
```
URI getUri()
```
    The URI identifying the Web Socket connection for both the client and server sessions.
    
    Returns:
    
    the URI identifying the connection
  - handshake
```
HandshakeFrame handshake()
```
    Initiates the handshake phase by Web Socket clients.
    
    Returns:
    
    the handshake frame to be send to the Web Socket server.
  - handshake
```
HandshakeFrame handshake(HandshakeFrame frame)
```
    Processes the handshake frame received from a Web Socket client.
    
    Parameters:
    
    frame - the received handshake frame
    
    Returns:
    
    the handshake frame to be send to the Web Socket client.
  - hasExtensions
```
boolean hasExtensions()
```
    Tells is any extension has been negotiated
    
    Returns:
    
    true if at least one extension has been negotiated
  - isClientMode
```
boolean isClientMode()
```
    Tells the mode (server/client) this handshaker is operating
    
    Returns:
    
    true if this handshaker is operating in the client mode
  - isClosing
```
boolean isClosing()
```
    Tells if this handshake is closing without successfully finishing the handshake phase.
    
    Returns:
    
    true if this handshaker is closing
  - isFinished
```
boolean isFinished()
```
    Tells if this handshake has successfully finished the handshake phase.
    
    Returns:
    
    true if the handshake phase has been successfully finished
  - updateExtensionDecoders
```
void updateExtensionDecoders(ICodecPipeline pipeline)
```
    Called to updated the pipeline decoders based on the negotiated extensions
    
    Parameters:
    
    pipeline - the pipeline to be updated
  - updateExtensionEncoders
```
void updateExtensionEncoders(ICodecPipeline pipeline)
```
    Called to updated the pipeline encoders based on the negotiated extensions
    
    Parameters:
    
    pipeline - the pipeline to be updated

Interface IHandshaker

Method Summary

Method Detail

setSession

getClosingReason

getExtension

getExtensionNames

getExtensions

getSubProtocol

getUri

handshake

handshake

hasExtensions

isClientMode

isClosing

isFinished

updateExtensionDecoders

updateExtensionEncoders