org.everrest.websockets.message

Class ChannelBroadcastMessage

java.lang.Object

org.everrest.websockets.message.Message

org.everrest.websockets.message.ChannelBroadcastMessage

public class ChannelBroadcastMessage
extends Message

This class intended for sending broadcast messages for all clients subscribed to the channel.

Author:

andrew00x

See Also:

WSConnection.subscribeToChannel(String), WSConnection.unsubscribeFromChannel(String), WSConnection.getChannels(), WSConnectionContext.sendMessage(ChannelBroadcastMessage)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChannelBroadcastMessage.Type

Constructor Summary

Constructors

Constructor and Description
ChannelBroadcastMessage()

Method Summary

Modifier and Type	Method and Description
String	getChannel() Get name of channel to send request.
ChannelBroadcastMessage.Type	getType() Get message type.
void	setChannel(String channel) Set name of channel to send request.
void	setType(ChannelBroadcastMessage.Type type) Set message type.

Methods inherited from class org.everrest.websockets.message.Message

getBody, getUuid, setBody, setUuid

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelBroadcastMessage

public ChannelBroadcastMessage()

Method Detail

getChannel

public String getChannel()

Get name of channel to send request.

Returns:

name of channel to send request.

setChannel

public void setChannel(String channel)

Set name of channel to send request.

Parameters:

channel - name of channel to send request.

getType

public ChannelBroadcastMessage.Type getType()

Get message type. All messages by default have type 'none' if different type is not set by method setType(org.everrest.websockets.message.ChannelBroadcastMessage.Type).

Returns:

message type

setType

public void setType(ChannelBroadcastMessage.Type type)

Set message type.

Parameters:

type - message type

See Also:

getType()