org.xbib.elasticsearch.websocket.client

Interface WebSocketClient<F extends org.jboss.netty.channel.ChannelFuture,Frame extends org.jboss.netty.handler.codec.http.websocketx.WebSocketFrame>

All Known Subinterfaces:

NettyWebSocketClient

All Known Implementing Classes:

NettyWebSocketClientHandler

public interface WebSocketClient<F extends org.jboss.netty.channel.ChannelFuture,Frame extends org.jboss.netty.handler.codec.http.websocketx.WebSocketFrame>

A WebSocket client.

Method Summary

Methods

Modifier and Type	Method and Description
org.jboss.netty.channel.Channel	channel() The channel this client has opened.
F	connect() Connect to host and port.
F	disconnect() Disconnect from the server
F	send(Frame frame) Send data to server

Method Detail

channel

org.jboss.netty.channel.Channel channel()

The channel this client has opened.

Returns:

the channel

connect

F connect()

Connect to host and port.

Returns:

Connect future. Fires when connected.

disconnect

F disconnect()

Disconnect from the server

Returns:

Disconnect future. Fires when disconnected.

send

F send(Frame frame)

Send data to server

Parameters:

frame - Data for sending

Returns:

Write future. Will fire when the data is sent.