org.jwebsocket.kit

Class BroadcastOptions

java.lang.Object

org.jwebsocket.kit.BroadcastOptions

public class BroadcastOptions
extends Object

This class holds the various options to broadcast a data packet in the WebSocket network. When broadcasting the sender can decide if the packet is supposed to be sent only (one-way packet) or if the server is supposed to sent an acknowledge. The sender also can decide if the sender himself should be a broadcast target or not - which might be required for certain business logic.

Version:

$Id:$

Author:

aschulze, puran

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	RESPONSE_IGNORED
static boolean	RESPONSE_REQUESTED
static boolean	SENDER_EXCLUDED
static boolean	SENDER_INCLUDED

Constructor Summary

Constructors

Constructor and Description
BroadcastOptions(boolean aSenderIncluded, boolean aResponseRequested) Creates a new BroadcastOptions instance.
BroadcastOptions(boolean aSenderIncluded, boolean aResponseRequested, boolean aAsync) Creates a new BroadcastOptions instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isAsync()
boolean	isResponseRequested() Returns if the server is supposed to send a response for the broadcast operation.
boolean	isSenderIncluded() Returns if the sender is supposed to be included in the pending broadcast operation.
void	setAsync(boolean aAsync)
void	setResponseRequested(boolean responseRequested) Specifies if the server is supposed to send a response for the broadcast operation.
void	setSenderIncluded(boolean aSenderIncluded) Specifies if the sender is supposed to be included in the pending broadcast operation.

Methods inherited from class java.lang.Object

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

Field Detail

SENDER_INCLUDED

public static final boolean SENDER_INCLUDED

See Also:

Constant Field Values

SENDER_EXCLUDED

public static final boolean SENDER_EXCLUDED

See Also:

Constant Field Values

RESPONSE_REQUESTED

public static final boolean RESPONSE_REQUESTED

See Also:

Constant Field Values

RESPONSE_IGNORED

public static final boolean RESPONSE_IGNORED

See Also:

Constant Field Values

Constructor Detail

BroadcastOptions

public BroadcastOptions(boolean aSenderIncluded,
                boolean aResponseRequested)

Creates a new BroadcastOptions instance. The caller can decide whether or not to include the sender in the broadcast and if the sender expects a response from the server.

Parameters:

aSenderIncluded - true if to include sender, false otherwise

aResponseRequested - true if to response is requested, false otherwise

BroadcastOptions

public BroadcastOptions(boolean aSenderIncluded,
                boolean aResponseRequested,
                boolean aAsync)

Creates a new BroadcastOptions instance. The caller can decide whether or not to include the sender in the broadcast and if the sender expects a response from the server.

Parameters:

aSenderIncluded - true if to include sender, false otherwise

aResponseRequested - true if to response is requested, false otherwise

aAsync - true if to broadcast asynchronously

Method Detail

isSenderIncluded

public boolean isSenderIncluded()

Returns if the sender is supposed to be included in the pending broadcast operation.

Returns:

senderIncluded Is the sender included in the pending broadcast?

setSenderIncluded

public void setSenderIncluded(boolean aSenderIncluded)

Specifies if the sender is supposed to be included in the pending broadcast operation.

Parameters:

aSenderIncluded - Sender supposed to be included in the pending broadcast?

isResponseRequested

public boolean isResponseRequested()

Returns if the server is supposed to send a response for the broadcast operation.

Returns:

responseRequested Server supposed to send a response?

setResponseRequested

public void setResponseRequested(boolean responseRequested)

Specifies if the server is supposed to send a response for the broadcast operation.

Parameters:

responseRequested - Server supposed to send a response?

isAsync

public boolean isAsync()

Returns:

the async

setAsync

public void setAsync(boolean aAsync)

Parameters:

aAsync - the async to set