io.higgs.http.server

Interface MessagePusher

public interface MessagePusher

A response pusher is a generic interface used by HTTP and WebSockets to write responses back to the browser. This interface allows support for PUSH technologies and WebSockets to work seamlessly by using the same interface.

Author:

Courtney Robinson

Method Summary

Methods

Modifier and Type	Method and Description
io.netty.channel.ChannelHandlerContext	ctx()
io.netty.channel.ChannelFuture	push(Object message) Push a message up to the client.

Method Detail

push

io.netty.channel.ChannelFuture push(Object message)

Push a message up to the client. If the underlying connection is a web socket then a new websocket frame is written, if it is a persistent HTTP request the message is written as additional data to anything previously sent.

Parameters:

message - the message to push to the client

Returns:

a future which is notified when the message is successfully sent, cancelled or otherwise interrupted due to failure. This includes if the underlying connection has been closed.

ctx

io.netty.channel.ChannelHandlerContext ctx()

Returns:

The underlying context which supports this pusher