net.sf.jrtps.transport

Class PortNumberParameters

java.lang.Object

net.sf.jrtps.transport.PortNumberParameters

public class PortNumberParameters
extends Object

This class encapsulates parameters used in calculation of port numbers.

Traffic type	Port number expression
Discovery multicast	PB + DG * domainId + d0
Discovery unicast	PB + DG * domainId + d1 + PG * participantId
User traffic multicast	PB + DG * domainId + d2
User traffic unicast	PB + DG * domainId + d3 + PG * participantId

For more details, see RTPS spec, ch. 9.6.1.1 and 9.6.1.2.

Author:

mcr70

Constructor Summary

Constructors

Constructor and Description
PortNumberParameters(int pb, int dg, int pg, int d0, int d1, int d2, int d3)

Method Summary

Modifier and Type	Method and Description
int	getD0() d0 offset
int	getD1() d1 offset
int	getD2() d2 offset
int	getD3() d3 offset
int	getDiscoveryMulticastPort(int domainId)
int	getDiscoveryUnicastPort(int domainId, int participantId)
int	getDomainIdGain() Gets the DomainId Gain (DG).
int	getParticipantIdGain() Gets the ParticipantId Gain (PG).
int	getPortBase() Gets the port base number (PB)-
int	getUserdataMulticastPort(int domainId)
int	getUserdataUnicastPort(int domainId, int participantId)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PortNumberParameters

public PortNumberParameters(int pb,
                            int dg,
                            int pg,
                            int d0,
                            int d1,
                            int d2,
                            int d3)

Method Detail

getPortBase

public int getPortBase()

Gets the port base number (PB)-

Returns:

Port Base, defaults to 7400

getDomainIdGain

public int getDomainIdGain()

Gets the DomainId Gain (DG).

Returns:

DomainId Gain, defaults to 250

getParticipantIdGain

public int getParticipantIdGain()

Gets the ParticipantId Gain (PG).

Returns:

ParticipantId Gain, defaults to 2

getD0

public int getD0()

d0 offset

Returns:

d0 offset, defaults to 0

getD1

public int getD1()

d1 offset

Returns:

d1 offset, defaults to 10

getD2

public int getD2()

d2 offset

Returns:

d2 offset, defaults to 1

getD3

public int getD3()

d3 offset

Returns:

d3 offset, defaults to 11

getDiscoveryMulticastPort

public int getDiscoveryMulticastPort(int domainId)

getDiscoveryUnicastPort

public int getDiscoveryUnicastPort(int domainId,
                                   int participantId)

getUserdataMulticastPort

public int getUserdataMulticastPort(int domainId)

getUserdataUnicastPort

public int getUserdataUnicastPort(int domainId,
                                  int participantId)

toString

public String toString()

Overrides:

toString in class Object