Package com.thecoderscorner.menu.remote.udp

Class UdpControllerBuilder

java.lang.Object

com.thecoderscorner.menu.remote.udp.UdpControllerBuilder

public class UdpControllerBuilder
extends Object

Creates an instance of a RS232 based controller to a given port, and connects it with the selected menu. This implements the standard builder pattern, an example of use would be along the lines of: EXPERIMENTAL: DO NOT USE AT THE MOMENT

Constructor Summary

Constructors

Constructor	Description
UdpControllerBuilder()

Method Summary

Modifier and Type	Method	Description
RemoteMenuController	build()	Once the above methods have been called to fill in the blanks, then call build to get the actual instance.
UdpControllerBuilder	withBindAddress(String address)	Mandatory, the address on which this socket is to bind to receive and send datagrams.
UdpControllerBuilder	withClock(java.time.Clock clock)	Optional, defaults to system clock but can be overriden
UdpControllerBuilder	withDeviceId(short deviceId)	Mandatory, specifies the device ID to listen for.
UdpControllerBuilder	withExecutor(ScheduledExecutorService executor)	Optional, defaults to creating a suitable executor for single connectivity
UdpControllerBuilder	withHeartbeatFrequency(int frequency)	Optional, defaults to 10 seconds between heartbeats.
UdpControllerBuilder	withLocalName(String name)	Optional, Set the name of this connection, defaults to NoName
UdpControllerBuilder	withMenuTree(MenuTree tree)	Mandatory, the menuTree instance to store the menu items retrieved from the remote side.
UdpControllerBuilder	withPort(int port)	Mandatory, the port locally on which to bind for multicast packets.
UdpControllerBuilder	withProtocol(MenuCommandProtocol protocol)	Optional, defaults to the standard protocol.
UdpControllerBuilder	withSendAsDevice(boolean asDevice)	Optional, normally set to false, as usually the Java API is not providing a menu as a device.
UdpControllerBuilder	withSendFreq(long sendFreq)	Optional, specifies the amount of time to wait before publishing a packet in millis, to try and send more than one at a time.

Methods inherited from class java.lang.Object

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

Constructor Detail

UdpControllerBuilder

public UdpControllerBuilder()

Method Detail

withDeviceId

public UdpControllerBuilder withDeviceId(short deviceId)

Mandatory, specifies the device ID to listen for.

Parameters:

deviceId - the identifier of the device we are connecting to

Returns:

itself, calls can be chained.

withSendFreq

public UdpControllerBuilder withSendFreq(long sendFreq)

Optional, specifies the amount of time to wait before publishing a packet in millis, to try and send more than one at a time. ONLY CHANGE if you fully understand the parameter.

Parameters:

sendFreq - the send frequency

Returns:

itself, calls can be chained.

withClock

public UdpControllerBuilder withClock(java.time.Clock clock)

Optional, defaults to system clock but can be overriden

Parameters:

clock - the clock to use

Returns:

itself, can be chained

withExecutor

public UdpControllerBuilder withExecutor(ScheduledExecutorService executor)

Optional, defaults to creating a suitable executor for single connectivity

Parameters:

executor - the executor which must implement ScheduledExecutorService

Returns:

itself, suitable for chaining.

withHeartbeatFrequency

public UdpControllerBuilder withHeartbeatFrequency(int frequency)

Optional, defaults to 10 seconds between heartbeats. This must be the same at both sides.

Parameters:

frequency - the frequency, must align with remote device.

Returns:

itself, suitable for chaining.

withMenuTree

public UdpControllerBuilder withMenuTree(MenuTree tree)

Mandatory, the menuTree instance to store the menu items retrieved from the remote side. this menuTree must only be used with one remote.

Parameters:

tree - the menu tree to be populated (only use a menu tree with one remote)

Returns:

itself, suitable for chaining.

withProtocol

public UdpControllerBuilder withProtocol(MenuCommandProtocol protocol)

Optional, defaults to the standard protocol. Only use if changing the protocol which is not advised.

Parameters:

protocol - a protocol object.

Returns:

itself, suitable for chaining.

withSendAsDevice

public UdpControllerBuilder withSendAsDevice(boolean asDevice)

Optional, normally set to false, as usually the Java API is not providing a menu as a device.

Parameters:

asDevice - false to act as a client, true if you want to act as a device.

Returns:

itself, suitable for chaining

withLocalName

public UdpControllerBuilder withLocalName(String name)

Optional, Set the name of this connection, defaults to NoName

Parameters:

name - the name the remote will see.

Returns:

itself, suitable for chaining.

withBindAddress

public UdpControllerBuilder withBindAddress(String address)

Mandatory, the address on which this socket is to bind to receive and send datagrams.

Parameters:

address - address on which to send and receive.

Returns:

withPort

public UdpControllerBuilder withPort(int port)

Mandatory, the port locally on which to bind for multicast packets.

Parameters:

port - the bind port

Returns:

itself, suitable for chaining

build

public RemoteMenuController build()
                           throws IOException

Once the above methods have been called to fill in the blanks, then call build to get the actual instance.

Returns:

the actual instance.

Throws:

IOException