pt.lsts.neptus.comm.transports.udp

Class UDPTransport

java.lang.Object

pt.lsts.neptus.comm.transports.udp.UDPTransport

public class UDPTransport
extends java.lang.Object

Author:

pdias

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.LinkedHashSet<UDPMessageListener>	listeners

Constructor Summary

Constructors

Constructor and Description
UDPTransport()
UDPTransport(boolean isBroadcastEnable, int bindPort, int numberOfSenderThreads)
UDPTransport(int numberOfSenderThreads)
UDPTransport(int bindPort, int numberOfSenderThreads)
UDPTransport(java.lang.String multicastAddress, int bindPort)
UDPTransport(java.lang.String multicastAddress, int bindPort, int numberOfSenderThreads)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addListener(UDPMessageListener listener)
int	getBindPort()
int	getMaxBufferSize()
java.lang.String	getMulticastAddress()
int	getNumberOfSenderThreads()
int	getTimeoutMillis()
protected boolean	isBroadcastActive()
boolean	isBroadcastEnable()
protected boolean	isMulticastActive()
boolean	isMulticastEnable()
boolean	isOnBindError()
boolean	isRunning()
boolean	isRunningNormally()
boolean	isStopping()
static void	main(java.lang.String[] args)
void	purge() Stops accepting new messages but waits until all the buffered messages are sent to the network before stopping the sending thread(s).
boolean	removeListener(UDPMessageListener listener)
protected java.net.InetAddress	resolveAddress(java.lang.String multicastAddress)
boolean	reStart()
boolean	sendMessage(java.lang.String destination, int port, byte[] buffer) Sends a message to the network
boolean	sendMessage(java.lang.String destination, int port, byte[] buffer, DeliveryListener deliveryListener) Sends a message to the network
void	setBindPort(int bindPort)
protected void	setBroadcastActive(boolean broadcastActive)
void	setBroadcastEnable(boolean broadcastEnable)
void	setMaxBufferSize(int maxBufferSize)
protected void	setMulticastActive(boolean multicastActive)
void	setMulticastAddress(java.lang.String multicastAddress)
void	setMulticastEnable(boolean multicastEnable)
void	setNumberOfSenderThreads(int numberOfSenderThreads)
void	setTimeoutMillis(int timeoutMillis)
void	stop() Interrupts all the sending threads abruptly.

Methods inherited from class java.lang.Object

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

Field Detail

listeners

protected java.util.LinkedHashSet<UDPMessageListener> listeners

Constructor Detail

UDPTransport

public UDPTransport()

UDPTransport

public UDPTransport(int numberOfSenderThreads)

Parameters:

numberOfSenderThreads -

UDPTransport

public UDPTransport(int bindPort,
            int numberOfSenderThreads)

Parameters:

bindPort -

numberOfSenderThreads -

UDPTransport

public UDPTransport(boolean isBroadcastEnable,
            int bindPort,
            int numberOfSenderThreads)

UDPTransport

public UDPTransport(java.lang.String multicastAddress,
            int bindPort,
            int numberOfSenderThreads)

Parameters:

multicastAddress -

bindPort -

numberOfSenderThreads -

UDPTransport

public UDPTransport(java.lang.String multicastAddress,
            int bindPort)

Parameters:

multicastAddress -

bindPort -

Method Detail

isOnBindError

public boolean isOnBindError()

Returns:

the isOnBindError

getBindPort

public int getBindPort()

Returns:

setBindPort

public void setBindPort(int bindPort)

Parameters:

bindPort -

getMulticastAddress

public java.lang.String getMulticastAddress()

Returns:

the multicastAddress

setMulticastAddress

public void setMulticastAddress(java.lang.String multicastAddress)

Parameters:

multicastAddress - the multicastAddress to set

isMulticastEnable

public boolean isMulticastEnable()

Returns:

the multicastEnable

setMulticastEnable

public void setMulticastEnable(boolean multicastEnable)

Parameters:

multicastEnable - the multicastEnable to set

isMulticastActive

protected boolean isMulticastActive()

Returns:

the multicastActive

setMulticastActive

protected void setMulticastActive(boolean multicastActive)

Parameters:

multicastActive - the multicastActive to set

isBroadcastEnable

public boolean isBroadcastEnable()

Returns:

the broadcastEnable

setBroadcastEnable

public void setBroadcastEnable(boolean broadcastEnable)

Parameters:

broadcastEnable - the broadcastEnable to set

isBroadcastActive

protected boolean isBroadcastActive()

Returns:

the broadcastActive

setBroadcastActive

protected void setBroadcastActive(boolean broadcastActive)

Parameters:

broadcastActive - the broadcastActive to set

getNumberOfSenderThreads

public int getNumberOfSenderThreads()

Returns:

the numberOfSenderThreads

setNumberOfSenderThreads

public void setNumberOfSenderThreads(int numberOfSenderThreads)

Parameters:

numberOfSenderThreads - the numberOfSenderThreads to set

getTimeoutMillis

public int getTimeoutMillis()

Returns:

the timeoutMillis

setTimeoutMillis

public void setTimeoutMillis(int timeoutMillis)

Parameters:

timeoutMillis - the timeoutMillis to set

getMaxBufferSize

public int getMaxBufferSize()

Returns:

the maxBufferSize

setMaxBufferSize

public void setMaxBufferSize(int maxBufferSize)

Parameters:

maxBufferSize - the maxBufferSize to set

resolveAddress

protected java.net.InetAddress resolveAddress(java.lang.String multicastAddress)
                                       throws java.net.UnknownHostException

Parameters:

multicastAddress -

Returns:

Throws:

java.net.UnknownHostException

reStart

public boolean reStart()

Returns:

stop

public void stop()

Interrupts all the sending threads abruptly.

See Also:

#purge()}

purge

public void purge()

Stops accepting new messages but waits until all the buffered messages are sent to the network before stopping the sending thread(s).

isRunning

public boolean isRunning()

Returns:

isRunningNormally

public boolean isRunningNormally()

Returns:

isStopping

public boolean isStopping()

Returns:

addListener

public boolean addListener(UDPMessageListener listener)

Parameters:

listener -

Returns:

removeListener

public boolean removeListener(UDPMessageListener listener)

Parameters:

listener -

Returns:

sendMessage

public boolean sendMessage(java.lang.String destination,
                  int port,
                  byte[] buffer)

Sends a message to the network

Parameters:

destination - A valid hostname like "whale.fe.up.pt" or "127.0.0.1"

port - The destination's port

buffer -

Returns:

true meaning that the message was put on the send queue, and false if it was not put on the send queue.

sendMessage

public boolean sendMessage(java.lang.String destination,
                  int port,
                  byte[] buffer,
                  DeliveryListener deliveryListener)

Sends a message to the network

Parameters:

destination - A valid hostname like "whale.fe.up.pt" or "127.0.0.1"

port - The destination's port

buffer -

deliveryListener -

Returns:

true meaning that the message was put on the send queue, and false if it was not put on the send queue.

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Parameters:

args -

Throws:

java.lang.Exception