UdpMessageQueueService 6.0.0 API

All Implemented Interfaces:

com.google.common.util.concurrent.Service , org.somda.sdc.dpws.udp.UdpMessageReceiverCallback
```
public interface UdpMessageQueueService
 implements Service, UdpMessageReceiverCallback
                    
```
Holds two message queues to send and receive UDP messages.
The UdpMessageQueueService instance will use the UDP binding set via setUdpBinding.
- Use sendMessage to send a UDP message.
- In order to receive messages, add observers to the UdpMessageQueueService by using registerUdpMessageQueueObserver.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract void`	`setUdpBinding(UdpBindingService udpBinding)`	Injects the UDP binding service.
`abstract boolean`	`sendMessage(UdpMessage message)`	Queues an outgoing UDP message.
`abstract void`	`registerUdpMessageQueueObserver(UdpMessageQueueObserver observer)`	Registers an observer to receive incoming UDP messages.
`abstract void`	`unregisterUdpMessageQueueObserver(UdpMessageQueueObserver observer)`	Unregisters an observer to stop receiving incoming UDP messages.

Methods inherited from class com.google.common.util.concurrent.Service
addListener, awaitRunning, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync
Methods inherited from class org.somda.sdc.dpws.udp.UdpMessageReceiverCallback
receive
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - setUdpBinding
```
 abstract void setUdpBinding(UdpBindingService udpBinding)
```
    Injects the UDP binding service.
    Without a UDP binding service the message queue cannot send and receive messages. Make sure the UDP binding is injected before the service is started.
    
    Parameters:
    
    udpBinding - the UDP binding service to inject.
  - sendMessage
```
 abstract boolean sendMessage(UdpMessage message)
```
    Queues an outgoing UDP message.
    
    Parameters:
    
    message - the message to be send.
    
    Returns:
    
    true if the message could be queued, otherwise false (queue overflow).
  - registerUdpMessageQueueObserver
```
 abstract void registerUdpMessageQueueObserver(UdpMessageQueueObserver observer)
```
    Registers an observer to receive incoming UDP messages.
    
    Parameters:
    
    observer - the observer to register.
  - unregisterUdpMessageQueueObserver
```
 abstract void unregisterUdpMessageQueueObserver(UdpMessageQueueObserver observer)
```
    Unregisters an observer to stop receiving incoming UDP messages.
    
    Parameters:
    
    observer - the observer to unregister.