io.scalecube.socketio.pipeline

Class HandshakeHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.scalecube.socketio.pipeline.HandshakeHandler

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler

@ChannelHandler.Sharable
public class HandshakeHandler
extends io.netty.channel.ChannelInboundHandlerAdapter

This class implements Socket.IO handshake procedure described below:

Handshake

The client will perform an initial HTTP POST request like the following

http://example.com/socket.io/1/

The absence of the transport id and session id segments will signal the server this is a new, non-handshaken connection.

The server can respond in three different ways:

401 Unauthorized

If the server refuses to authorize the client to connect, based on the supplied information (eg: Cookie header or custom query components).

No response body is required.

503 Service Unavailable

If the server refuses the connection for any reason (eg: overload).

No response body is required.

200 OK

The handshake was successful.

The body of the response should contain the session id (sid) given to the client, followed by the heartbeat timeout, the connection closing timeout, and the list of supported transports separated by :

The absence of a heartbeat timeout ('') is interpreted as the server and client not expecting heartbeats.

For example 4d4f185e96a7b:15:10:websocket,xhr-polling

Author:

Anton Kharenko, Ronen Hamias

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
HandshakeHandler(String handshakePath, int heartbeatTimeout, int closeTimeout, String transports)

Method Summary

Modifier and Type	Method and Description
void	channelRead(io.netty.channel.ChannelHandlerContext ctx, Object msg)

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Constructor Detail

HandshakeHandler

public HandshakeHandler(String handshakePath,
                        int heartbeatTimeout,
                        int closeTimeout,
                        String transports)

Method Detail

channelRead

public void channelRead(io.netty.channel.ChannelHandlerContext ctx,
                        Object msg)
                 throws Exception

Specified by:

channelRead in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelRead in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception