Package com.kristensoft.kdc

Class MulticastSocketOptions.Builder

java.lang.Object

com.kristensoft.kdc.UdpSocketOptions.Builder

com.kristensoft.kdc.MulticastSocketOptions.Builder

Enclosing class:

MulticastSocketOptions

public static class MulticastSocketOptions.Builder
extends UdpSocketOptions.Builder

Builds MulticastSocketOptions instances.

Constructor Summary

Constructors

Constructor	Description
Builder()	Creates a builder for configuring multicast socket options.

Method Summary

Modifier and Type	Method	Description
MulticastSocketOptions	build()	Builds the multicast socket options using the configured settings.
MulticastSocketOptions.Builder	withBroadcast(Boolean broadcast)	Sets whether broadcast is enabled.
MulticastSocketOptions.Builder	withLoopbackModeDisabled(Boolean disabled)	Sets whether multicast loopback mode is disabled.
MulticastSocketOptions.Builder	withNetworkInterface(NetworkInterface networkInterface)	Sets the network interface used for multicast communication.
MulticastSocketOptions.Builder	withReceiveBufferSize(Integer receiveBufferSize)	Sets the receive buffer size.
MulticastSocketOptions.Builder	withReuseAddress(Boolean reuseAddress)	Sets whether address reuse is enabled.
MulticastSocketOptions.Builder	withSendBufferSize(Integer sendBufferSize)	Sets the send buffer size.
MulticastSocketOptions.Builder	withSoTimeout(Integer soTimeout)	Sets the socket timeout.
MulticastSocketOptions.Builder	withTimeToLive(Integer timeToLive)	Sets the multicast time-to-live.
MulticastSocketOptions.Builder	withTrafficClass(Integer trafficClass)	Sets the IP traffic class.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Creates a builder for configuring multicast socket options.

Method Detail

withTimeToLive

public MulticastSocketOptions.Builder withTimeToLive(Integer timeToLive)

Sets the multicast time-to-live.

The value must be between 0 and 255, inclusive.

Parameters:

timeToLive - the multicast time-to-live

Returns:

this builder

Throws:

IllegalArgumentException - if timeToLive is null or outside the range 0 through 255

withLoopbackModeDisabled

public MulticastSocketOptions.Builder withLoopbackModeDisabled(Boolean disabled)

Sets whether multicast loopback mode is disabled.

A value of true disables loopback, while false enables it.

Parameters:

disabled - true to disable multicast loopback; false to enable it

Returns:

this builder

Throws:

IllegalArgumentException - if disabled is null

withNetworkInterface

public MulticastSocketOptions.Builder withNetworkInterface(NetworkInterface networkInterface)

Sets the network interface used for multicast communication.

This typically corresponds to the network interface associated with the configured bind address.

Parameters:

networkInterface - the network interface to use

Returns:

this builder

Throws:

IllegalArgumentException - if networkInterface is null

withReuseAddress

public MulticastSocketOptions.Builder withReuseAddress(Boolean reuseAddress)

Sets whether address reuse is enabled.

Overrides:

withReuseAddress in class UdpSocketOptions.Builder

Parameters:

reuseAddress - true to enable address reuse, false to disable it, or null to use the underlying socket default

Returns:

this builder

withReceiveBufferSize

public MulticastSocketOptions.Builder withReceiveBufferSize(Integer receiveBufferSize)

Sets the receive buffer size.

Overrides:

withReceiveBufferSize in class UdpSocketOptions.Builder

Parameters:

receiveBufferSize - the receive buffer size in bytes, or null to use the underlying socket default

Returns:

this builder

withSendBufferSize

public MulticastSocketOptions.Builder withSendBufferSize(Integer sendBufferSize)

Sets the send buffer size.

Overrides:

withSendBufferSize in class UdpSocketOptions.Builder

Parameters:

sendBufferSize - the send buffer size in bytes, or null to use the underlying socket default

Returns:

this builder

withSoTimeout

public MulticastSocketOptions.Builder withSoTimeout(Integer soTimeout)

Sets the socket timeout.

Overrides:

withSoTimeout in class UdpSocketOptions.Builder

Parameters:

soTimeout - the socket timeout in milliseconds; 0 specifies an infinite timeout, or null uses the underlying socket default

Returns:

this builder

withBroadcast

public MulticastSocketOptions.Builder withBroadcast(Boolean broadcast)

Sets whether broadcast is enabled.

Overrides:

withBroadcast in class UdpSocketOptions.Builder

Parameters:

broadcast - true to enable broadcast, false to disable it, or null to use the underlying socket default

Returns:

this builder

withTrafficClass

public MulticastSocketOptions.Builder withTrafficClass(Integer trafficClass)

Sets the IP traffic class.

Overrides:

withTrafficClass in class UdpSocketOptions.Builder

Parameters:

trafficClass - the IP traffic class from 0 through 255, or null to use the underlying socket default

Returns:

this builder

build

public MulticastSocketOptions build()

Builds the multicast socket options using the configured settings.

If reuse address has not been explicitly configured, it defaults to true.

Overrides:

build in class UdpSocketOptions.Builder

Returns:

the configured multicast socket options