org.softamis.net.multicast
Interface Multicaster

All Known Implementing Classes:

AbstractMulticaster, DefaultMulticaster, MultihomeMulticaster

public interface Multicaster

Interface defines generic multicaster that uses UDP multicasting to send/receive messages via network

Author:

Andrew Sazonov

Method Summary

void	addMulticastListener(MulticastListener aListener) Adds multicaster listener.
void	close() Closes multicaster.
java.net.InetAddress	getGroup() Returns IP address of UDP group used for UDP broadcasting
int	getMaxBufferSize() Returns maximal size of buffer used by multicaster
int	getPort() Returns port used by multicaster for UDP communication
int	getTimeToLive() Indicates TTL parameter for UDP packets
boolean	isActive() Indicates whether multicaster is active
void	removeMulticastListener(MulticastListener aListener) Removes given multicaster listener
void	sendData(byte[] aData) Sends data to network.
void	setActive(boolean aEnable) Makes multicaster active or inactive.
void	start() Starts multicaster.

Method Detail

setActive

void setActive(boolean aEnable)
               throws java.io.IOException

Makes multicaster active or inactive. In inactive state it does not send and receive network messages

Parameters:

aEnable - true to make multicaster active, false otherwise

Throws:

java.io.IOException

getGroup

java.net.InetAddress getGroup()

Returns IP address of UDP group used for UDP broadcasting

Returns:

group address

getPort

int getPort()

Returns port used by multicaster for UDP communication

Returns:

port number

getMaxBufferSize

int getMaxBufferSize()

Returns maximal size of buffer used by multicaster

Returns:

maximal buffer size

getTimeToLive

int getTimeToLive()

Indicates TTL parameter for UDP packets

Returns:

ttl value

isActive

boolean isActive()

Indicates whether multicaster is active

Returns:

removeMulticastListener

void removeMulticastListener(MulticastListener aListener)

Removes given multicaster listener

Parameters:

aListener - listener to remove

addMulticastListener

void addMulticastListener(MulticastListener aListener)

Adds multicaster listener. Listener is used as callback to process data obtained by multicaster

Parameters:

aListener - listener to register

start

void start()
           throws java.io.IOException

Starts multicaster. This method should be called after proper initialization and before actual sending/receiving data via multicaster

Throws:

java.io.IOException

close

void close()

Closes multicaster. After call of this method multicaster performs cleanup and stops listening for incoming data

sendData

void sendData(byte[] aData)
              throws java.io.IOException

Sends data to network.

Parameters:

aData - data should be sent

Throws:

java.io.IOException