rice.p2p.splitstream
Interface SplitStream

All Superinterfaces:

Destructable

All Known Implementing Classes:

SplitStreamImpl

public interface SplitStream

extends Destructable

The interface defines the methods that a splitStream object must implement. The methods are for creating a channel and for attaching to an already existing channel

Version:

$Id: SplitStream.java 2885 2006-01-05 12:20:54Z jeffh $

Author:

Ansley Post, Alan Mislove

Method Summary

Channel	attachChannel(ChannelId id) A SplitStream application calls this method to join a channel.
Channel	createChannel(ChannelId id) A SplitStream application calls this method when it wishes to distribute content, creating a new channel object.
void	destroy() DESCRIBE THE METHOD
Channel[]	getChannels() Returns all of the channels on this local splitstream
Environment	getEnvironment() Gets the Environment attribute of the SplitStream object
int	getStripeBaseBitLength() Gets the StripeBaseBitLength attribute of the SplitStream object

Method Detail

attachChannel

public Channel attachChannel(ChannelId id)

A SplitStream application calls this method to join a channel.

Parameters:

id - The id of the channel

Returns:

A channel object used for subsequent operations on the desired content stream

createChannel

public Channel createChannel(ChannelId id)

A SplitStream application calls this method when it wishes to distribute content, creating a new channel object.

Parameters:

id - The id of the channel

Returns:

A new channel object

getChannels

public Channel[] getChannels()

Returns all of the channels on this local splitstream

Returns:

All of the channels currently being received by this splitstream

getStripeBaseBitLength

public int getStripeBaseBitLength()

Gets the StripeBaseBitLength attribute of the SplitStream object

Returns:

The StripeBaseBitLength value

getEnvironment

public Environment getEnvironment()

Gets the Environment attribute of the SplitStream object

Returns:

The Environment value

destroy

public void destroy()

DESCRIBE THE METHOD

Specified by:

destroy in interface Destructable