buzz.getcoco.media

Class Network

java.lang.Object

buzz.getcoco.media.Network

public class Network
extends java.lang.Object

The class representing a coconet. A typical use case like:

• Calling would mean: One Network per one call
• Chatting would mean: One Network per one group

The network should be Network.State.CONNECTED using connect() before sendCommand(Command, CommandStatusListener). Network.State of a network can be determined using getStatus() and can be later disconnected using disconnect().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Network.AccessType An enum indicating the accessType of the user in a given network.
static class	Network.CommandId An enum representing the possible commands that can be sent to manage a network.
static interface	Network.CommandStatusListener<T extends CommandResponse<Network.CommandId>> The listener for status updates of sent commands sendCommand(Command, CommandStatusListener).
static class	Network.CreateChannel A command for creating a channel in the network.
static class	Network.CreateChannelResponse Response for Network.CreateChannel command.
static class	Network.DeleteChannel A command for deleting a channel in the network.
static class	Network.DeleteChannelResponse A response for Network.DeleteChannel command.
static class	Network.GetAvailableChannels A command for getting all available channels in the network.
static class	Network.GetAvailableChannelsResponse A response for Network.GetAvailableChannels command.
static interface	Network.MessagingListener The listener for listening to content info and messages sent by other nodes.
static class	Network.Role An enum indicating the role of the user in a given network.
static class	Network.State Determines the connection status of the network.
static class	Network.Type Determines the type of the network.

Field Summary

Fields

Modifier and Type	Field and Description
static long	MANAGEMENT_NODE_ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Network(java.lang.String networkId)

Method Summary

Modifier and Type	Method and Description
void	connect() connect to this network.
void	disconnect() disconnect from this network.
Network.AccessType	getAccessType() Get the access type of the current user for this network.
java.lang.String	getId() Get the unique ID of this network.
java.lang.String	getMetadata()
java.lang.String	getName()
Network.State	getStatus()
Network.Type	getType()
Network.Role	getUserRole() Get the role of the current user for this network.
protected void	internalNodeConnectionStatusCallback(long nodeId, boolean isOnline)
protected void	internalOnContentInfoMessageReceived(java.lang.String message, long sourceNodeId, int contentTime)
protected void	internalOnMessageReceived(java.lang.String message, long sourceNodeId)
protected void	internalSetMetadata(java.lang.String networkMetadata)
protected void	internalSetName(java.lang.String networkName)
protected void	internalSetStatus(Network.State networkStatus)
protected void	internalSetType(Network.Type networkType)
<V extends CommandResponse<Network.CommandId>,U extends Command<Network.CommandId,V>> void	sendCommand(U command, Network.CommandStatusListener<V> listener)
void	sendContentInfoMessage(java.lang.String message, int contentTime, long... destinationNodes) Send content info message to the specified nodes.
void	sendMessage(java.lang.String message, long... destinationNodes) Send message to the specified nodes.
void	setMessagingListener(Network.MessagingListener listener) set the message listener for this network.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MANAGEMENT_NODE_ID

public static final long MANAGEMENT_NODE_ID

See Also:

Constant Field Values

Constructor Detail

Network

protected Network(java.lang.String networkId)

Method Detail

getId

public java.lang.String getId()

Get the unique ID of this network.

Returns:

ID of this network

internalOnMessageReceived

protected void internalOnMessageReceived(java.lang.String message,
                                         long sourceNodeId)

internalOnContentInfoMessageReceived

protected void internalOnContentInfoMessageReceived(java.lang.String message,
                                                    long sourceNodeId,
                                                    int contentTime)

internalNodeConnectionStatusCallback

protected void internalNodeConnectionStatusCallback(long nodeId,
                                                    boolean isOnline)

internalSetMetadata

protected void internalSetMetadata(java.lang.String networkMetadata)

internalSetName

protected void internalSetName(java.lang.String networkName)

internalSetType

protected void internalSetType(Network.Type networkType)

internalSetStatus

protected void internalSetStatus(Network.State networkStatus)

getMetadata

public java.lang.String getMetadata()

getName

public java.lang.String getName()

getType

public Network.Type getType()

getStatus

public Network.State getStatus()

getUserRole

public Network.Role getUserRole()

Get the role of the current user for this network.

Returns:

The role of the user in this network

getAccessType

public Network.AccessType getAccessType()

Get the access type of the current user for this network.

Returns:

The access type of the current user to this network

setMessagingListener

public void setMessagingListener(Network.MessagingListener listener)

set the message listener for this network.

Parameters:

listener - The interface which will be triggered on new messages. Pass null to unset previous listeners.

sendMessage

public void sendMessage(java.lang.String message,
                        long... destinationNodes)

Send message to the specified nodes.

Parameters:

message - The message which has to be transmitted

destinationNodes - The target nodes which will receive this message, pass nothing (or) null for broadcasting.

sendContentInfoMessage

public void sendContentInfoMessage(java.lang.String message,
                                   int contentTime,
                                   long... destinationNodes)

Send content info message to the specified nodes.

Parameters:

message - The message which has to be passed along with this

contentTime - The Content sync time in millis NOTE: passing other time units will cause issues

destinationNodes - The target nodes which will receive this message, pass nothing (or) null for broadcasting.

connect

public void connect()

connect to this network.

disconnect

public void disconnect()

disconnect from this network.

sendCommand

public <V extends CommandResponse<Network.CommandId>,U extends Command<Network.CommandId,V>> void sendCommand(U command,
                                                                                                              Network.CommandStatusListener<V> listener)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object