com.prosysopc.ua.pubsub

Class PubSubUdpUadpConnectionConf

java.lang.Object

com.prosysopc.ua.pubsub.PubSubUdpUadpConnectionConf

All Implemented Interfaces:

PubSubConf, PubSubConnectionConf<PubSubUdpUadpReaderGroupConf,PubSubUdpUadpWriterGroupConf>, PubSubNamedConf

public final class PubSubUdpUadpConnectionConf
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubSubUdpUadpConnectionConf.Builder Builder for PubSubUdpUadpConnectionConf.
static class	PubSubUdpUadpConnectionConf.Fields

Nested classes/interfaces inherited from interface com.prosysopc.ua.pubsub.PubSubConf

PubSubConf.MapKind<T>

Field Summary

Fields

Modifier and Type	Field and Description
static PubSubConfSpecification	SPECIFICATION

Method Summary

Modifier and Type	Method and Description
static PubSubUdpUadpConnectionConf.Builder	builder() Returns a new PubSubUdpUadpConnectionConf.Builder that can be used to construct instances of this class
boolean	equals(Object obj)
InetSocketAddress	getDiscoveryNetworkAddress() Will listen on this for discovery messages.
NetworkInterface	getDiscoveryNetworkInterface() Convenience method for getting StandardSocketOptions.IP_MULTICAST_IF from getDiscoverySocketOptions().
Map<SocketOption<?>,Object>	getDiscoverySocketOptions() If a separate discovery address is configured in the transport settings, allows setting options to that socket.
String	getName() Get connection name.
InetSocketAddress	getNetworkAddress() Will listen on this.
NetworkInterface	getNetworkInterface() Convenience method for getting StandardSocketOptions.IP_MULTICAST_IF from getSocketOptions().
PublisherId	getPublisherId() The PublisherId for a publisher.
Map<String,PubSubUdpUadpReaderGroupConf>	getReaderGroups()
Map<SocketOption<?>,Object>	getSocketOptions() Allows setting options that will be passed to the underlying UDP socket (or equivalent) implementation.
PubSubTransportProfile	getTransportProfile() Returns the TransportProfile (uri) of the connection.
Map<String,PubSubUdpUadpWriterGroupConf>	getWriterGroups()
int	hashCode()
Boolean	isEnabled() Returns the enabled state.
PubSubConfSpecification	specification() Returns the specification of this object.
PubSubUdpUadpConnectionConf.Builder	toBuilder() Returns a new PubSubUdpUadpConnectionConf.Builder that is initialized with the state of this object.
String	toString()
PubSubUdpUadpConnectionConf	withGroupAddedOrReplaced(PubSubUdpUadpReaderGroupConf conf) Returns an instance similar to this, but with the Group given as parameter added or replaced if any existing one had the PubSubUdpUadpReaderGroupConf.getName().
PubSubUdpUadpConnectionConf	withGroupAddedOrReplaced(PubSubUdpUadpWriterGroupConf conf) Returns an instance similar to this, but with the Group given as parameter added or replaced if any existing one had the PubSubUdpUadpWriterGroupConf.getName().
PubSubUdpUadpConnectionConf	withGroupRemoved(String name) Removes Group from the conf if there is any with the given name.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.prosysopc.ua.pubsub.PubSubConf

get, get, toMap

Field Detail

SPECIFICATION

public static final PubSubConfSpecification SPECIFICATION

Method Detail

specification

public PubSubConfSpecification specification()

Description copied from interface: PubSubConf

Returns the specification of this object. Can be used to dynamically display the fields of the PubSubConf object.

getName

public String getName()

Get connection name. Shall be unique within a PubSubConfiguration.

getPublisherId

public PublisherId getPublisherId()

The PublisherId for a publisher.

isEnabled

public Boolean isEnabled()

Returns the enabled state.

getDiscoveryNetworkAddress

public InetSocketAddress getDiscoveryNetworkAddress()

Will listen on this for discovery messages. If null, will use instead getNetworkAddress() and also getSocketOptions().

getDiscoverySocketOptions

public Map<SocketOption<?>,Object> getDiscoverySocketOptions()

If a separate discovery address is configured in the transport settings, allows setting options to that socket.

getNetworkAddress

public InetSocketAddress getNetworkAddress()

Will listen on this.

getSocketOptions

public Map<SocketOption<?>,Object> getSocketOptions()

Allows setting options that will be passed to the underlying UDP socket (or equivalent) implementation.

getReaderGroups

public Map<String,PubSubUdpUadpReaderGroupConf> getReaderGroups()

getWriterGroups

public Map<String,PubSubUdpUadpWriterGroupConf> getWriterGroups()

withGroupRemoved

public PubSubUdpUadpConnectionConf withGroupRemoved(String name)

Removes Group from the conf if there is any with the given name.

withGroupAddedOrReplaced

public PubSubUdpUadpConnectionConf withGroupAddedOrReplaced(PubSubUdpUadpReaderGroupConf conf)

Returns an instance similar to this, but with the Group given as parameter added or replaced if any existing one had the PubSubUdpUadpReaderGroupConf.getName().

withGroupAddedOrReplaced

public PubSubUdpUadpConnectionConf withGroupAddedOrReplaced(PubSubUdpUadpWriterGroupConf conf)

Returns an instance similar to this, but with the Group given as parameter added or replaced if any existing one had the PubSubUdpUadpWriterGroupConf.getName().

builder

public static PubSubUdpUadpConnectionConf.Builder builder()

Returns a new PubSubUdpUadpConnectionConf.Builder that can be used to construct instances of this class

toBuilder

public PubSubUdpUadpConnectionConf.Builder toBuilder()

Returns a new PubSubUdpUadpConnectionConf.Builder that is initialized with the state of this object.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getDiscoveryNetworkInterface

public NetworkInterface getDiscoveryNetworkInterface()

Convenience method for getting StandardSocketOptions.IP_MULTICAST_IF from getDiscoverySocketOptions().

getNetworkInterface

public NetworkInterface getNetworkInterface()

Convenience method for getting StandardSocketOptions.IP_MULTICAST_IF from getSocketOptions().

getTransportProfile

public final PubSubTransportProfile getTransportProfile()

Description copied from interface: PubSubConnectionConf

Returns the TransportProfile (uri) of the connection. This defines both the transport and encoding of the connection.

Specified by:

getTransportProfile in interface PubSubConnectionConf<PubSubUdpUadpReaderGroupConf,PubSubUdpUadpWriterGroupConf>