oracle.wsc.android.call

Class DataChannelOption

java.lang.Object

oracle.wsc.android.call.DataChannelOption

public class DataChannelOption
extends Object

Provides options for configuring the data channel.

Constructor Summary

Constructors

Constructor and Description
DataChannelOption() Default option parameter for the data channel of a call.

Method Summary

Modifier and Type	Method and Description
int	getId() Gets the ID for the channel.
int	getMaxRetransmits() Gets the maximum number of times to try and retransmit a failed message.
int	getMaxRetransmitTimeMs() Gets the maximum time to try and retransmit a failed message.
String	getProtocol() Gets the protocol to be used for the data channel.
boolean	isNegotiated() Gets the negotiated value for the data channel.
boolean	isOrdered() Returns true if the data channel can guarantee order or not.
void	setId(int id) Allows you to provide your own ID for the channel.
void	setMaxRetransmits(int maxRetransmits) Sets the maximum number of times to try and retransmit a failed message.
void	setMaxRetransmitTimeMs(int maxRetransmitTimeMs) Sets the maximum retransmit time to try and retransmit a failed message.
void	setNegotiated(boolean negotiated) Sets the negotiated value.
void	setOrdered(boolean ordered) Set to true if the data channel should guarantee order or not.
void	setProtocol(String protocol) Sets the protocol to be used for the data channel.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataChannelOption

public DataChannelOption()

Default option parameter for the data channel of a call.

Method Detail

isOrdered

public boolean isOrdered()

Returns true if the data channel can guarantee order or not.

Returns:

true if ordered.

setOrdered

public void setOrdered(boolean ordered)

Set to true if the data channel should guarantee order or not.

Parameters:

ordered - flag to guarantee order

getMaxRetransmitTimeMs

public int getMaxRetransmitTimeMs()

Gets the maximum time to try and retransmit a failed message.

Returns:

maximum retransmit time in milli-seconds.

setMaxRetransmitTimeMs

public void setMaxRetransmitTimeMs(int maxRetransmitTimeMs)

Sets the maximum retransmit time to try and retransmit a failed message. You can only specify maxRetransmits or maxRetransmitTime, not both.

Parameters:

maxRetransmitTimeMs - maximum retransmit time in milli-seconds.

getMaxRetransmits

public int getMaxRetransmits()

Gets the maximum number of times to try and retransmit a failed message.

Returns:

maximum retransmits.

setMaxRetransmits

public void setMaxRetransmits(int maxRetransmits)

Sets the maximum number of times to try and retransmit a failed message. You can only specify maxRetransmits or maxRetransmitTime, not both.

Parameters:

maxRetransmits - maximum retransmits.

getProtocol

public String getProtocol()

Gets the protocol to be used for the data channel.

Returns:

protocol

setProtocol

public void setProtocol(String protocol)

Sets the protocol to be used for the data channel. If the specified protocol is unsupported, data-channel will fail.

Parameters:

protocol - protocol value

isNegotiated

public boolean isNegotiated()

Gets the negotiated value for the data channel.

Returns:

true if negotiated.

setNegotiated

public void setNegotiated(boolean negotiated)

Sets the negotiated value. If set to true, it removes the automatic setting up of a data channel on the other peer. If unsupported, data-channel will fail.

Parameters:

negotiated - negotiated value

getId

public int getId()

Gets the ID for the channel.

Returns:

ID

setId

public void setId(int id)

Allows you to provide your own ID for the channel.

Parameters:

id - ID for data channel