buzz.getcoco.media

Class Channel

java.lang.Object

buzz.getcoco.media.Channel

public class Channel
extends java.lang.Object

The class representing a Channel in a Network. A virtual construct to add constraints on Streams. A channel can contain any number of Streams whose purpose is to send data across clients. Properties of Channels include. But not limited to:

• Once join(ChannelStatusListener) is called. It will be processed unless the Network gets to Network.State.DISCONNECTED or an equivalent state

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Channel.ChannelStatusListener The listener for updating the stream and channel join statuses.
static class	Channel.State An enum indicating the state of the channel.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Channel(java.lang.String networkId, int channelId)

Method Summary

Modifier and Type	Method and Description
int	getId()
int	getMaxStreams()
java.lang.String	getMetadata()
java.lang.String	getName()
java.lang.String	getNetworkId()
Channel.State	getState()
protected void	internalSetMaxStreams(int maxStreams)
protected void	internalSetMetadata(java.lang.String channelMetadata)
protected void	internalSetName(java.lang.String channelName)
protected void	internalSetState(Channel.State state)
void	join(Channel.ChannelStatusListener listener)
void	leave()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Channel

protected Channel(java.lang.String networkId,
                  int channelId)

Method Detail

getNetworkId

public java.lang.String getNetworkId()

getId

public int getId()

internalSetState

protected void internalSetState(Channel.State state)

internalSetName

protected void internalSetName(java.lang.String channelName)

internalSetMetadata

protected void internalSetMetadata(java.lang.String channelMetadata)

internalSetMaxStreams

protected void internalSetMaxStreams(int maxStreams)

getState

public Channel.State getState()

getName

public java.lang.String getName()

getMetadata

public java.lang.String getMetadata()

getMaxStreams

public int getMaxStreams()

join

public void join(Channel.ChannelStatusListener listener)

leave

public void leave()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object