public static final class DOFConnection.Config.BuilderUnsecureMulticast
extends java.lang.Object
DOFConnection.Type.DATAGRAM
connection configurations.
The security desire is DOF.SecurityDesire.NOT_SECURE
.
These configurations are immutable once built, and so
the builder allows them to be created (and modified) up until they are built.Constructor and Description |
---|
BuilderUnsecureMulticast(DOFAddress mcastAddress)
Construct a new builder based on a multicast address.
|
Modifier and Type | Method and Description |
---|---|
DOFConnection.Config |
build()
Return a configuration based on the current settings of the builder.
|
DOFConnection |
createConnection(DOF dof)
This is a convenience method for creating the connection with the implied
DOFConnection.Config . |
DOFConnection |
createPeerConnection(DOF dof)
This is a convenience method for creating the connection with the implied
DOFConnection.Config . |
DOFConnection |
createPeerConnection(DOF dof,
DOFAddress ucastAddress,
DOFAddress mcastAddress)
This is a convenience method for creating the connection with the implied
DOFConnection.Config . |
T |
setAddress(DOFAddress target)
Set the target address of the connection.
|
T |
setAuditorListener(DOFAuditListener auditListener)
Set this connection's audit listener.
|
T |
setBridge(DOFOperation.Bridge.Config bridge)
Set the bridge of the connection.
|
T |
setMaxReceiveSilence(int maxReceiveSilence)
Set the maximum receive silence.
|
T |
setMaxSendSilence(int maxSendSilence)
Set the maximum send silence time.
|
DOFConnection.Config.BuilderUnsecureMulticast |
setMulticastAddress(DOFAddress mcastAddress)
Set the multicastAddress to be used by
createPeerConnection(DOF) . |
T |
setName(java.lang.String name)
Set this connection's name to be used in logging.
|
DOFConnection.Config.BuilderUnsecureMulticast |
setProtocolNegotiator(DOFProtocolNegotiator negotiator)
Set the protocol negotiator to use on the connection.
|
T |
setReceiveFilter(DOFOperation.Filter receiveFilter)
Set the receive filter of the connection.
|
T |
setSendFilter(DOFOperation.Filter sendFilter)
Set the send filter of the connection.
|
T |
setStreamRequestListener(DOFConnection.StreamRequestListener listener)
Set this connection's stream-request listener.
|
T |
setTransportConfig(org.opendof.core.transport.ConnectionConfig config)
Set the transport configuration associated with the connection.
|
DOFConnection.Config.BuilderUnsecureMulticast |
setUnicastAddress(DOFAddress ucastAddress)
Set the unicastAddress to be used by
createPeerConnection(DOF) . |
public BuilderUnsecureMulticast(DOFAddress mcastAddress)
mcastAddress
- The address to connect to. Must not be null.public DOFConnection.Config.BuilderUnsecureMulticast setProtocolNegotiator(DOFProtocolNegotiator negotiator)
DOFProtocolNegotiator.createDefault()
.negotiator
- The protocol negotiator to use on the connection. null
means default.public DOFConnection.Config.BuilderUnsecureMulticast setUnicastAddress(DOFAddress ucastAddress)
createPeerConnection(DOF)
. This is a convenience so that you don't have to keep the address
around until createConnection is called. The default is null, so if this method is not called, createPeerConnection(DOF) will throw
IllegalArgumentException.
This method is only useful if you plan on calling createConnection much later and don't want to pass around the ucastAddress and mcastAddress
parameters you will need to call createConnection. If that is not your use case, then just call createPeerConnection(DOF, DOFAddress, DOFAddress)
.ucastAddress
- The unicastAddress.createConnection(DOF)
public DOFConnection.Config.BuilderUnsecureMulticast setMulticastAddress(DOFAddress mcastAddress)
createPeerConnection(DOF)
. This is a convenience so that you don't have to keep the address
around until createConnection is called. The default is null, so if this method is not called, createPeerConnection(DOF) will throw
IllegalArgumentException.
This method is only useful if you plan on calling createConnection much later and don't want to pass around the ucastAddress and mcastAddress
parameters you will need to call createConnection. If that is not your use case, then just call createPeerConnection(DOF, DOFAddress, DOFAddress)
.mcastAddress
- The multicastAddress.createConnection(DOF)
public DOFConnection createConnection(DOF dof)
DOFConnection.Config
.
This is the connection only. This connection will not detect operations sourced from other nodes.dof
- The DOF to use to create the connection.createPeerConnection(DOF, DOFAddress, DOFAddress)
,
DOFServer.Config.BuilderUnsecureMulticast.createServer(org.opendof.core.oal.DOF)
public DOFConnection createPeerConnection(DOF dof)
DOFConnection.Config
.
The connection is related to relevant servers for the purpose of a peer-to-peer network.
This type of connection can source requests and receive requests.
The unicastAddress and multicastAddress must have been set explicitly with setUnicastAddress(org.opendof.core.oal.DOFAddress)
and setMulticastAddress(org.opendof.core.oal.DOFAddress)
.
This method signature is only useful if you plan on calling it much later than the constructor and don't want to pass around the ucastAddress and mcastAddress
parameters you will need to call createPeerConnection(DOF, DOFAddress, DOFAddress)
. If that is not your use case, then just call
createPeerConnection(DOF, DOFAddress, DOFAddress) or the 2 setters.dof
- The DOF to use to create the connection.createConnection(DOF)
,
DOFServer.Config.BuilderUnsecureMulticast.createServer(org.opendof.core.oal.DOF)
,
setUnicastAddress(DOFAddress)
,
setMulticastAddress(DOFAddress)
public DOFConnection createPeerConnection(DOF dof, DOFAddress ucastAddress, DOFAddress mcastAddress)
DOFConnection.Config
.
The connection is related to relevant servers for the purpose of a peer-to-peer network.
This type of connection can source requests and receive requests.dof
- The DOF to use to create the connection.ucastAddress
- The address of the base unicast-DATAGRAM server. Usually, you will use this: InetTransport.createAddress("0.0.0.0", 0)
mcastAddress
- The address of the related multicast-DATAGRAM server. Usually, you will use this: InetTransport.createAddress(InetTransport.DEFAULT_MULTICAST_ADDRESS_IPV4, InetTransport.DEFAULT_MULTICAST_PORT);
createConnection(DOF)
,
DOFServer.Config.BuilderUnsecureMulticast.createServer(org.opendof.core.oal.DOF)
public T setAddress(DOFAddress target)
target
- The target address of the connection. Must not be null.public T setMaxSendSilence(int maxSendSilence)
DOFConnection.Config.DEFAULT_MAX_SEND_SILENCE
or
DOFConnection.Config.DEFAULT_HUB_POINT_MAX_SEND_SILENCE
, depending on the
DOFConnection.Type
.
Optimally, the max receive silence should be much greater (at least 20 seconds greater) than the max send silence on the other end of the connection.
This does not apply to connections of type DOFConnection.Type.GROUP
or DOFConnection.Type.HUB
.maxSendSilence
- The maximum send silence in milliseconds. Must be greater than 0.setMaxReceiveSilence(int)
public T setMaxReceiveSilence(int maxReceiveSilence)
DOFConnection.Config.DEFAULT_MAX_RECEIVE_SILENCE
or
DOFConnection.Config.DEFAULT_HUB_POINT_MAX_RECEIVE_SILENCE
, depending on the
DOFConnection.Type
.
Optimally, the max receive silence should be much greater (at least 20 seconds greater) than the max send silence on the other end of the connection.
This does not apply to connections of type DOFConnection.Type.GROUP
or DOFConnection.Type.POINT
.maxReceiveSilence
- The maximum receive silence in milliseconds. Must be greater than zero.setMaxSendSilence(int)
public T setBridge(DOFOperation.Bridge.Config bridge)
bridge
- The bridge for this connection. null
means none (default).public T setSendFilter(DOFOperation.Filter sendFilter)
sendFilter
- The connection's send filter. null
means none.public T setReceiveFilter(DOFOperation.Filter receiveFilter)
receiveFilter
- The connection's receive filter. null
means none.public T setTransportConfig(org.opendof.core.transport.ConnectionConfig config)
config
- The transport configuration associated with the connection. null
means none(default).public T setName(java.lang.String name)
name
- The connection's name.public T setAuditorListener(DOFAuditListener auditListener)
auditListener
- The connection's audit listener. null
means none (default).public T setStreamRequestListener(DOFConnection.StreamRequestListener listener)
listener
- The connection's stream-request listener. Pass null to clear the listener.public DOFConnection.Config build()