net.sf.jrtps.transport

Class UDPProvider

java.lang.Object

net.sf.jrtps.transport.TransportProvider

net.sf.jrtps.transport.UDPProvider

public class UDPProvider
extends TransportProvider

This Provider creates receivers and transmitters for UDP protocol. UDP is the only protocol that is required by the RTPS specification. Both unicast and multicast is supported.

Author:

mcr70

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROVIDER_SCHEME Provider scheme, that is used in configuring UDP TranportProvider URIs.

Constructor Summary

Constructors

Constructor and Description
UDPProvider(Configuration config, int participantId)

Method Summary

Modifier and Type	Method and Description
void	close() Closes TransportProvider.
Locator	createLocator(URI uri, int domainId, int participantId, boolean isDiscovery) Create a Locator with given parameters.
Receiver	getReceiver(Locator locator, BlockingQueue<byte[]> queue) Gets a Receiver from this TransportProvider.
Transmitter	getTransmitter(Locator locator) Gets a Transmitter.

Methods inherited from class net.sf.jrtps.transport.TransportProvider

getConfiguration, getProviderForKind, getProviderForScheme, getTransportProviders, registerTransportProvider

Methods inherited from class java.lang.Object

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

Field Detail

PROVIDER_SCHEME

public static final String PROVIDER_SCHEME

Provider scheme, that is used in configuring UDP TranportProvider URIs.

See Also:

Constant Field Values

Constructor Detail

UDPProvider

public UDPProvider(Configuration config,
                   int participantId)

Method Detail

getReceiver

public Receiver getReceiver(Locator locator,
                            BlockingQueue<byte[]> queue)
                     throws IOException

Description copied from class: TransportProvider

Gets a Receiver from this TransportProvider. If the URI has a port defined, it should be used. If not, domainId, participantId and discovery parameters should be used to create port number according to specification.

Specified by:

getReceiver in class TransportProvider

Parameters:

locator - Locator of the receiver to create.

queue - a BlockingQueue, that should be populated with byte[] received by the Receiver.

Returns:

Receiver, or null if Receiver could not be created

Throws:

IOException - on IOException

getTransmitter

public Transmitter getTransmitter(Locator locator)
                           throws IOException

Description copied from class: TransportProvider

Gets a Transmitter. Remote entities advertise how they can be reached by the means of Locator.

Specified by:

getTransmitter in class TransportProvider

Parameters:

locator - Locator used

Returns:

Writer

Throws:

IOException - on IOException

createLocator

public Locator createLocator(URI uri,
                             int domainId,
                             int participantId,
                             boolean isDiscovery)

Description copied from class: TransportProvider

Create a Locator with given parameters. If there is no port given in URI, domainId, participantId and isDiscovery parameters are used to construct port number. This is done using PortNumberParameters class.

Specified by:

createLocator in class TransportProvider

Parameters:

uri - Uri

domainId - Domain ID

participantId - Participant ID

isDiscovery - true or false

Returns:

Locator

See Also:

PortNumberParameters

close

public void close()

Description copied from class: TransportProvider

Closes TransportProvider. This method is called when participant is closed. TransportProvider implementation might do some cleanup of resources by overriding this method.

Overrides:

close in class TransportProvider