net.sf.jrtps.transport

Class TransportProvider

java.lang.Object

net.sf.jrtps.transport.TransportProvider

Direct Known Subclasses:

MemProvider, UDPProvider

public abstract class TransportProvider
extends Object

An abstract class for creating receivers and transmitters for communication.

Author:

mcr70

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TransportProvider(Configuration config) Constructor for TransportProvider.

Method Summary

Modifier and Type	Method and Description
void	close() Closes TransportProvider.
abstract Locator	createLocator(URI uri, int domainId, int participantId, boolean isDiscovery) Create a Locator with given parameters.
protected Configuration	getConfiguration() Gets the configuration
static TransportProvider	getProviderForKind(int kind) Get a provider for given Locator kind.
static TransportProvider	getProviderForScheme(String scheme) Get a TranportProvider for given scheme.
abstract Receiver	getReceiver(Locator locator, BlockingQueue<byte[]> queue) Gets a Receiver from this TransportProvider.
abstract Transmitter	getTransmitter(Locator locator) Gets a Transmitter.
static Collection<TransportProvider>	getTransportProviders() Gets all the registered TransportProviders.
static void	registerTransportProvider(String scheme, TransportProvider provider, int... kinds) Registers a TranportProvider with given scheme and kind.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransportProvider

protected TransportProvider(Configuration config)

Constructor for TransportProvider.

Parameters:

config - Configuration

Method Detail

getConfiguration

protected Configuration getConfiguration()

Gets the configuration

Returns:

Configuration

getProviderForScheme

public static TransportProvider getProviderForScheme(String scheme)

Get a TranportProvider for given scheme. Scheme is the same, as is used by java.net.URI class. A TransportProvider need to be first registered with registerProvider.

Parameters:

scheme - scheme

Returns:

TransportProvider, or null if there was not TransportProvider registered with given scheme

See Also:

URI.getScheme()

getProviderForKind

public static TransportProvider getProviderForKind(int kind)

Get a provider for given Locator kind. Remote entities advertise Locators, that can be used to connect to them. This method is used to get a corresponding TransportProvider if one exists.

Parameters:

kind - Kind of the Locator, as in Locator.getKind()

Returns:

TransportProvider, or null if there was not TransportProvider registered with given Locator.kind

registerTransportProvider

public static void registerTransportProvider(String scheme,
                                             TransportProvider provider,
                                             int... kinds)

Registers a TranportProvider with given scheme and kind. Scheme is used by local participant to distinguish between different transports, for example UDP and HTTP. Locator kind is used to match remote participants communication capabilities with given provider, for example LOCATOR_KIND_UDPv4.

Parameters:

scheme - Scheme for the provider

provider - TranportProvider to register

kinds - Kinds of the Locators, that will be handled by the given provider

getTransportProviders

public static Collection<TransportProvider> getTransportProviders()

Gets all the registered TransportProviders.

Returns:

A Collection of TransportProviders

getReceiver

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

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.

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 abstract Transmitter getTransmitter(Locator locator)
                                    throws IOException

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

Parameters:

locator - Locator used

Returns:

Writer

Throws:

IOException - on IOException

createLocator

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

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.

Parameters:

uri - Uri

domainId - Domain ID

participantId - Participant ID

isDiscovery - true or false

Returns:

Locator

See Also:

PortNumberParameters

close

public void close()

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